Skip to content

Commit 0abda9d

Browse files
committed
Javadoc
1 parent 517038e commit 0abda9d

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ protected Builder() {
7575
/**
7676
* Returns this instance cast to {@code B}.
7777
*
78-
* @return this instance cast to {@code B}.
78+
* @return {@code this} instance cast to {@code B}.
7979
*/
8080
@SuppressWarnings("unchecked")
8181
protected B asThis() {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public HelpFormatter get() {
9494
* Sets the showSince flag.
9595
*
9696
* @param showSince the desired value of the showSince flag.
97-
* @return this instance.
97+
* @return {@code this} instance.
9898
*/
9999
public Builder setShowSince(final boolean showSince) {
100100
this.showSince = showSince;

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public OptionFormatter get() {
114114
*
115115
* @param begin the beginning delimiter.
116116
* @param end the ending delimiter.
117-
* @return this instance.
117+
* @return {@code this} instance.
118118
*/
119119
public Builder setArgumentNameDelimiters(final String begin, final String end) {
120120
this.argNameDelimiters[0] = Util.defaultValue(begin, "");
@@ -137,7 +137,7 @@ public Builder setDefaultArgName(final String name) {
137137
* Specifies the function to construct the deprecated massage for the Option. Should include the description text if desired.
138138
*
139139
* @param deprecatedFormatFunction the function to specify the deprecated message for the option.
140-
* @return this instance.
140+
* @return {@code this} instance.
141141
*/
142142
public Builder setDeprecatedFormatFunction(final Function<Option, String> deprecatedFormatFunction) {
143143
this.deprecatedFormatFunction = deprecatedFormatFunction;
@@ -172,7 +172,7 @@ public Builder setOptArgSeparator(final String optArgSeparator) {
172172
*
173173
* @param begin the beginning delimiter.
174174
* @param end the ending delimiter.
175-
* @return this instance.
175+
* @return {@code this} instance.
176176
*/
177177
public Builder setOptionalDelimiters(final String begin, final String end) {
178178
this.optionalDelimiters[0] = Util.defaultValue(begin, "");
@@ -184,7 +184,7 @@ public Builder setOptionalDelimiters(final String begin, final String end) {
184184
* Specifies the short option prefix.
185185
*
186186
* @param optPrefix the prefix for short options.
187-
* @return this instance.
187+
* @return {@code this} instance.
188188
*/
189189
public Builder setOptPrefix(final String optPrefix) {
190190
this.optPrefix = Util.defaultValue(optPrefix, "");

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ public Builder setMinWidth(final int minWidth) {
200200
* Sets whether the column can be made wider or to narrower width to fit constraints of the HelpAppendable and formatting.
201201
*
202202
* @param scalable Whether the text width can be adjusted.
203-
* @return this instance.
203+
* @return {@code this} instance.
204204
*/
205205
public Builder setScalable(final boolean scalable) {
206206
this.scalable = scalable;
@@ -211,7 +211,7 @@ public Builder setScalable(final boolean scalable) {
211211
* Sets all properties from the given text style.
212212
*
213213
* @param style the source text style.
214-
* @return this instance.
214+
* @return {@code this} instance.
215215
*/
216216
public Builder setTextStyle(final TextStyle style) {
217217
this.alignment = style.alignment;

0 commit comments

Comments
 (0)