Skip to content

Commit fec5017

Browse files
committed
Javadoc: Use semantic tag <strong> instead of style tag <b>
1 parent 5ab9462 commit fec5017

6 files changed

Lines changed: 28 additions & 28 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public class BasicParser extends Parser {
3232
* </p>
3333
*
3434
* <p>
35-
* <b>Note:</b> {@code options} and {@code stopAtNonOption} are not used in this {@code flatten} method.
35+
* <strong>Note:</strong> {@code options} and {@code stopAtNonOption} are not used in this {@code flatten} method.
3636
* </p>
3737
*
3838
* @param options The command line {@link Options}

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -336,20 +336,20 @@ private List<String> getMatchingLongOptions(final String token) {
336336
* Breaks {@code token} into its constituent parts using the following algorithm.
337337
*
338338
* <ul>
339-
* <li>ignore the first character ("<b>-</b>")</li>
339+
* <li>ignore the first character ("<strong>-</strong>")</li>
340340
* <li>for each remaining character check if an {@link Option} exists with that id.</li>
341-
* <li>if an {@link Option} does exist then add that character prepended with "<b>-</b>" to the list of processed
341+
* <li>if an {@link Option} does exist then add that character prepended with "<strong>-</strong>" to the list of processed
342342
* tokens.</li>
343343
* <li>if the {@link Option} can have an argument value and there are remaining characters in the token then add the
344344
* remaining characters as a token to the list of processed tokens.</li>
345-
* <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code stopAtNonOption} <b>IS</b> set then add the
346-
* special token "<b>--</b>" followed by the remaining characters and also the remaining tokens directly to the
345+
* <li>if an {@link Option} does <strong>NOT</strong> exist <strong>AND</strong> {@code stopAtNonOption} <strong>IS</strong> set then add the
346+
* special token "<strong>--</strong>" followed by the remaining characters and also the remaining tokens directly to the
347347
* processed tokens list.</li>
348-
* <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code stopAtNonOption} <b>IS NOT</b> set then add
349-
* that character prepended with "<b>-</b>".</li>
348+
* <li>if an {@link Option} does <strong>NOT</strong> exist <strong>AND</strong> {@code stopAtNonOption} <strong>IS NOT</strong> set then add
349+
* that character prepended with "<strong>-</strong>".</li>
350350
* </ul>
351351
*
352-
* @param token The current token to be <b>burst</b> at the first non-Option encountered.
352+
* @param token The current token to be <strong>burst</strong> at the first non-Option encountered.
353353
* @throws ParseException if there are any problems encountered while parsing the command line token.
354354
*/
355355
protected void handleConcatenatedOptions(final String token) throws ParseException {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public class GnuParser extends Parser {
3131
/**
3232
* This flatten method does so using the following rules:
3333
* <ol>
34-
* <li>If an {@link Option} exists for the first character of the {@code arguments} entry <b>AND</b> an
34+
* <li>If an {@link Option} exists for the first character of the {@code arguments} entry <strong>AND</strong> an
3535
* {@link Option} does not exist for the whole {@code argument} then add the first character as an option to the
3636
* processed tokens list e.g. "-D" and add the rest of the entry to the also.</li>
3737
* <li>Otherwise just add the token to the processed tokens list.</li>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
3131
* An Option is not created independently, but is created through an instance of {@link Options}. An Option is required to have at least a short or a long-name.
3232
* </p>
3333
* <p>
34-
* <b>Note:</b> once an {@link Option} has been added to an instance of {@link Options}, its required flag cannot be changed.
34+
* <strong>Note:</strong> once an {@link Option} has been added to an instance of {@link Options}, its required flag cannot be changed.
3535
* </p>
3636
*
3737
* @see org.apache.commons.cli.Options
@@ -317,7 +317,7 @@ public Builder valueSeparator() {
317317
/**
318318
* The Option will use {@code sep} as a means to separate argument values.
319319
* <p>
320-
* <b>Example:</b>
320+
* <strong>Example:</strong>
321321
* </p>
322322
*
323323
* <pre>
@@ -955,7 +955,7 @@ public void setType(final Class<?> type) {
955955
/**
956956
* Sets the type of this Option.
957957
* <p>
958-
* <b>Note:</b> this method is kept for binary compatibility and the input type is supposed to be a {@link Class} object.
958+
* <strong>Note:</strong> this method is kept for binary compatibility and the input type is supposed to be a {@link Class} object.
959959
* </p>
960960
*
961961
* @param type the type of this Option.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ public static OptionBuilder withType(final Class<?> newType) {
279279
/**
280280
* The next Option created will have a value that will be an instance of {@code type}.
281281
* <p>
282-
* <b>Note:</b> this method is kept for binary compatibility and the input type is supposed to be a {@link Class}
282+
* <strong>Note:</strong> this method is kept for binary compatibility and the input type is supposed to be a {@link Class}
283283
* object.
284284
*
285285
* @param newType the type of the Options argument value
@@ -294,7 +294,7 @@ public static OptionBuilder withType(final Object newType) {
294294
/**
295295
* The next Option created uses '{@code =}' as a means to separate argument values.
296296
*
297-
* <b>Example:</b>
297+
* <strong>Example:</strong>
298298
*
299299
* <pre>
300300
* Option opt = withValueSeparator().create('D');
@@ -314,7 +314,7 @@ public static OptionBuilder withValueSeparator() {
314314
/**
315315
* The next Option created uses {@code sep} as a means to separate argument values.
316316
* <p>
317-
* <b>Example:</b>
317+
* <strong>Example:</strong>
318318
*
319319
* <pre>
320320
* Option opt = OptionBuilder.withValueSeparator('=').create('D');

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,20 @@ public class PosixParser extends Parser {
4646
* Breaks {@code token} into its constituent parts using the following algorithm.
4747
*
4848
* <ul>
49-
* <li>ignore the first character ("<b>-</b>")</li>
49+
* <li>ignore the first character ("<strong>-</strong>")</li>
5050
* <li>for each remaining character check if an {@link Option} exists with that id.</li>
51-
* <li>if an {@link Option} does exist then add that character prepended with "<b>-</b>" to the list of processed
51+
* <li>if an {@link Option} does exist then add that character prepended with "<strong>-</strong>" to the list of processed
5252
* tokens.</li>
5353
* <li>if the {@link Option} can have an argument value and there are remaining characters in the token then add the
5454
* remaining characters as a token to the list of processed tokens.</li>
55-
* <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code stopAtNonOption} <b>IS</b> set then add the
56-
* special token "<b>--</b>" followed by the remaining characters and also the remaining tokens directly to the
55+
* <li>if an {@link Option} does <strong>NOT</strong> exist <strong>AND</strong> {@code stopAtNonOption} <strong>IS</strong> set then add the
56+
* special token "<strong>--</strong>" followed by the remaining characters and also the remaining tokens directly to the
5757
* processed tokens list.</li>
58-
* <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code stopAtNonOption} <b>IS NOT</b> set then add
59-
* that character prepended with "<b>-</b>".</li>
58+
* <li>if an {@link Option} does <strong>NOT</strong> exist <strong>AND</strong> {@code stopAtNonOption} <strong>IS NOT</strong> set then add
59+
* that character prepended with "<strong>-</strong>".</li>
6060
* </ul>
6161
*
62-
* @param token The current token to be <b>burst</b>
62+
* @param token The current token to be <strong>burst</strong>
6363
* @param stopAtNonOption Specifies whether to stop processing at the first non-Option encountered.
6464
*/
6565
protected void burstToken(final String token, final boolean stopAtNonOption) {
@@ -94,17 +94,17 @@ protected void burstToken(final String token, final boolean stopAtNonOption) {
9494
* The following are the rules used by this flatten method.
9595
* </p>
9696
* <ol>
97-
* <li>if {@code stopAtNonOption} is <b>true</b> then do not burst anymore of {@code arguments} entries, just
97+
* <li>if {@code stopAtNonOption} is <strong>true</strong> then do not burst anymore of {@code arguments} entries, just
9898
* add each successive entry without further processing. Otherwise, ignore {@code stopAtNonOption}.</li>
99-
* <li>if the current {@code arguments} entry is "<b>--</b>" just add the entry to the list of processed
99+
* <li>if the current {@code arguments} entry is "<strong>--</strong>" just add the entry to the list of processed
100100
* tokens</li>
101-
* <li>if the current {@code arguments} entry is "<b>-</b>" just add the entry to the list of processed tokens</li>
102-
* <li>if the current {@code arguments} entry is two characters in length and the first character is "<b>-</b>"
101+
* <li>if the current {@code arguments} entry is "<strong>-</strong>" just add the entry to the list of processed tokens</li>
102+
* <li>if the current {@code arguments} entry is two characters in length and the first character is "<strong>-</strong>"
103103
* then check if this is a valid {@link Option} id. If it is a valid id, then add the entry to the list of processed
104104
* tokens and set the current {@link Option} member. If it is not a valid id and {@code stopAtNonOption} is true,
105105
* then the remaining entries are copied to the list of processed tokens. Otherwise, the current entry is ignored.</li>
106106
* <li>if the current {@code arguments} entry is more than two characters in length and the first character is
107-
* "<b>-</b>" then we need to burst the entry to determine its constituents. For more information on the bursting
107+
* "<strong>-</strong>" then we need to burst the entry to determine its constituents. For more information on the bursting
108108
* algorithm see {@link PosixParser#burstToken(String, boolean) burstToken}.</li>
109109
* <li>if the current {@code arguments} entry is not handled by any of the previous rules, then the entry is added
110110
* to the list of processed tokens.</li>
@@ -195,7 +195,7 @@ private void init() {
195195
}
196196

197197
/**
198-
* Add the special token "<b>--</b>" and the current {@code value} to the processed tokens list. Then add all the
198+
* Add the special token "<strong>--</strong>" and the current {@code value} to the processed tokens list. Then add all the
199199
* remaining {@code argument} values to the processed tokens list.
200200
*
201201
* @param value The current token

0 commit comments

Comments
 (0)