diff options
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java')
| -rw-r--r-- | BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java b/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java index d475335..bd81537 100644 --- a/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java +++ b/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java @@ -8,18 +8,18 @@ package bjc.utils.cli; */ public interface ICommandHelp { /** - * Get the description of a command + * Get the description of a command. * * @return The description of a command */ public String getDescription(); /** - * Get the summary line for a command - * - * Used for 'help commands' which gives the user a brief idea what all - * the commands do + * Get the summary line for a command. * + * A summary line should consist of a string of the following format + * "<command-name>\t<command-summary>" + * where anything in angle brackets should be filled in. * @return The summary line line for a command */ public String getSummary(); |