Type a method doc comment with @param, @return, and @throws
Type a method doc comment with @param, @return, and @throws
Answer
/** * Schedules an event after a delay. * * @param event the event to run; must not be null * @param delayMs delay in milliseconds before firing * @return the id assigned to the event * @throws IllegalArgumentException if event is null */
The first sentence is the summary. One @param per parameter in order, @return for the value (no @return on void), @throws naming the exception and the condition.