From 1c8d96d71d1bae9188f2aa3d1237082afd47c649 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Fri, 06 Feb 2015 09:13:16 +0000
Subject: [PATCH] OPENDJ-1242 (CR-5982) Enable dsconfig to generate doc for properties changed through subcommand options
---
opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommandUsageHandler.java | 24 ++++++++++++++++++------
1 files changed, 18 insertions(+), 6 deletions(-)
diff --git a/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommandUsageHandler.java b/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommandUsageHandler.java
index 3d4e30f..4884b73 100644
--- a/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommandUsageHandler.java
+++ b/opendj-cli/src/main/java/com/forgerock/opendj/cli/SubCommandUsageHandler.java
@@ -32,15 +32,27 @@
public interface SubCommandUsageHandler {
/**
- * Invoked when the sub-command usage information should be printed.
+ * Appends properties information for the sub-command.
*
* @param builder
- * the string builder
- * @param sc
+ * the string builder where to append
+ * @param subCommand
* the sub command for which to print usage information
- * @param argLongID
- * the argument long identifier
*/
- void appendUsage(StringBuilder builder, SubCommand sc, String argLongID);
+ void appendProperties(StringBuilder builder, SubCommand subCommand);
+
+ /**
+ * Appends additional information for the provided sub-command argument.
+ *
+ * @param builder
+ * the string builder where to append
+ * @param subCommand
+ * the sub command for which to print usage information
+ * @param arg
+ * the argument for which to append additional information
+ * @param nameOption
+ * the string representing the name option
+ */
+ void appendArgumentAdditionalInfo(StringBuilder builder, SubCommand subCommand, Argument arg, String nameOption);
}
--
Gitblit v1.10.0