Skip to content

Commit 4b25bcc

Browse files
committed
Javadoc
1 parent e0740a4 commit 4b25bcc

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,9 @@ public String toArgName(final String argName) {
231231
/** The default delimiters for an argument name */
232232
private static final String[] DEFAULT_ARG_NAME_DELIMITERS = { "<", ">" };
233233

234-
/** The default argument name */
234+
/**
235+
* The default argument name: {@value}.
236+
*/
235237
public static final String DEFAULT_ARG_NAME = "arg";
236238

237239
/**
@@ -267,27 +269,27 @@ public String toArgName(final String argName) {
267269
public static final Function<Option, String> NO_DEPRECATED_FORMAT = o -> Util.defaultValue(o.getDescription(), "");
268270

269271
/**
270-
* The string to display at the beginning of the usage statement.
272+
* The string to display at the beginning of the usage statement: {@value}.
271273
*/
272274
public static final String DEFAULT_SYNTAX_PREFIX = "usage: ";
273275

274276
/**
275-
* Default prefix for short options.
277+
* Default prefix for short options: {@value}.
276278
*/
277279
public static final String DEFAULT_OPT_PREFIX = "-";
278280

279281
/**
280-
* Default prefix for long options.
282+
* Default prefix for long options: {@value}.
281283
*/
282284
public static final String DEFAULT_LONG_OPT_PREFIX = "--";
283285

284286
/**
285-
* The default separator between options.
287+
* The default separator between options: {@value}.
286288
*/
287289
public static final String DEFAULT_OPT_SEPARATOR = ", ";
288290

289291
/**
290-
* The default separator between the opt and/or longOpt and the argument name.
292+
* The default separator between the opt and/or longOpt and the argument name: {@value}.
291293
*/
292294
public static final String DEFAULT_OPT_ARG_SEPARATOR = " ";
293295

0 commit comments

Comments
 (0)