1 files changed, 43 insertions, 36 deletions

diff --git a/pki/base/common/src/com/netscape/certsrv/base/IExtendedPluginInfo.java b/pki/base/common/src/com/netscape/certsrv/base/IExtendedPluginInfo.java
index e0f87c4e..e8060b24 100644
--- a/pki/base/common/src/com/netscape/certsrv/base/IExtendedPluginInfo.java
+++ b/pki/base/common/src/com/netscape/certsrv/base/IExtendedPluginInfo.java
@@ -17,12 +17,14 @@
 // --- END COPYRIGHT BLOCK ---
 package com.netscape.certsrv.base;
 
+
 import java.util.Locale;
 
+
 /**
  * Plugin which can return extended information to console
  * <p>
- * 
+ *
  * @version $Revision$, $Date$
  */
 public interface IExtendedPluginInfo {
@@ -31,43 +33,48 @@ public interface IExtendedPluginInfo {
     public static final String HELP_TEXT = "HELP_TEXT";
 
     /**
-     * This method returns an array of strings. Each element of the array
-     * represents a configurable parameter, or some other meta-info (such as
-     * help-token)
-     * 
-     * there is an entry indexed on that parameter name
-     * <param-name>;<type_info>[,required];<description>;...
-     * 
-     * Where:
-     * 
-     * type_info is either 'string', 'number', 'boolean', 'password' or
-     * 'choice(ch1,ch2,ch3,...)'
-     * 
-     * If the marker 'required' is included after the type_info, the parameter
-     * will has some visually distinctive marking in the UI.
-     * 
-     * 'description' is a short sentence describing the parameter 'choice' is
-     * rendered as a drop-down list. The first parameter in the list will be
-     * activated by default 'boolean' is rendered as a checkbox. The resulting
-     * parameter will be either 'true' or 'false' 'string' allows any characters
-     * 'number' allows only numbers 'password' is rendered as a password field
-     * (the characters are replaced with *'s when being types. This parameter is
-     * not passed through to the plugin. It is instead inserted directly into
-     * the password cache keyed on the instance name. The value of the parameter
-     * 'bindPWPrompt' (see example below) is set to the key.
-     * 
-     * In addition to the configurable parameters, the following magic
-     * parameters may be defined:
-     * 
-     * HELP_TOKEN;helptoken - a pointer to the online manual section for this
-     * plugin HELP_TEXT;helptext - a general help string describing the plugin
+     *  This method returns an array of strings. Each element of the
+     *  array represents a configurable parameter, or some other
+     *  meta-info (such as help-token)
      * 
-     * For example: "username;string;The username you wish to login as"
-     * "bindPWPrompt;password;Enter password to bind as above user with"
-     * "algorithm;choice(RSA,DSA);Which algorithm do you want to use"
-     * "enable;boolean;Do you want to run this plugin"
-     * "port;number;Which port number do you want to use"
+     *  there is an entry indexed on that parameter name
+     *  <param-name>;<type_info>[,required];<description>;...
+     *  
+     *  Where:
+     *
+     *    type_info is either 'string', 'number', 'boolean', 'password' or 
+     *        'choice(ch1,ch2,ch3,...)'
+     *
+     *    If the marker 'required' is included after the type_info,
+     *    the parameter will has some visually distinctive marking in
+     *    the UI.
      * 
+     *    'description' is a short sentence describing the parameter
+     *    'choice' is rendered as a drop-down list. The first parameter in the
+     *       list will be activated by default
+     *    'boolean' is rendered as a checkbox. The resulting parameter will be
+     *       either 'true' or 'false'
+     *	  'string' allows any characters
+     *	  'number' allows only numbers
+     *    'password' is rendered as a password field (the characters are replaced
+     *       with *'s when being types. This parameter is not passed through to
+     *       the plugin. It is instead inserted directly into the password cache
+     *       keyed on the instance name. The value of the parameter
+     *       'bindPWPrompt' (see example below) is set to the key.
+     *
+     *  In addition to the configurable parameters, the following magic parameters
+     *  may be defined:
+     *  
+     *    HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin
+     *    HELP_TEXT;helptext   - a general help string describing the plugin
+     *
+     *   For example:
+     *    "username;string;The username you wish to login as"
+     *    "bindPWPrompt;password;Enter password to bind as above user with"
+     *    "algorithm;choice(RSA,DSA);Which algorithm do you want to use"
+     *    "enable;boolean;Do you want to run this plugin"
+     *    "port;number;Which port number do you want to use"
+     *
      */
     public String[] getExtendedPluginInfo(Locale locale);