Release picocli version 0.9.4

remkop · May 4, 2017 · c0eeda6 · c0eeda6
1 parent f9c23bf
commit c0eeda6
Show file tree

Hide file tree

Showing 65 changed files with 888 additions and 4,659 deletions.
diff --git a/RELEASE-NOTES.adoc b/RELEASE-NOTES.adoc
@@ -1,5 +1,13 @@
 = picocli Release Notes
 
+== 0.9.4 - Bugfix release for public review. API may change.
+
+* #114 Replace ISO-8613-3 "true colors" with more widely supported 256-color palette (enhancement)
+* #113 Fix javadoc warnings (doc enhancement)
+* #117 The build should work for anyone checking out the project (bug)
+* #112 Improve (shorten) user manual (doc enhancement)
+* #105 Automate publishing to JCentral & Maven Central
+
 == 0.9.3 - Bugfix release for public review. API may change.
 
 * #90 Automate release

diff --git a/build.gradle b/build.gradle
@@ -1,11 +1,11 @@
 group 'info.picocli'
 description 'Java command line parser and colorized usage help generator. In a single file, to be included in source form, so users can run picocli-based applications without requiring picocli as an external dependency. Generates easily customizable usage help messages with ANSI styles and colors.'
-version '0.9.4-SNAPSHOT'
+version '0.9.4'
 
 // for bumpVersion task
-def oldVersion = '0\\.9\\.3'
+def oldVersion = '0\\.9\\.4-SNAPSHOT'
 def oldRevdate = '2017\\-04\\-30'
