summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/cli/CommandHelp.java
diff options
context:
space:
mode:
authorBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-11 13:41:07 -0300
committerBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-11 13:41:07 -0300
commit946cab444bc301d8a7c756a1bab039558288de89 (patch)
tree419f27c39a509bcd83cae0e6630be8eb7ff95a30 /base/src/main/java/bjc/utils/cli/CommandHelp.java
parentc82e3b3b2de0633317ec8fc85925e91422820597 (diff)
Cleanup work
Diffstat (limited to 'base/src/main/java/bjc/utils/cli/CommandHelp.java')
-rw-r--r--base/src/main/java/bjc/utils/cli/CommandHelp.java9
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>
- * "&lt;command-name>\t&lt;command-summary>"
+ * "&lt;command-name&rt;\t&lt;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();
}