You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by br...@apache.org on 2019/02/17 17:49:36 UTC
[commons-cli] branch master updated: Fix JavaDoc errors
This is an automated email from the ASF dual-hosted git repository.
britter pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-cli.git
The following commit(s) were added to refs/heads/master by this push:
new c5536b7 Fix JavaDoc errors
c5536b7 is described below
commit c5536b7f82862fe798ae91cd4b4a8a2df049d06a
Author: Benedikt Ritter <br...@apache.org>
AuthorDate: Sun Feb 17 18:49:33 2019 +0100
Fix JavaDoc errors
---
pom.xml | 12 ++++++++++++
.../java/org/apache/commons/cli/CommandLine.java | 20 ++++++++++----------
.../org/apache/commons/cli/CommandLineParser.java | 8 ++++----
.../java/org/apache/commons/cli/DefaultParser.java | 8 ++++----
src/main/java/org/apache/commons/cli/Parser.java | 8 ++++----
5 files changed, 34 insertions(+), 22 deletions(-)
diff --git a/pom.xml b/pom.xml
index 611f547..39c2a5b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -206,6 +206,18 @@
<tarLongFileMode>gnu</tarLongFileMode>
</configuration>
</plugin>
+ <!--
+ Fix for https://bugs.openjdk.java.net/browse/JDK-8212233
+ which is addressed in maven-javadoc-plugin:3.1.0, see https://issues.apache.org/jira/browse/MJAVADOC-562
+ -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${commons.javadoc.version}</version>
+ <configuration>
+ <source>7</source>
+ </configuration>
+ </plugin>
</plugins>
<pluginManagement>
<plugins>
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java b/src/main/java/org/apache/commons/cli/CommandLine.java
index 76837c3..8ee0717 100644
--- a/src/main/java/org/apache/commons/cli/CommandLine.java
+++ b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -332,14 +332,14 @@ public class CommandLine implements Serializable
/**
* Retrieve the map of values associated to the option. This is convenient
- * for options specifying Java properties like <tt>-Dparam1=value1
- * -Dparam2=value2</tt>. The first argument of the option is the key, and
+ * for options specifying Java properties like <code>-Dparam1=value1
+ * -Dparam2=value2</code>. The first argument of the option is the key, and
* the 2nd argument is the value. If the option has only one argument
- * (<tt>-Dfoo</tt>) it is considered as a boolean flag and the value is
- * <tt>"true"</tt>.
+ * (<code>-Dfoo</code>) it is considered as a boolean flag and the value is
+ * <code>"true"</code>.
*
* @param option name of the option.
- * @return The Properties mapped by the option, never <tt>null</tt>
+ * @return The Properties mapped by the option, never <code>null</code>
* even if the option doesn't exists.
* @since 1.5
*/
@@ -370,14 +370,14 @@ public class CommandLine implements Serializable
/**
* Retrieve the map of values associated to the option. This is convenient
- * for options specifying Java properties like <tt>-Dparam1=value1
- * -Dparam2=value2</tt>. The first argument of the option is the key, and
+ * for options specifying Java properties like <code>-Dparam1=value1
+ * -Dparam2=value2</code>. The first argument of the option is the key, and
* the 2nd argument is the value. If the option has only one argument
- * (<tt>-Dfoo</tt>) it is considered as a boolean flag and the value is
- * <tt>"true"</tt>.
+ * (<code>-Dfoo</code>) it is considered as a boolean flag and the value is
+ * <code>"true"</code>.
*
* @param opt name of the option.
- * @return The Properties mapped by the option, never <tt>null</tt>
+ * @return The Properties mapped by the option, never <code>null</code>
* even if the option doesn't exists.
* @since 1.2
*/
diff --git a/src/main/java/org/apache/commons/cli/CommandLineParser.java b/src/main/java/org/apache/commons/cli/CommandLineParser.java
index 20e308e..ffdd3b1 100644
--- a/src/main/java/org/apache/commons/cli/CommandLineParser.java
+++ b/src/main/java/org/apache/commons/cli/CommandLineParser.java
@@ -60,9 +60,9 @@ public interface CommandLineParser
*
* @param options the specified Options
* @param arguments the command line arguments
- * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+ * @param stopAtNonOption if <code>true</code> an unrecognized argument stops
* the parsing and the remaining arguments are added to the
- * {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+ * {@link CommandLine}s args list. If <code>false</code> an unrecognized
* argument triggers a ParseException.
*
* @return the list of atomic option and value tokens
@@ -78,9 +78,9 @@ public interface CommandLineParser
* @param options the specified Options
* @param arguments the command line arguments
* @param properties command line option name-value pairs
- * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+ * @param stopAtNonOption if <code>true</code> an unrecognized argument stops
* the parsing and the remaining arguments are added to the
- * {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+ * {@link CommandLine}s args list. If <code>false</code> an unrecognized
* argument triggers a ParseException.
*
* @return the list of atomic option and value tokens
diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java b/src/main/java/org/apache/commons/cli/DefaultParser.java
index cab80eb..87e7821 100644
--- a/src/main/java/org/apache/commons/cli/DefaultParser.java
+++ b/src/main/java/org/apache/commons/cli/DefaultParser.java
@@ -36,9 +36,9 @@ public class DefaultParser implements CommandLineParser
protected Options options;
/**
- * Flag indicating how unrecognized tokens are handled. <tt>true</tt> to stop
+ * Flag indicating how unrecognized tokens are handled. <code>true</code> to stop
* the parsing and add the remaining tokens to the args list.
- * <tt>false</tt> to throw an exception.
+ * <code>false</code> to throw an exception.
*/
protected boolean stopAtNonOption;
@@ -133,9 +133,9 @@ public class DefaultParser implements CommandLineParser
* @param options the specified Options
* @param arguments the command line arguments
* @param properties command line option name-value pairs
- * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+ * @param stopAtNonOption if <code>true</code> an unrecognized argument stops
* the parsing and the remaining arguments are added to the
- * {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+ * {@link CommandLine}s args list. If <code>false</code> an unrecognized
* argument triggers a ParseException.
*
* @return the list of atomic option and value tokens
diff --git a/src/main/java/org/apache/commons/cli/Parser.java b/src/main/java/org/apache/commons/cli/Parser.java
index 9fd90a9..77f8fc9 100644
--- a/src/main/java/org/apache/commons/cli/Parser.java
+++ b/src/main/java/org/apache/commons/cli/Parser.java
@@ -110,9 +110,9 @@ public abstract class Parser implements CommandLineParser
*
* @param options the <code>Options</code>
* @param arguments the <code>arguments</code>
- * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+ * @param stopAtNonOption if <code>true</code> an unrecognized argument stops
* the parsing and the remaining arguments are added to the
- * {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+ * {@link CommandLine}s args list. If <code>false</code> an unrecognized
* argument triggers a ParseException.
* @return the <code>CommandLine</code>
* @throws ParseException if an error occurs when parsing the arguments.
@@ -129,9 +129,9 @@ public abstract class Parser implements CommandLineParser
* @param options the specified Options
* @param arguments the command line arguments
* @param properties command line option name-value pairs
- * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+ * @param stopAtNonOption if <code>true</code> an unrecognized argument stops
* the parsing and the remaining arguments are added to the
- * {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+ * {@link CommandLine}s args list. If <code>false</code> an unrecognized
* argument triggers a ParseException.
*
* @return the list of atomic option and value tokens