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/Argument.java | 22 ++++------------------
1 files changed, 4 insertions(+), 18 deletions(-)
diff --git a/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java b/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java
index 0b11e7b..3c57458 100644
--- a/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java
+++ b/opendj-cli/src/main/java/com/forgerock/opendj/cli/Argument.java
@@ -40,7 +40,7 @@
* for an application. This is an abstract class that must be subclassed in
* order to provide specific functionality.
*/
-public abstract class Argument {
+public abstract class Argument implements DocDescriptionSupplement {
/**
* Indicates whether this argument should be hidden in the usage
* information.
@@ -239,30 +239,16 @@
}
/**
- * A supplement to the description for this argument
- * intended for use in generated reference documentation.
+ * A supplement to the description intended for use in generated reference documentation.
*/
private LocalizableMessage docDescriptionSupplement;
- /**
- * Retrieves a supplement to the description for this argument
- * intended for use in generated reference documentation.
- *
- * @return The supplement to the description for this argument
- * 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 argument
- * intended for use in generated reference documentation.
- *
- * @param docDescriptionSupplement The supplement to the description for this argument
- * for use in generated reference documentation.
- */
+ /** {@inheritDoc} */
public void setDocDescriptionSupplement(final LocalizableMessage docDescriptionSupplement) {
this.docDescriptionSupplement = docDescriptionSupplement;
}
--
Gitblit v1.10.0