Javadoc

Author: garydgregory

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

@@ -103,7 +103,7 @@ public CommandLine build() {
          * Sets the deprecated option handler.
          *
          * @param deprecatedHandler the deprecated option handler.
-         * @return this.
+         * @return {@code this} instance.
          * @since 1.7.0
          */
         public Builder setDeprecatedHandler(final Consumer<Option> deprecatedHandler) {

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

@@ -110,7 +110,7 @@ public Builder setAllowPartialMatching(final boolean allowPartialMatching) {
          * Sets the deprecated option handler.
          *
          * @param deprecatedHandler the deprecated option handler.
-         * @return this.
+         * @return {@code this} instance.
          * @since 1.7.0
          */
         public Builder setDeprecatedHandler(final Consumer<Option> deprecatedHandler) {

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

@@ -64,7 +64,7 @@ public DeprecatedAttributes get() {
          * Sets the description.
          *
          * @param description the description.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setDescription(final String description) {
             this.description = description;
@@ -75,7 +75,7 @@ public Builder setDescription(final String description) {
          * Whether this option is subject to removal in a future version.
          *
          * @param forRemoval whether this is subject to removal in a future version.
-         * @return this.
+         * @return {@code this} instance.
          * @see <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Deprecated.html#forRemoval()">Deprecated.forRemoval</a>
          */
         public Builder setForRemoval(final boolean forRemoval) {
@@ -87,7 +87,7 @@ public Builder setForRemoval(final boolean forRemoval) {
          * Sets the version in which the option became deprecated.
          *
          * @param since the version in which the option became deprecated.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setSince(final String since) {
             this.since = since;

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

@@ -99,7 +99,7 @@ public HelpFormatter get() {
          * Sets the output PrintWriter, defaults to wrapping {@link System#out}.
          *
          * @param printWriter the output PrintWriter, not null.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setPrintWriter(final PrintWriter printWriter) {
             this.printStream = Objects.requireNonNull(printWriter, "printWriter");
@@ -110,7 +110,7 @@ public Builder setPrintWriter(final PrintWriter printWriter) {
          * Sets whether to show deprecated options.
          *
          * @param useDefaultFormat if {@code true} use the default format, otherwise clear the formatter.
-         * @return this.
+         * @return {@code this} instance.
          */
         public Builder setShowDeprecated(final boolean useDefaultFormat) {
             return setShowDeprecated(useDefaultFormat ? DEFAULT_DEPRECATED_FORMAT : null);
@@ -120,7 +120,7 @@ public Builder setShowDeprecated(final boolean useDefaultFormat) {
          * Sets whether to show deprecated options.
          *
          * @param showDeprecatedFunc Specify the format for the deprecated options.
-         * @return this.
+         * @return {@code this} instance.
          * @since 1.8.0
          */
         public Builder setShowDeprecated(final Function<Option, String> showDeprecatedFunc) {