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 0abda9d3 Javadoc
0abda9d3 is described below
commit 0abda9d3d648727d92f5e1952a05e488afe229aa
Author: Gary D. Gregory <[email protected]>
AuthorDate: Wed Aug 20 06:50:53 2025 -0400
Javadoc
---
.../java/org/apache/commons/cli/help/AbstractHelpFormatter.java | 2 +-
src/main/java/org/apache/commons/cli/help/HelpFormatter.java | 2 +-
src/main/java/org/apache/commons/cli/help/OptionFormatter.java | 8 ++++----
src/main/java/org/apache/commons/cli/help/TextStyle.java | 4 ++--
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git
a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
index 91f356d5..7ba29f85 100644
--- a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
@@ -75,7 +75,7 @@ public abstract class AbstractHelpFormatter {
/**
* Returns this instance cast to {@code B}.
*
- * @return this instance cast to {@code B}.
+ * @return {@code this} instance cast to {@code B}.
*/
@SuppressWarnings("unchecked")
protected B asThis() {
diff --git a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
index c8ed01a6..887011d2 100644
--- a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
@@ -94,7 +94,7 @@ public class HelpFormatter extends AbstractHelpFormatter {
* Sets the showSince flag.
*
* @param showSince the desired value of the showSince flag.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setShowSince(final boolean showSince) {
this.showSince = showSince;
diff --git a/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
b/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
index 7e636ec5..ef837372 100644
--- a/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
@@ -114,7 +114,7 @@ public final class OptionFormatter {
*
* @param begin the beginning delimiter.
* @param end the ending delimiter.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setArgumentNameDelimiters(final String begin, final
String end) {
this.argNameDelimiters[0] = Util.defaultValue(begin, "");
@@ -137,7 +137,7 @@ public final class OptionFormatter {
* Specifies the function to construct the deprecated massage for the
Option. Should include the description text if desired.
*
* @param deprecatedFormatFunction the function to specify the
deprecated message for the option.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setDeprecatedFormatFunction(final Function<Option,
String> deprecatedFormatFunction) {
this.deprecatedFormatFunction = deprecatedFormatFunction;
@@ -172,7 +172,7 @@ public final class OptionFormatter {
*
* @param begin the beginning delimiter.
* @param end the ending delimiter.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setOptionalDelimiters(final String begin, final String
end) {
this.optionalDelimiters[0] = Util.defaultValue(begin, "");
@@ -184,7 +184,7 @@ public final class OptionFormatter {
* Specifies the short option prefix.
*
* @param optPrefix the prefix for short options.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setOptPrefix(final String optPrefix) {
this.optPrefix = Util.defaultValue(optPrefix, "");
diff --git a/src/main/java/org/apache/commons/cli/help/TextStyle.java
b/src/main/java/org/apache/commons/cli/help/TextStyle.java
index 00f0818b..fda8d2d9 100644
--- a/src/main/java/org/apache/commons/cli/help/TextStyle.java
+++ b/src/main/java/org/apache/commons/cli/help/TextStyle.java
@@ -200,7 +200,7 @@ public final class TextStyle {
* Sets whether the column can be made wider or to narrower width to
fit constraints of the HelpAppendable and formatting.
*
* @param scalable Whether the text width can be adjusted.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setScalable(final boolean scalable) {
this.scalable = scalable;
@@ -211,7 +211,7 @@ public final class TextStyle {
* Sets all properties from the given text style.
*
* @param style the source text style.
- * @return this instance.
+ * @return {@code this} instance.
*/
public Builder setTextStyle(final TextStyle style) {
this.alignment = style.alignment;
