From 27d398c0bcca6adaf643fa3f6fd02ed67ff4adf1 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 20 Feb 2015 14:18:11 +0000
Subject: [PATCH] CR-6147 OPENDJ-1785 Add "extra" doc into code for generated content
---
opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentParser.java | 27 +++++++++++++++++++++++++++
1 files changed, 27 insertions(+), 0 deletions(-)
diff --git a/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentParser.java b/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentParser.java
index 77b5003..a55aa2e 100644
--- a/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentParser.java
+++ b/opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentParser.java
@@ -613,6 +613,32 @@
}
/**
+ * A short description for this tool, suitable in a man page summary line.
+ */
+ private LocalizableMessage shortToolDescription;
+
+ /**
+ * Gets a short description for this tool, suitable in a man page summary line.
+ *
+ * @return A short description for this tool,
+ * suitable in a man page summary line,
+ * or LocalizableMessage.EMPTY if there is no short description.
+ */
+ LocalizableMessage getShortToolDescription() {
+ return shortToolDescription != null ? shortToolDescription : LocalizableMessage.EMPTY;
+ }
+
+ /**
+ * Sets a short description for this tool, suitable in a man page summary line.
+ *
+ * @param shortDescription The short description for this tool,
+ * suitable in a man page summary line.
+ */
+ public void setShortToolDescription(final LocalizableMessage shortDescription) {
+ this.shortToolDescription = shortDescription;
+ }
+
+ /**
* A supplement to the description for this tool
* intended for use in generated reference documentation.
*/
@@ -687,6 +713,7 @@
map.put("locale", Locale.getDefault().getLanguage());
map.put("year", new SimpleDateFormat("yyyy").format(new Date()));
map.put("name", scriptName);
+ map.put("shortDesc", getShortToolDescription());
map.put("descTitle", REF_TITLE_DESCRIPTION.get());
map.put("optsTitle", REF_TITLE_OPTIONS.get());
map.put("optsIntro", REF_INTRO_OPTIONS.get(scriptName));
--
Gitblit v1.10.0