diff options
Diffstat (limited to 'base/src/main/java/bjc/utils/cli/CommandHelp.java')
| -rw-r--r-- | base/src/main/java/bjc/utils/cli/CommandHelp.java | 20 |
1 files changed, 7 insertions, 13 deletions
diff --git a/base/src/main/java/bjc/utils/cli/CommandHelp.java b/base/src/main/java/bjc/utils/cli/CommandHelp.java index d07c9d5..a13a42f 100644 --- a/base/src/main/java/bjc/utils/cli/CommandHelp.java +++ b/base/src/main/java/bjc/utils/cli/CommandHelp.java @@ -1,30 +1,24 @@ package bjc.utils.cli; -/** - * Interface for the help entry for a command +/** Interface for the help entry for a command * - * @author ben - */ + * @author ben */ public interface CommandHelp { - /** - * Get the description of a command. + /** Get the description of a command. * - * @return The description of a command - */ + * @return The description of a command */ String getDescription(); - /** - * Get the summary line for a command. + /** Get the summary line for a command. * * A summary line should consist of a string of the following format * * <pre> - * "<command-name&rt;\t<command-summary&rt;" + * "<command-name>\t<command-summary>" * </pre> * * where anything in angle brackets should be filled in. * - * @return The summary line line for a command - */ + * @return The summary line line for a command */ String getSummary(); } |