(commons-cli) branch master updated: Javadoc

[ggregory]

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 4b25bcc1 Javadoc
4b25bcc1 is described below

commit 4b25bcc130a1640ecdbea25b2e621ec914baeb71
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Oct 18 08:30:02 2024 -0400

    Javadoc
---
 .../java/org/apache/commons/cli/help/OptionFormatter.java  | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

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 c535b284..1755dd93 100644
--- a/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
@@ -231,7 +231,9 @@ public final class OptionFormatter {
     /** The default delimiters for an argument name */
     private static final String[] DEFAULT_ARG_NAME_DELIMITERS = { "<", ">" };
 
-    /** The default argument name */
+    /**
+     * The default argument name: {@value}.
+     */
     public static final String DEFAULT_ARG_NAME = "arg";
 
     /**
@@ -267,27 +269,27 @@ public final class OptionFormatter {
     public static final Function<Option, String> NO_DEPRECATED_FORMAT = o -> 
Util.defaultValue(o.getDescription(), "");
 
     /**
-     * The string to display at the beginning of the usage statement.
+     * The string to display at the beginning of the usage statement: {@value}.
      */
     public static final String DEFAULT_SYNTAX_PREFIX = "usage: ";
 
     /**
-     * Default prefix for short options.
+     * Default prefix for short options: {@value}.
      */
     public static final String DEFAULT_OPT_PREFIX = "-";
 
     /**
-     * Default prefix for long options.
+     * Default prefix for long options: {@value}.
      */
     public static final String DEFAULT_LONG_OPT_PREFIX = "--";
 
     /**
-     * The default separator between options.
+     * The default separator between options: {@value}.
      */
     public static final String DEFAULT_OPT_SEPARATOR = ", ";
 
     /**
-     * The default separator between the opt and/or longOpt and the argument 
name.
+     * The default separator between the opt and/or longOpt and the argument 
name: {@value}.
      */
     public static final String DEFAULT_OPT_ARG_SEPARATOR = " ";