From 314e6e2709c4b0ebfe509e262ca366874f9069da Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Wed, 11 Mar 2015 11:59:20 +0000
Subject: [PATCH] CR-6316 OPENDJ-1786 Automate integration of generated content
---
opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java | 19 +++----------------
1 files changed, 3 insertions(+), 16 deletions(-)
diff --git a/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java b/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java
index 9fec2a5..42f4580 100644
--- a/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java
+++ b/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java
@@ -39,7 +39,7 @@
* This class defines a data structure for holding information about a subcommand that may be used with the subcommand
* argument parser. The subcommand has a name, a description, and a set of arguments.
*/
-public class SubCommand {
+public class SubCommand implements DocDescriptionSupplement {
/** Indicates whether this subCommand should be hidden in the usage information. */
private boolean isHidden;
@@ -169,25 +169,12 @@
*/
private LocalizableMessage docDescriptionSupplement;
- /**
- * Retrieves a supplement to the description for this subcommand
- * intended for use in generated reference documentation.
- *
- * @return The supplement to the description for this subcommand
- * for use in generated reference documentation,
- * or LocalizableMessage.EMPTY if there is no supplement.
- */
+ /** {@inheritDoc} */
public LocalizableMessage getDocDescriptionSupplement() {
return docDescriptionSupplement != null ? docDescriptionSupplement : LocalizableMessage.EMPTY;
}
- /**
- * Sets a supplement to the description for this subcommand
- * intended for use in generated reference documentation.
- *
- * @param docDescriptionSupplement The supplement to the description for this subcommand
- * for use in generated reference documentation.
- */
+ /** {@inheritDoc} */
public void setDocDescriptionSupplement(final LocalizableMessage docDescriptionSupplement) {
this.docDescriptionSupplement = docDescriptionSupplement;
}
--
Gitblit v1.10.0