summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java
diff options
context:
space:
mode:
authorbculkin2442 <bjculkin@mix.wvu.edu>2016-05-10 16:02:45 -0400
committerbculkin2442 <bjculkin@mix.wvu.edu>2016-05-10 16:02:45 -0400
commit61fd71f69e080790da722e0e03b71ecd7c2538a2 (patch)
treee5c1150b27b84d550f807e44ac82688216451f00 /BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java
parent87ae1dfc8d8cb7b51d7bda4750ce841bbe691cfc (diff)
General update
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.java10
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();