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 | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/base/src/main/java/bjc/utils/cli/CommandHelp.java b/base/src/main/java/bjc/utils/cli/CommandHelp.java index 86567a0..90ee404 100644 --- a/base/src/main/java/bjc/utils/cli/CommandHelp.java +++ b/base/src/main/java/bjc/utils/cli/CommandHelp.java @@ -4,13 +4,13 @@ package bjc.utils.cli; * Interface for the help entry for a command * * @author ben - * */ public interface CommandHelp { /** * Get the description of a command. * - * @return The description of a command + * @return + * The description of a command */ String getDescription(); @@ -20,12 +20,13 @@ public interface CommandHelp { * A summary line should consist of a string of the following format * * <pre> - * "<command-name>\t<command-summary>" + * "<command-name&rt;\t<command-summary&rt;" * </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(); } |