(commons-cli) branch master updated: Javadoc: Use semantic tag instead of style tag

ggregory Fri, 15 Nov 2024 07:11:29 -0800

This is an automated email from the ASF dual-hosted git repository. ggregory 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 fec50177 Javadoc: Use semantic tag instead of style tag fec50177 is described below commit fec5017758da72cf4b0525cce0f03dec75089c19 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Fri Nov 15 10:10:41 2024 -0500 Javadoc: Use semantic tag instead of style tag --- .../java/org/apache/commons/cli/BasicParser.java | 2 +- .../java/org/apache/commons/cli/DefaultParser.java | 14 ++++++------ .../java/org/apache/commons/cli/GnuParser.java | 2 +- src/main/java/org/apache/commons/cli/Option.java | 6 ++--- .../java/org/apache/commons/cli/OptionBuilder.java | 6 ++--- .../java/org/apache/commons/cli/PosixParser.java | 26 +++++++++++----------- 6 files changed, 28 insertions(+), 28 deletions(-) diff --git a/src/main/java/org/apache/commons/cli/BasicParser.java b/src/main/java/org/apache/commons/cli/BasicParser.java index 212e2f64..63aaba79 100644 --- a/src/main/java/org/apache/commons/cli/BasicParser.java +++ b/src/main/java/org/apache/commons/cli/BasicParser.java @@ -32,7 +32,7 @@ public class BasicParser extends Parser { * * * - * Note: {@code options} and {@code stopAtNonOption} are not used in this {@code flatten} method. + * Note: {@code options} and {@code stopAtNonOption} are not used in this {@code flatten} method. * * * @param options The command line {@link Options} diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java b/src/main/java/org/apache/commons/cli/DefaultParser.java index 52090384..8e71c31d 100644 --- a/src/main/java/org/apache/commons/cli/DefaultParser.java +++ b/src/main/java/org/apache/commons/cli/DefaultParser.java @@ -336,20 +336,20 @@ public class DefaultParser implements CommandLineParser { * Breaks {@code token} into its constituent parts using the following algorithm. * * <ul> - * <li>ignore the first character ("-")</li> + * <li>ignore the first character ("-")</li> * <li>for each remaining character check if an {@link Option} exists with that id.</li> - * <li>if an {@link Option} does exist then add that character prepended with "-" to the list of processed + * <li>if an {@link Option} does exist then add that character prepended with "-" to the list of processed * tokens.</li> * <li>if the {@link Option} can have an argument value and there are remaining characters in the token then add the * remaining characters as a token to the list of processed tokens.</li> - * <li>if an {@link Option} does NOT exist AND {@code stopAtNonOption} IS set then add the - * special token "--" followed by the remaining characters and also the remaining tokens directly to the + * <li>if an {@link Option} does NOT exist AND {@code stopAtNonOption} IS set then add the + * special token "--" followed by the remaining characters and also the remaining tokens directly to the * processed tokens list.</li> - * <li>if an {@link Option} does NOT exist AND {@code stopAtNonOption} IS NOT set then add - * that character prepended with "-".</li> + * <li>if an {@link Option} does NOT exist AND {@code stopAtNonOption} IS NOT set then add + * that character prepended with "-".</li> * </ul> * - * @param token The current token to be burst at the first non-Option encountered. + * @param token The current token to be burst at the first non-Option encountered. * @throws ParseException if there are any problems encountered while parsing the command line token. */ protected void handleConcatenatedOptions(final String token) throws ParseException { diff --git a/src/main/java/org/apache/commons/cli/GnuParser.java b/src/main/java/org/apache/commons/cli/GnuParser.java index a5f6c51c..1c2f0e3e 100644 --- a/src/main/java/org/apache/commons/cli/GnuParser.java +++ b/src/main/java/org/apache/commons/cli/GnuParser.java @@ -31,7 +31,7 @@ public class GnuParser extends Parser { /** * This flatten method does so using the following rules: * <ol> - * <li>If an {@link Option} exists for the first character of the {@code arguments} entry AND an + * <li>If an {@link Option} exists for the first character of the {@code arguments} entry AND an * {@link Option} does not exist for the whole {@code argument} then add the first character as an option to the * processed tokens list e.g. "-D" and add the rest of the entry to the also.</li> * <li>Otherwise just add the token to the processed tokens list.</li> diff --git a/src/main/java/org/apache/commons/cli/Option.java b/src/main/java/org/apache/commons/cli/Option.java index d2c6f5c7..74a2fccb 100644 --- a/src/main/java/org/apache/commons/cli/Option.java +++ b/src/main/java/org/apache/commons/cli/Option.java @@ -31,7 +31,7 @@ import java.util.Objects; * 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. * * - * Note: once an {@link Option} has been added to an instance of {@link Options}, its required flag cannot be changed. + * Note: once an {@link Option} has been added to an instance of {@link Options}, its required flag cannot be changed. * * * @see org.apache.commons.cli.Options @@ -317,7 +317,7 @@ public class Option implements Cloneable, Serializable { /** * The Option will use {@code sep} as a means to separate argument values. * - * Example: + * Example: * * * <pre> @@ -955,7 +955,7 @@ public class Option implements Cloneable, Serializable { /** * Sets the type of this Option. * - * Note: this method is kept for binary compatibility and the input type is supposed to be a {@link Class} object. + * Note: this method is kept for binary compatibility and the input type is supposed to be a {@link Class} object. * * * @param type the type of this Option. diff --git a/src/main/java/org/apache/commons/cli/OptionBuilder.java b/src/main/java/org/apache/commons/cli/OptionBuilder.java index 5b180e35..496edf40 100644 --- a/src/main/java/org/apache/commons/cli/OptionBuilder.java +++ b/src/main/java/org/apache/commons/cli/OptionBuilder.java @@ -279,7 +279,7 @@ public final class OptionBuilder { /** * The next Option created will have a value that will be an instance of {@code type}. * - * Note: this method is kept for binary compatibility and the input type is supposed to be a {@link Class} + * Note: this method is kept for binary compatibility and the input type is supposed to be a {@link Class} * object. * * @param newType the type of the Options argument value @@ -294,7 +294,7 @@ public final class OptionBuilder { /** * The next Option created uses '{@code =}' as a means to separate argument values. * - * Example: + * Example: * * <pre> * Option opt = withValueSeparator().create('D'); @@ -314,7 +314,7 @@ public final class OptionBuilder { /** * The next Option created uses {@code sep} as a means to separate argument values. * - * Example: + * Example: * * <pre> * Option opt = OptionBuilder.withValueSeparator('=').create('D'); diff --git a/src/main/java/org/apache/commons/cli/PosixParser.java b/src/main/java/org/apache/commons/cli/PosixParser.java index 18a826fc..0a497146 100644 --- a/src/main/java/org/apache/commons/cli/PosixParser.java +++ b/src/main/java/org/apache/commons/cli/PosixParser.java @@ -46,20 +46,20 @@ public class PosixParser extends Parser { * Breaks {@code token} into its constituent parts using the following algorithm. * * <ul> - * <li>ignore the first character ("-")</li> + * <li>ignore the first character ("-")</li> * <li>for each remaining character check if an {@link Option} exists with that id.</li> - * <li>if an {@link Option} does exist then add that character prepended with "-" to the list of processed + * <li>if an {@link Option} does exist then add that character prepended with "-" to the list of processed * tokens.</li> * <li>if the {@link Option} can have an argument value and there are remaining characters in the token then add the * remaining characters as a token to the list of processed tokens.</li> - * <li>if an {@link Option} does NOT exist AND {@code stopAtNonOption} IS set then add the - * special token "--" followed by the remaining characters and also the remaining tokens directly to the + * <li>if an {@link Option} does NOT exist AND {@code stopAtNonOption} IS set then add the + * special token "--" followed by the remaining characters and also the remaining tokens directly to the * processed tokens list.</li> - * <li>if an {@link Option} does NOT exist AND {@code stopAtNonOption} IS NOT set then add - * that character prepended with "-".</li> + * <li>if an {@link Option} does NOT exist AND {@code stopAtNonOption} IS NOT set then add + * that character prepended with "-".</li> * </ul> * - * @param token The current token to be burst + * @param token The current token to be burst * @param stopAtNonOption Specifies whether to stop processing at the first non-Option encountered. */ protected void burstToken(final String token, final boolean stopAtNonOption) { @@ -94,17 +94,17 @@ public class PosixParser extends Parser { * The following are the rules used by this flatten method. * * <ol> - * <li>if {@code stopAtNonOption} is true then do not burst anymore of {@code arguments} entries, just + * <li>if {@code stopAtNonOption} is true then do not burst anymore of {@code arguments} entries, just * add each successive entry without further processing. Otherwise, ignore {@code stopAtNonOption}.</li> - * <li>if the current {@code arguments} entry is "--" just add the entry to the list of processed + * <li>if the current {@code arguments} entry is "--" just add the entry to the list of processed * tokens</li> - * <li>if the current {@code arguments} entry is "-" just add the entry to the list of processed tokens</li> - * <li>if the current {@code arguments} entry is two characters in length and the first character is "-" + * <li>if the current {@code arguments} entry is "-" just add the entry to the list of processed tokens</li> + * <li>if the current {@code arguments} entry is two characters in length and the first character is "-" * 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 * tokens and set the current {@link Option} member. If it is not a valid id and {@code stopAtNonOption} is true, * then the remaining entries are copied to the list of processed tokens. Otherwise, the current entry is ignored.</li> * <li>if the current {@code arguments} entry is more than two characters in length and the first character is - * "-" then we need to burst the entry to determine its constituents. For more information on the bursting + * "-" then we need to burst the entry to determine its constituents. For more information on the bursting * algorithm see {@link PosixParser#burstToken(String, boolean) burstToken}.</li> * <li>if the current {@code arguments} entry is not handled by any of the previous rules, then the entry is added * to the list of processed tokens.</li> @@ -195,7 +195,7 @@ public class PosixParser extends Parser { } /** - * Add the special token "--" and the current {@code value} to the processed tokens list. Then add all the + * Add the special token "--" and the current {@code value} to the processed tokens list. Then add all the * remaining {@code argument} values to the processed tokens list. * * @param value The current token

Previous message

View by thread

View by date

Next message

Reply via email to