Skip to content

Commit fd45988

Browse files
committed
Javadoc: Empty Javadoc line before the 1st tag.
1 parent bae3c6d commit fd45988

File tree

5 files changed

+12
-0
lines changed

5 files changed

+12
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
6767
*
6868
* Please report issues at https://example.com/issues
6969
* }</pre>
70+
*
7071
* @deprecated Use {@link org.apache.commons.cli.help.HelpFormatter}.
7172
*/
7273
@Deprecated
@@ -146,6 +147,7 @@ public Builder setShowDeprecated(final Function<Option, String> deprecatedFormat
146147

147148
/**
148149
* Sets whether to show the date the option was first added.
150+
*
149151
* @param showSince if @{code true} the date the options was first added will be shown.
150152
* @return this builder.
151153
* @since 1.9.0
@@ -232,6 +234,7 @@ private static PrintWriter createDefaultPrintWriter() {
232234

233235
/**
234236
* Gets the option description or an empty string if the description is {@code null}.
237+
*
235238
* @param option The option to get the description from.
236239
* @return the option description or an empty string if the description is {@code null}.
237240
* @since 1.8.0
@@ -339,6 +342,7 @@ public HelpFormatter() {
339342

340343
/**
341344
* Constructs a new instance.
345+
*
342346
* @param printWriter TODO
343347
*/
344348
private HelpFormatter(final Function<Option, String> deprecatedFormatFunction, final PrintWriter printWriter, final boolean showSince) {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,7 @@ public String getOpt() {
673673

674674
/**
675675
* Gets the version when this option was added.
676+
*
676677
* @return the version when this option was added, or {@code null} if not set.
677678
*/
678679
public String getSince() {

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ public Collection<Option> getOptions() {
8686
* Gets the selected option name.
8787
*
8888
* If the selected option is deprecated <em>no warning is logged</em>.
89+
*
8990
* @return the selected option name.
9091
*/
9192
public String getSelected() {
@@ -105,6 +106,7 @@ public boolean isRequired() {
105106
* Tests whether an option is selected.
106107
*
107108
* If an option is selected and is deprecated <em>no warning is logged</em>.
109+
*
108110
* @return whether whether an option is selected.
109111
* @since 1.9.0
110112
*/
@@ -125,6 +127,7 @@ public void setRequired(final boolean required) {
125127
* Sets the selected option of this group to {@code name}.
126128
*
127129
* If the selected option is deprecated <em>no warning is logged</em>.
130+
*
128131
* @param option the option that is selected.
129132
* @throws AlreadySelectedException if an option from this group has already been selected.
130133
*/

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ final class OptionValidator {
4141
* <li>isIdentifierIgnorable returns true for the character</li>
4242
* <li>it is a hyphen/dash ('-')</li>
4343
* </ul>
44+
*
4445
* @param c the character to validate
4546
* @return true if {@code c} is a valid character letter.
4647
*/
@@ -62,6 +63,7 @@ private static boolean isValidChar(final char c) {
6263
* <li>isIdentifierIgnorable returns true for the character</li>
6364
* <li>it is a question mark or 'at' sign ('?' or '@')</li>
6465
* </ul>
66+
*
6567
* @param c the option to validate
6668
* @return true if {@code c} is a letter, '?' or '@', otherwise false.
6769
*/
@@ -71,6 +73,7 @@ private static boolean isValidOpt(final char c) {
7173

7274
/**
7375
* Checks the char array for a matching char.
76+
*
7477
* @param chars the char array to search
7578
* @param c the char to look for.
7679
* @return {@code true} if {@code c} was in {@code ary}, {@code false} otherwise.

src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,7 @@ public final String toArgName(final String argName) {
410410
* of option groups. To display the option grouping use {@link #toSyntaxOptions(Options)} or
411411
* {@link #toSyntaxOptions(OptionGroup)} for individual groups.
412412
* </p>
413+
*
413414
* @param options The collection of {@link Option} instances to create the string representation for.
414415
* @return the string representation of the options as used in the syntax display.
415416
*/

0 commit comments

Comments
 (0)