From bae9398cc148d37215ff0c6f2e2dcc347f4dc134 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Thu, 12 Feb 2015 10:56:08 +0000
Subject: [PATCH] CR-6060 OPENDJ-1785 Add "extra" doc into code for generated content
---
opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommand.java | 31 ++++++++++++++++++++++++++++++-
1 files changed, 30 insertions(+), 1 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 d27e85a..9fec2a5 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
@@ -22,7 +22,7 @@
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
- * Portions Copyright 2014-2015 ForgeRock AS
+ * Portions Copyright 2014-2015 ForgeRock AS.
*/
package com.forgerock.opendj.cli;
@@ -164,6 +164,35 @@
}
/**
+ * A supplement to the description for this subcommand
+ * intended for use in generated reference documentation.
+ */
+ 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.
+ */
+ 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.
+ */
+ public void setDocDescriptionSupplement(final LocalizableMessage docDescriptionSupplement) {
+ this.docDescriptionSupplement = docDescriptionSupplement;
+ }
+
+ /**
* Retrieves the set of arguments for this subcommand.
*
* @return The set of arguments for this subcommand.
--
Gitblit v1.10.0