Skip to content

Commit

Permalink
[#175] improved javadoc for IHelpCommandInitializable
Browse files Browse the repository at this point in the history
  • Loading branch information
remkop committed Apr 11, 2018
1 parent ce568b7 commit 5da3630
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/main/java/picocli/CommandLine.java
Original file line number Diff line number Diff line change
Expand Up @@ -5783,13 +5783,14 @@ public void init(CommandLine helpCommandLine, Help.Ansi ansi, PrintStream out, P
* before the help command's {@code run} or {@code call} method is called.</p>
* <p><b>Implementation note:</b></p><p>
* If an error occurs in the {@code run} or {@code call} method while processing the help request, it is recommended custom Help
* commands throw a {@link ParameterException} with a reference to the parent command. The {@link DefaultExceptionHandler} will print
* commands throw a {@link ParameterException ParameterException} with a reference to the parent command. The {@link DefaultExceptionHandler DefaultExceptionHandler} will print
* the error message and the usage for the parent command, and will terminate with the exit code of the exception handler if one was set.
* </p>
* @since 3.0 */
public static interface IHelpCommandInitializable {
/** Initializes this object with the information needed to implement a help command that provides usage help for other commands.
* @param helpCommandLine provides access to this command's parent and sibling commands
* @param helpCommandLine the {@code CommandLine} object associated with this help command. Implementors can use
* this to walk the command hierarchy and get access to the help command's parent and sibling commands.
* @param ansi whether to use Ansi colors or not
* @param out the stream to print the usage help message to
* @param err the error stream to print any diagnostic messages to, in addition to the output from the exception handler
Expand Down

0 comments on commit 5da3630

Please sign in to comment.