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
commit ab04dd1b856765de690ccd0717280b6bd34925d3
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Oct 18 10:04:45 2024 -0400
Javadoc
---
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 | 2 +-
3 files changed, 6 insertions(+), 6 deletions(-)
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 4eb35314..63cf4059 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.
+ * @return 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 1755dd93..5cba55ff 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.
+ * @return 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.
+ * @return 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.
+ * @return 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.
+ * @return 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 b3ca3121..32a69071 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.
+ * @return this instance.
*/
public Builder setScalable(final boolean scalable) {
this.scalable = scalable;