-def revDate    = '2017-04-23'
+def revDate    = '2017-05-04'
 
 buildscript {
     repositories {

diff --git a/docs/apidocs/allclasses-frame.html b/docs/apidocs/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Apr 23 15:37:34 JST 2017 -->
-<title>All Classes (picocli 0.9.3 API)</title>
-<meta name="date" content="2017-04-23">
+<!-- Generated by javadoc (1.8.0_131) on Thu May 04 10:49:40 JST 2017 -->
+<title>All Classes (picocli 0.9.4 API)</title>
+<meta name="date" content="2017-05-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/apidocs/allclasses-noframe.html b/docs/apidocs/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Apr 23 15:37:34 JST 2017 -->
-<title>All Classes (picocli 0.9.3 API)</title>
-<meta name="date" content="2017-04-23">
+<!-- Generated by javadoc (1.8.0_131) on Thu May 04 10:49:40 JST 2017 -->
+<title>All Classes (picocli 0.9.4 API)</title>
+<meta name="date" content="2017-05-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/apidocs/constant-values.html b/docs/apidocs/constant-values.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Apr 23 15:37:34 JST 2017 -->
-<title>Constant Field Values (picocli 0.9.3 API)</title>
-<meta name="date" content="2017-04-23">
+<!-- Generated by javadoc (1.8.0_131) on Thu May 04 10:49:39 JST 2017 -->
+<title>Constant Field Values (picocli 0.9.4 API)</title>
+<meta name="date" content="2017-05-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Constant Field Values (picocli 0.9.3 API)";
+            parent.document.title="Constant Field Values (picocli 0.9.4 API)";
         }
     }
     catch(err) {
@@ -93,7 +93,7 @@ <h2 title="picocli">picocli.*</h2>
 <!--   -->
 </a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
 <td><code><a href="picocli/CommandLine.html#VERSION">VERSION</a></code></td>
-<td class="colLast"><code>"0.9.3"</code></td>
+<td class="colLast"><code>"0.9.4"</code></td>
 </tr>
 </tbody>
 </table>

diff --git a/docs/apidocs/deprecated-list.html b/docs/apidocs/deprecated-list.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Apr 23 15:37:34 JST 2017 -->
-<title>Deprecated List (picocli 0.9.3 API)</title>
-<meta name="date" content="2017-04-23">
+<!-- Generated by javadoc (1.8.0_131) on Thu May 04 10:49:40 JST 2017 -->
+<title>Deprecated List (picocli 0.9.4 API)</title>
+<meta name="date" content="2017-05-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Deprecated List (picocli 0.9.3 API)";
+            parent.document.title="Deprecated List (picocli 0.9.4 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/help-doc.html b/docs/apidocs/help-doc.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Apr 23 15:37:34 JST 2017 -->
-<title>API Help (picocli 0.9.3 API)</title>
-<meta name="date" content="2017-04-23">
+<!-- Generated by javadoc (1.8.0_131) on Thu May 04 10:49:40 JST 2017 -->
+<title>API Help (picocli 0.9.4 API)</title>
+<meta name="date" content="2017-05-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="API Help (picocli 0.9.3 API)";
+            parent.document.title="API Help (picocli 0.9.4 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Sun Apr 23 15:37:34 JST 2017 -->
-<title>Index (picocli 0.9.3 API)</title>
-<meta name="date" content="2017-04-23">
+<!-- Generated by javadoc (1.8.0_131) on Thu May 04 10:49:39 JST 2017 -->
+<title>Index (picocli 0.9.4 API)</title>
+<meta name="date" content="2017-05-04">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Index (picocli 0.9.3 API)";
+            parent.document.title="Index (picocli 0.9.4 API)";
         }
     }
     catch(err) {
@@ -100,7 +100,7 @@ <h2 class="title">A</h2>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.Layout.html#addOption-java.lang.reflect.Field-picocli.CommandLine.Help.IParamLabelRenderer-">addOption(Field, CommandLine.Help.IParamLabelRenderer)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a></dt>
 <dd>
 <div class="block">Delegates to the <a href="picocli/CommandLine.Help.Layout.html#optionRenderer"><code>option renderer</code></a> of this layout to obtain
- text values for the specified <a href="picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a>, and then calls the <code>#layout(Field, Text[][])</code>
+ text values for the specified <a href="picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a>, and then calls the <a href="picocli/CommandLine.Help.Layout.html#layout-java.lang.reflect.Field-picocli.CommandLine.Help.Ansi.Text:A:A-"><code>CommandLine.Help.Layout.layout(Field, CommandLine.Help.Ansi.Text[][])</code></a>
  method to write these text values into the correct cells in the TextTable.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.Layout.html#addOptions-java.util.List-picocli.CommandLine.Help.IParamLabelRenderer-">addOptions(List&lt;Field&gt;, CommandLine.Help.IParamLabelRenderer)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a></dt>
@@ -111,19 +111,19 @@ <h2 class="title">A</h2>
 <dd>
 <div class="block">Delegates to the <a href="picocli/CommandLine.Help.Layout.html#parameterRenderer"><code>parameter renderer</code></a> of this layout
  to obtain text values for the specified <a href="picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a>, and then calls
- <code>#layout(Field, Text[][])</code> to write these text values into the correct cells in the TextTable.</div>
+ <a href="picocli/CommandLine.Help.Layout.html#layout-java.lang.reflect.Field-picocli.CommandLine.Help.Ansi.Text:A:A-"><code>CommandLine.Help.Layout.layout(Field, CommandLine.Help.Ansi.Text[][])</code></a> to write these text values into the correct cells in the TextTable.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.Layout.html#addPositionalParameters-java.util.List-picocli.CommandLine.Help.IParamLabelRenderer-">addPositionalParameters(List&lt;Field&gt;, CommandLine.Help.IParamLabelRenderer)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a></dt>
 <dd>
 <div class="block">Calls <a href="picocli/CommandLine.Help.Layout.html#addPositionalParameter-java.lang.reflect.Field-picocli.CommandLine.Help.IParamLabelRenderer-"><code>CommandLine.Help.Layout.addPositionalParameter(Field, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Parameters in the list.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.TextTable.html#addRowValues-java.lang.String...-">addRowValues(String...)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></dt>
 <dd>
-<div class="block">Delegates to <code>#addRowValues(Text...)</code>.</div>
+<div class="block">Delegates to <a href="picocli/CommandLine.Help.TextTable.html#addRowValues-picocli.CommandLine.Help.Ansi.Text...-"><code>CommandLine.Help.TextTable.addRowValues(CommandLine.Help.Ansi.Text...)</code></a>.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.TextTable.html#addRowValues-picocli.CommandLine.Help.Ansi.Text...-">addRowValues(CommandLine.Help.Ansi.Text...)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></dt>
 <dd>
-<div class="block">Adds a new <a href="picocli/CommandLine.Help.TextTable.html#addEmptyRow--">empty row</a>, then calls <code>putValue</code> for each of the specified values, adding more empty rows
+<div class="block">Adds a new <a href="picocli/CommandLine.Help.TextTable.html#addEmptyRow--">empty row</a>, then calls <a href="picocli/CommandLine.Help.TextTable.html#putValue-int-int-picocli.CommandLine.Help.Ansi.Text-"><code>putValue</code></a> for each of the specified values, adding more empty rows
  if the return value indicates that the value spanned multiple columns or was wrapped to multiple rows.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#ansi">ansi</a></span> - Static variable in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
@@ -170,7 +170,7 @@ <h2 class="title">C</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.TextTable.html#cellAt-int-int-">cellAt(int, int)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></dt>
 <dd>
-<div class="block">Returns the <code>char[]</code> slot at the specified row and column to write a text value into.</div>
+<div class="block">Returns the <code>Text</code> slot at the specified row and column to write a text value into.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.Ansi.Text.html#clone--">clone()</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></dt>
 <dd>&nbsp;</dd>
@@ -326,7 +326,7 @@ <h2 class="title">C</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.ColorScheme.html#commands-picocli.CommandLine.Help.Ansi.IStyle...-">commands(CommandLine.Help.Ansi.IStyle...)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dt>
 <dd>
-<div class="block">Adds the specified styles to the styles for commands in this color scheme and returns this color scheme.</div>
+<div class="block">Adds the specified styles to the registered styles for commands in this color scheme and returns this color scheme.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.ColorScheme.html#commandStyles">commandStyles</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dt>
 <dd>&nbsp;</dd>
@@ -494,11 +494,11 @@ <h2 class="title">G</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#getCommands--">getCommands()</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
-<div class="block">Returns a map with the registered sub-commands.</div>
+<div class="block">Returns a map with the <a href="picocli/CommandLine.html#addCommand-java.lang.String-java.lang.Object-">registered</a> sub-commands.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#getSeparator--">getSeparator()</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
-<div class="block">Returns the String that separates option names from option values.</div>
+<div class="block">Returns the String that separates option names from option values when parsing command line options.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.Ansi.Text.html#getStyledChars-int-int-picocli.CommandLine.Help.Ansi.Text-int-">getStyledChars(int, int, CommandLine.Help.Ansi.Text, int)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></dt>
 <dd>
@@ -564,7 +564,7 @@ <h2 class="title">J</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#join-java.lang.String:A-java.lang.StringBuilder-java.lang.Object...-">join(String[], StringBuilder, Object...)</a></span> - Static method in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
 <dd>
-<div class="block">Appends each of the specified values plus the specified separator to the specified StringBuilder and returns it.</div>
+<div class="block">Formats each of the specified values and appends it to the specified StringBuilder.</div>
 </dd>
 </dl>
 <a name="I:L">
@@ -662,7 +662,7 @@ <h2 class="title">O</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.ColorScheme.html#optionParams-picocli.CommandLine.Help.Ansi.IStyle...-">optionParams(CommandLine.Help.Ansi.IStyle...)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dt>
 <dd>
-<div class="block">Adds the specified styles to the styles for option parameters in this color scheme and returns this color scheme.</div>
+<div class="block">Adds the specified styles to the registered styles for option parameters in this color scheme and returns this color scheme.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.ColorScheme.html#optionParamStyles">optionParamStyles</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dt>
 <dd>&nbsp;</dd>
@@ -674,7 +674,7 @@ <h2 class="title">O</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.ColorScheme.html#options-picocli.CommandLine.Help.Ansi.IStyle...-">options(CommandLine.Help.Ansi.IStyle...)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dt>
 <dd>
-<div class="block">Adds the specified styles to the styles for options in this color scheme and returns this color scheme.</div>
+<div class="block">Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.ColorScheme.html#optionStyles">optionStyles</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dt>
 <dd>&nbsp;</dd>
@@ -721,7 +721,7 @@ <h2 class="title">P</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.ColorScheme.html#parameters-picocli.CommandLine.Help.Ansi.IStyle...-">parameters(CommandLine.Help.Ansi.IStyle...)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dt>
 <dd>
-<div class="block">Adds the specified styles to the styles for positional parameters in this color scheme and returns this color scheme.</div>
+<div class="block">Adds the specified styles to the registered styles for positional parameters in this color scheme and returns this color scheme.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.ColorScheme.html#parameterStyles">parameterStyles</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></dt>
 <dd>&nbsp;</dd>
@@ -750,7 +750,7 @@ <h2 class="title">P</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.Ansi.Text.html#plainString--">plainString()</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a></dt>
 <dd>
-<div class="block">Returns the plain text without any formatting</div>
+<div class="block">Returns the plain text without any formatting.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#positionalParametersFields">positionalParametersFields</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
 <dd>
@@ -804,15 +804,15 @@ <h2 class="title">S</h2>
 <dl>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.IParamLabelRenderer.html#separator--">separator()</a></span> - Method in interface picocli.<a href="picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a></dt>
 <dd>
-<div class="block">Returns the separator between option name and param label</div>
+<div class="block">Returns the separator between option name and param label.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#separator">separator</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
 <dd>
 <div class="block">The String to use as the separator between options and option parameters.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#setSeparator-java.lang.String-">setSeparator(String)</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
-<div class="block">Sets the String that separates option names from option values to the specified value.</div>
+<div class="block">Sets the String the parser uses to separate option names from option values to the specified value.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.html#shortestFirst--">shortestFirst()</a></span> - Static method in class picocli.<a href="picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dt>
 <dd>
@@ -952,7 +952,7 @@ <h2 class="title">V</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#VERSION">VERSION</a></span> - Static variable in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
-<div class="block">This is picocli version "0.9.3".</div>
+<div class="block">This is picocli version "0.9.4".</div>
 </dd>
 </dl>
 <a name="I:W">