diff --git a/src/main/java/picocli/CommandLine.java b/src/main/java/picocli/CommandLine.java index 3635c342c..fd66062fc 100644 --- a/src/main/java/picocli/CommandLine.java +++ b/src/main/java/picocli/CommandLine.java @@ -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.
*Implementation note:
* 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. *
* @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