summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/cli/CommandHelp.java
diff options
context:
space:
mode:
authorBenjamin J. Culkin <bjculkin@mix.wvu.edu>2021-07-12 15:53:22 -0300
committerBenjamin J. Culkin <bjculkin@mix.wvu.edu>2021-07-12 15:53:22 -0300
commita24c1042499f76ff2d442ae133ef165011a7af4c (patch)
tree1a0bdff895b7dc2bd9e8006fe3b83805c7e56f4f /base/src/main/java/bjc/utils/cli/CommandHelp.java
parente55cb9852a106cff26517d7d1e85bc4b149884f3 (diff)
Formatting tweaks
Diffstat (limited to 'base/src/main/java/bjc/utils/cli/CommandHelp.java')
-rw-r--r--base/src/main/java/bjc/utils/cli/CommandHelp.java20
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>
- * "&lt;command-name&rt;\t&lt;command-summary&rt;"
+ * "&lt;command-name&gt;\t&lt;command-summary&gt;"
* </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();
}