summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/cli/GenericHelp.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/GenericHelp.java
parentc82e3b3b2de0633317ec8fc85925e91422820597 (diff)
Cleanup work
Diffstat (limited to 'base/src/main/java/bjc/utils/cli/GenericHelp.java')
-rw-r--r--base/src/main/java/bjc/utils/cli/GenericHelp.java24
1 files changed, 14 insertions, 10 deletions
diff --git a/base/src/main/java/bjc/utils/cli/GenericHelp.java b/base/src/main/java/bjc/utils/cli/GenericHelp.java
index 38adf57..92c1eef 100644
--- a/base/src/main/java/bjc/utils/cli/GenericHelp.java
+++ b/base/src/main/java/bjc/utils/cli/GenericHelp.java
@@ -1,35 +1,39 @@
package bjc.utils.cli;
/**
- * Generic implementation of a help topic
+ * Generic implementation of a help topic.
*
* @author ben
- *
*/
public class GenericHelp implements CommandHelp {
- // The strings for this help topic
+ /* The strings for this help topic. */
private final String summary;
private final String description;
/**
- * Create a new help topic
+ * Create a new help topic.
*
* @param summary
- * The summary of this help topic
+ * The summary of this help topic.
+ *
* @param description
- * The description of this help topic, or null if this
- * help topic doesn't have a more detailed description
+ * The description of this help topic, or null if this help topic
+ * doesn't have a more detailed description.
*/
public GenericHelp(final String summary, final String description) {
- if (summary == null) throw new NullPointerException("Help summary must be non-null");
+ if (summary == null) {
+ throw new NullPointerException("Help summary must be non-null");
+ }
- this.summary = summary;
+ this.summary = summary;
this.description = description;
}
@Override
public String getDescription() {
- if (description == null) return summary;
+ if (description == null) {
+ return summary;
+ }
return description;
}