Skip to content

Commit c5536b7

Browse files
committed
Fix JavaDoc errors
1 parent 1ae5fe3 commit c5536b7

5 files changed

Lines changed: 34 additions & 22 deletions

File tree

pom.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,18 @@
206206
<tarLongFileMode>gnu</tarLongFileMode>
207207
</configuration>
208208
</plugin>
209+
<!--
210+
Fix for https://bugs.openjdk.java.net/browse/JDK-8212233
211+
which is addressed in maven-javadoc-plugin:3.1.0, see https://issues.apache.org/jira/browse/MJAVADOC-562
212+
-->
213+
<plugin>
214+
<groupId>org.apache.maven.plugins</groupId>
215+
<artifactId>maven-javadoc-plugin</artifactId>
216+
<version>${commons.javadoc.version}</version>
217+
<configuration>
218+
<source>7</source>
219+
</configuration>
220+
</plugin>
209221
</plugins>
210222
<pluginManagement>
211223
<plugins>

src/main/java/org/apache/commons/cli/CommandLine.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -332,14 +332,14 @@ public String getOptionValue(final char opt, final String defaultValue)
332332

333333
/**
334334
* Retrieve the map of values associated to the option. This is convenient
335-
* for options specifying Java properties like <tt>-Dparam1=value1
336-
* -Dparam2=value2</tt>. The first argument of the option is the key, and
335+
* for options specifying Java properties like <code>-Dparam1=value1
336+
* -Dparam2=value2</code>. The first argument of the option is the key, and
337337
* the 2nd argument is the value. If the option has only one argument
338-
* (<tt>-Dfoo</tt>) it is considered as a boolean flag and the value is
339-
* <tt>"true"</tt>.
338+
* (<code>-Dfoo</code>) it is considered as a boolean flag and the value is
339+
* <code>"true"</code>.
340340
*
341341
* @param option name of the option.
342-
* @return The Properties mapped by the option, never <tt>null</tt>
342+
* @return The Properties mapped by the option, never <code>null</code>
343343
* even if the option doesn't exists.
344344
* @since 1.5
345345
*/
@@ -370,14 +370,14 @@ else if (values.size() == 1)
370370

371371
/**
372372
* Retrieve the map of values associated to the option. This is convenient
373-
* for options specifying Java properties like <tt>-Dparam1=value1
374-
* -Dparam2=value2</tt>. The first argument of the option is the key, and
373+
* for options specifying Java properties like <code>-Dparam1=value1
374+
* -Dparam2=value2</code>. The first argument of the option is the key, and
375375
* the 2nd argument is the value. If the option has only one argument
376-
* (<tt>-Dfoo</tt>) it is considered as a boolean flag and the value is
377-
* <tt>"true"</tt>.
376+
* (<code>-Dfoo</code>) it is considered as a boolean flag and the value is
377+
* <code>"true"</code>.
378378
*
379379
* @param opt name of the option.
380-
* @return The Properties mapped by the option, never <tt>null</tt>
380+
* @return The Properties mapped by the option, never <code>null</code>
381381
* even if the option doesn't exists.
382382
* @since 1.2
383383
*/

src/main/java/org/apache/commons/cli/CommandLineParser.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ CommandLine parse(Options options, String[] arguments, Properties properties)
6060
*
6161
* @param options the specified Options
6262
* @param arguments the command line arguments
63-
* @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
63+
* @param stopAtNonOption if <code>true</code> an unrecognized argument stops
6464
* the parsing and the remaining arguments are added to the
65-
* {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
65+
* {@link CommandLine}s args list. If <code>false</code> an unrecognized
6666
* argument triggers a ParseException.
6767
*
6868
* @return the list of atomic option and value tokens
@@ -78,9 +78,9 @@ CommandLine parse(Options options, String[] arguments, Properties properties)
7878
* @param options the specified Options
7979
* @param arguments the command line arguments
8080
* @param properties command line option name-value pairs
81-
* @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
81+
* @param stopAtNonOption if <code>true</code> an unrecognized argument stops
8282
* the parsing and the remaining arguments are added to the
83-
* {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
83+
* {@link CommandLine}s args list. If <code>false</code> an unrecognized
8484
* argument triggers a ParseException.
8585
*
8686
* @return the list of atomic option and value tokens

src/main/java/org/apache/commons/cli/DefaultParser.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ public class DefaultParser implements CommandLineParser
3636
protected Options options;
3737

3838
/**
39-
* Flag indicating how unrecognized tokens are handled. <tt>true</tt> to stop
39+
* Flag indicating how unrecognized tokens are handled. <code>true</code> to stop
4040
* the parsing and add the remaining tokens to the args list.
41-
* <tt>false</tt> to throw an exception.
41+
* <code>false</code> to throw an exception.
4242
*/
4343
protected boolean stopAtNonOption;
4444

@@ -133,9 +133,9 @@ public CommandLine parse(final Options options, final String[] arguments, final
133133
* @param options the specified Options
134134
* @param arguments the command line arguments
135135
* @param properties command line option name-value pairs
136-
* @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
136+
* @param stopAtNonOption if <code>true</code> an unrecognized argument stops
137137
* the parsing and the remaining arguments are added to the
138-
* {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
138+
* {@link CommandLine}s args list. If <code>false</code> an unrecognized
139139
* argument triggers a ParseException.
140140
*
141141
* @return the list of atomic option and value tokens

src/main/java/org/apache/commons/cli/Parser.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ public CommandLine parse(final Options options, final String[] arguments, final
110110
*
111111
* @param options the <code>Options</code>
112112
* @param arguments the <code>arguments</code>
113-
* @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
113+
* @param stopAtNonOption if <code>true</code> an unrecognized argument stops
114114
* the parsing and the remaining arguments are added to the
115-
* {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
115+
* {@link CommandLine}s args list. If <code>false</code> an unrecognized
116116
* argument triggers a ParseException.
117117
* @return the <code>CommandLine</code>
118118
* @throws ParseException if an error occurs when parsing the arguments.
@@ -129,9 +129,9 @@ public CommandLine parse(final Options options, final String[] arguments, final
129129
* @param options the specified Options
130130
* @param arguments the command line arguments
131131
* @param properties command line option name-value pairs
132-
* @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
132+
* @param stopAtNonOption if <code>true</code> an unrecognized argument stops
133133
* the parsing and the remaining arguments are added to the
134-
* {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
134+
* {@link CommandLine}s args list. If <code>false</code> an unrecognized
135135
* argument triggers a ParseException.
136136
*
137137
* @return the list of atomic option and value tokens

0 commit comments

Comments
 (0)