From 95658c8c4042aebfcdbc256ffbe23adb2220f041 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 17 Feb 2015 09:55:19 +0000
Subject: [PATCH] OPENDJ-1242 (CR-5982) Enable dsconfig to generate doc for properties changed through subcommand options
---
opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/DSConfig.java | 24 ++++++++++++------------
1 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/DSConfig.java b/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/DSConfig.java
index f9f10c7..d07090a 100644
--- a/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/DSConfig.java
+++ b/opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/DSConfig.java
@@ -172,22 +172,22 @@
.append(" type, which depends on the ").append(nameOption).append(" option.").append(EOL);
sb.append(" </para>").append(EOL);
} else {
- listSubtypes(sb, a.getValuePlaceholder(), defn);
+ listSubtypes(sb, a, defn);
}
return;
}
- private void listSubtypes(StringBuilder sb, LocalizableMessage placeholder,
- AbstractManagedObjectDefinition<?, ?> defn) {
+ private void listSubtypes(StringBuilder sb, Argument a, AbstractManagedObjectDefinition<?, ?> defn) {
+ final LocalizableMessage placeholder = a.getValuePlaceholder();
sb.append(" <variablelist>").append(EOL);
sb.append(" <para>").append(EOL);
- final LocalizableMessage name = defn.getUserFriendlyName();
- sb.append(" ").append(name).append(" properties depend on the ").append(name)
+ final LocalizableMessage userFriendlyName = defn.getUserFriendlyName();
+ sb.append(" ").append(userFriendlyName).append(" properties depend on the ").append(userFriendlyName)
.append(" type, which depends on the ").append(placeholder).append(" you provide.").append(EOL);
sb.append(" </para>").append(EOL);
sb.append(" <para>").append(EOL);
sb.append(" By default, OpenDJ directory server supports the following ")
- .append(defn.getUserFriendlyName()).append(" types:").append(EOL);
+ .append(userFriendlyName).append(" types:").append(EOL);
sb.append(" </para>").append(EOL);
for (AbstractManagedObjectDefinition<?, ?> childDefn : getLeafChildren(defn)) {
@@ -203,8 +203,10 @@
sb.append(" Enabled by default: ").append(isEnabled).append(EOL);
sb.append(" </para>").append(EOL);
sb.append(" <para>").append(EOL);
- final String string = "dsconfig-set-log-publisher-prop-file-based-access";
- sb.append(" See <xref linkend=\"").append(string)
+ sb.append(" See <xref linkend=\"")
+ .append(getScriptName()).append("-")
+ .append(a.getLongIdentifier()).append("-")
+ .append(defn.getName()).append("-prop-").append(childDefn.getName())
.append("\" /> for the properties of this ").append(defn.getUserFriendlyName())
.append(" type.").append(EOL);
sb.append(" </para>").append(EOL);
@@ -398,10 +400,8 @@
final Collection<String> defaultValues = behavior.getDefaultValues();
if (defaultValues.size() == 0) {
b.append("<para>None</para>").append(EOL);
- return;
} else if (defaultValues.size() == 1) {
b.append("<para>").append(defaultValues.iterator().next()).append("</para>").append(EOL);
- return;
} else {
final Iterator<String> it = defaultValues.iterator();
b.append("<para>").append(it.next()).append("</para>");
@@ -410,11 +410,11 @@
b.append(EOL).append(indent).append("<para>").append(str).append("</para>");
}
b.append(EOL);
- return;
}
+ return;
} else if (defaultBehavior instanceof AliasDefaultBehaviorProvider) {
AliasDefaultBehaviorProvider<?> behavior = (AliasDefaultBehaviorProvider<?>) defaultBehavior;
- b.append("<para>").append(behavior.getSynopsis().toString()).append("</para>").append(EOL);
+ b.append("<para>").append(behavior.getSynopsis()).append("</para>").append(EOL);
return;
} else if (defaultBehavior instanceof RelativeInheritedDefaultBehaviorProvider) {
final RelativeInheritedDefaultBehaviorProvider<?> behavior =
--
Gitblit v1.10.0