Javadoc

Author: garydgregory

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

@@ -122,7 +122,7 @@ protected String getOptionGroupSeparator() {
          * Sets the comparator to use for sorting options. If set to {@code null} no sorting is performed.
          *
          * @param comparator The comparator to use for sorting options.
-         * @return this
+         * @return {@code this} instance.
          */
         public B setComparator(final Comparator<Option> comparator) {
             this.comparator = comparator;
@@ -133,7 +133,7 @@ public B setComparator(final Comparator<Option> comparator) {
          * Sets the {@link HelpAppendable}.
          *
          * @param helpAppendable the {@link HelpAppendable} to use.
-         * @return this
+         * @return {@code this} instance.
          */
         public B setHelpAppendable(final HelpAppendable helpAppendable) {
             this.helpAppendable = helpAppendable != null ? helpAppendable : TextHelpAppendable.systemOut();
@@ -144,7 +144,7 @@ public B setHelpAppendable(final HelpAppendable helpAppendable) {
          * Sets the {@link OptionFormatter.Builder}.
          *
          * @param optionFormatBuilder the {@link OptionFormatter.Builder} to use.
-         * @return this
+         * @return {@code this} instance.
          */
         public B setOptionFormatBuilder(final OptionFormatter.Builder optionFormatBuilder) {
             this.optionFormatBuilder = optionFormatBuilder != null ? optionFormatBuilder : OptionFormatter.builder();
@@ -155,7 +155,7 @@ public B setOptionFormatBuilder(final OptionFormatter.Builder optionFormatBuilde
          * Sets the OptionGroup separator. Normally " | " or something similar to denote that only one option may be chosen.
          *
          * @param optionGroupSeparator the string to separate option group elements with.
-         * @return this
+         * @return {@code this} instance.
          */
         public B setOptionGroupSeparator(final String optionGroupSeparator) {
             this.optionGroupSeparator = Util.defaultValue(optionGroupSeparator, "");

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

@@ -126,7 +126,7 @@ public Builder setArgumentNameDelimiters(final String begin, final String end) {
          * Sets the default argument name.
          *
          * @param name the new value of default argument name.
-         * @return this
+         * @return {@code this} instance.
          */
         public Builder setDefaultArgName(final String name) {
             this.defaultArgName = Util.defaultValue(name, DEFAULT_ARG_NAME);
@@ -148,7 +148,7 @@ public Builder setDeprecatedFormatFunction(final Function<Option, String> deprec
          * Sets the long option prefix.
          *
          * @param prefix prefix for long options.
-         * @return this
+         * @return {@code this} instance.
          */
         public Builder setLongOptPrefix(final String prefix) {
             this.longOptPrefix = Util.defaultValue(prefix, "");
@@ -159,7 +159,7 @@ public Builder setLongOptPrefix(final String prefix) {
          * Sets the separator displayed between a options and the argument name. Typically ' ' or '='.
          *
          * @param optArgSeparator the separator.
-         * @return this
+         * @return {@code this} instance.
          * @since 1.3
          */
         public Builder setOptArgSeparator(final String optArgSeparator) {
@@ -195,7 +195,7 @@ public Builder setOptPrefix(final String optPrefix) {
          * Sets the separator displayed between a long option and short options. Typically ',' or ' '.
          *
          * @param optSeparator the separator.
-         * @return this
+         * @return {@code this} instance.
          * @since 1.3
          */
         public Builder setOptSeparator(final String optSeparator) {
@@ -207,7 +207,7 @@ public Builder setOptSeparator(final String optSeparator) {
          * Specifies the function to convert an {@link OptionFormatter} into the syntax format for the option.
          *
          * @param syntaxFormatFunction The function to convert an {@link OptionFormatter} into the syntax format for the option.
-         * @return this
+         * @return {@code this} instance.
          */
         public Builder setSyntaxFormatFunction(final BiFunction<OptionFormatter, Boolean, String> syntaxFormatFunction) {
             this.syntaxFormatFunction = syntaxFormatFunction;

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

@@ -145,7 +145,7 @@ public boolean isScalable() {
          * Sets the alignment.
          *
          * @param alignment the desired alignment.
-         * @return this
+         * @return {@code this} instance.
          */
         public Builder setAlignment(final Alignment alignment) {
             this.alignment = alignment;
@@ -156,7 +156,7 @@ public Builder setAlignment(final Alignment alignment) {
          * Sets the indent value.
          *
          * @param indent the new indent value.
-         * @return this
+         * @return {@code this} instance.
          */
         public Builder setIndent(final int indent) {
             this.indent = indent;
@@ -167,7 +167,7 @@ public Builder setIndent(final int indent) {
          * Sets the left padding.
          *
          * @param leftPad the new left padding.
-         * @return this
+         * @return {@code this} instance.
          */
         public Builder setLeftPad(final int leftPad) {
             this.leftPad = leftPad;
@@ -178,7 +178,7 @@ public Builder setLeftPad(final int leftPad) {
          * Sets the currently specified minimum width.
          *
          * @param maxWidth The currently specified maximum width.
-         * @return this
+         * @return {@code this} instance.
          */
         public Builder setMaxWidth(final int maxWidth) {
             this.maxWidth = maxWidth;
@@ -189,7 +189,7 @@ public Builder setMaxWidth(final int maxWidth) {
          * Sets the currently specified minimum width.
          *
          * @param minWidth The currently specified minimum width.
-         * @return this
+         * @return {@code this} instance.
          */
         public Builder setMinWidth(final int minWidth) {
             this.minWidth = minWidth;