Fixed #471 @param(default = ) (#518)

Fixes #471 by implementing optional `defaultValueDescription` parameter which overrides the automatic description.
cbeust · Oct 2, 2023 · caeb4ea · caeb4ea
1 parent e7bd5fc
commit caeb4ea
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/src/main/java/com/beust/jcommander/Parameter.java b/src/main/java/com/beust/jcommander/Parameter.java
@@ -46,6 +46,11 @@
    */
   String description() default "";
 
+  /**
+   * Description of default value.
+   */
+  String defaultValueDescription() default "";
+
   /**
    * Whether this option is required.
    */

diff --git a/src/main/java/com/beust/jcommander/ParameterDescription.java b/src/main/java/com/beust/jcommander/ParameterDescription.java
@@ -166,8 +166,15 @@ public String getLongestName() {
     return longestName;
   }
 
+  /**
+   * @return defaultValueDescription, if description is empty string, return default Object.
+   */
   public Object getDefault() {
-   return defaultObject;
+   String defaultDescription = parameterAnnotation.defaultValueDescription();
+   if (defaultDescription.isEmpty())
+     return defaultObject;
+   else
+     return defaultDescription;
   }
 
   public String getDescription() {