Updated index.html

cbeust · Dec 22, 2023 · c04d6a3 · c04d6a3
1 parent 98028cf
commit c04d6a3
Show file tree

Hide file tree

Showing 14 changed files with 164 additions and 64 deletions.
diff --git a/docs/apidocs/com/beust/jcommander/DynamicParameter.html b/docs/apidocs/com/beust/jcommander/DynamicParameter.html
@@ -147,52 +147,59 @@ <h3>Optional Element Summary</h3>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#category()">category</a></span></code></th>
+<td class="colLast">
+<div class="block">If specified, the category name will be used to order the description of this parameter when usage() is invoked before the number order() is used.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#description()">description</a></span></code></th>
 <td class="colLast">
 <div class="block">A description of this option.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#descriptionKey()">descriptionKey</a></span></code></th>
 <td class="colLast">
 <div class="block">The key used to find the string in the message bundle.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hidden()">hidden</a></span></code></th>
 <td class="colLast">
 <div class="block">If true, this parameter won't appear in the usage().</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.String[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#names()">names</a></span></code></th>
 <td class="colLast">
 <div class="block">An array of allowed command line parameters (e.g.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#order()">order</a></span></code></th>
 <td class="colLast">
 <div class="block">If specified, this number will be used to order the description of this parameter when usage() is invoked.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#required()">required</a></span></code></th>
 <td class="colLast">
 <div class="block">Whether this option is required.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>java.lang.Class&lt;? extends <a href="IValueValidator.html" title="interface in com.beust.jcommander">IValueValidator</a>&gt;[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateValueWith()">validateValueWith</a></span></code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.Class&lt;? extends <a href="IParameterValidator.html" title="interface in com.beust.jcommander">IParameterValidator</a>&gt;[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateWith()">validateWith</a></span></code></th>
 <td class="colLast">
@@ -370,7 +377,7 @@ <h4>validateValueWith</h4>
 <li class="blockList"><a id="order()">
 <!--   -->
 </a>
-<ul class="blockListLast">
+<ul class="blockList">
 <li class="blockList">
 <h4>order</h4>
 <pre>int&nbsp;order</pre>
@@ -387,6 +394,29 @@ <h4>order</h4>
 </li>
 </ul>
 </section>
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="category()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>category</h4>
+<pre>java.lang.String&nbsp;category</pre>
+<div class="block">If specified, the category name will be used to order the description of this parameter when usage() is invoked before the number order() is used.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>(default or specified) category name</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</section>
 </li>
 </ul>
 </div>

diff --git a/docs/apidocs/com/beust/jcommander/Parameter.html b/docs/apidocs/com/beust/jcommander/Parameter.html
@@ -169,120 +169,127 @@ <h3>Optional Element Summary</h3>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#category()">category</a></span></code></th>
+<td class="colLast">
+<div class="block">If specified, the category name will be used to order the description of this parameter when usage() is invoked before the number order() is used.</div>
+</td>
+</tr>
+<tr class="altColor">
 <td class="colFirst"><code>java.lang.Class&lt;? extends <a href="IStringConverter.html" title="interface in com.beust.jcommander">IStringConverter</a>&lt;?&gt;&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#converter()">converter</a></span></code></th>
 <td class="colLast">
 <div class="block">The string converter to use for this field.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultValueDescription()">defaultValueDescription</a></span></code></th>
 <td class="colLast">
 <div class="block">Description of default value.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#description()">description</a></span></code></th>
 <td class="colLast">
 <div class="block">A description of this option.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#descriptionKey()">descriptionKey</a></span></code></th>
 <td class="colLast">
 <div class="block">The key used to find the string in the message bundle.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#echoInput()">echoInput</a></span></code></th>
 <td class="colLast">
 <div class="block">If true, console will not echo typed input
  Used in conjunction with password = true</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forceNonOverwritable()">forceNonOverwritable</a></span></code></th>
 <td class="colLast">
 <div class="block">If true, this parameter can be overwritten through a file or another appearance of the parameter</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#help()">help</a></span></code></th>
 <td class="colLast">
 <div class="block">If true, this parameter is for help.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hidden()">hidden</a></span></code></th>
 <td class="colLast">
 <div class="block">If true, this parameter won't appear in the usage().</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>java.lang.Class&lt;? extends <a href="IStringConverter.html" title="interface in com.beust.jcommander">IStringConverter</a>&lt;?&gt;&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listConverter()">listConverter</a></span></code></th>
 <td class="colLast">
 <div class="block">The list string converter to use for this field.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.String[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#names()">names</a></span></code></th>
 <td class="colLast">
 <div class="block">An array of allowed command line parameters (e.g.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#order()">order</a></span></code></th>
 <td class="colLast">
 <div class="block">If specified, this number will be used to order the description of this parameter when usage() is invoked.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#password()">password</a></span></code></th>
 <td class="colLast">
 <div class="block">If true, this parameter is a password and it will be prompted on the console
  (if available).</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#required()">required</a></span></code></th>
 <td class="colLast">
 <div class="block">Whether this option is required.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.Class&lt;? extends <a href="converters/IParameterSplitter.html" title="interface in com.beust.jcommander.converters">IParameterSplitter</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#splitter()">splitter</a></span></code></th>
 <td class="colLast">
 <div class="block">What splitter to use (applicable only on fields of type List).</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>java.lang.Class&lt;? extends <a href="IValueValidator.html" title="interface in com.beust.jcommander">IValueValidator</a>&gt;[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateValueWith()">validateValueWith</a></span></code></th>
 <td class="colLast">
 <div class="block">Validate the value for this parameter.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.Class&lt;? extends <a href="IParameterValidator.html" title="interface in com.beust.jcommander">IParameterValidator</a>&gt;[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateWith()">validateWith</a></span></code></th>
 <td class="colLast">
 <div class="block">Validate the parameter found on the command line.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#variableArity()">variableArity</a></span></code></th>
 <td class="colLast">&nbsp;</td>
@@ -667,7 +674,7 @@ <h4>forceNonOverwritable</h4>
 <li class="blockList"><a id="order()">
 <!--   -->
 </a>
-<ul class="blockListLast">
+<ul class="blockList">
 <li class="blockList">
 <h4>order</h4>
 <pre>int&nbsp;order</pre>
@@ -684,6 +691,29 @@ <h4>order</h4>
 </li>
 </ul>
 </section>
+<section>
+<ul class="blockList">
+<li class="blockList"><a id="category()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>category</h4>
+<pre>java.lang.String&nbsp;category</pre>
+<div class="block">If specified, the category name will be used to order the description of this parameter when usage() is invoked before the number order() is used.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>(default or specified) category name</dd>
+</dl>
+<dl>
+<dt>Default:</dt>
+<dd>""</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</section>
 </li>
 </ul>
 </div>