Skip to content

Commit bbaf99f

Browse files
committed
Better explain how getArgs works. Thanks to Thomas Brand for pointing this out.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1756753 13f79535-47bb-0310-9956-ffa450edef68
1 parent 0304f59 commit bbaf99f

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,8 +415,17 @@ public boolean hasValueSeparator()
415415

416416
/**
417417
* Returns the number of argument values this Option can take.
418+
*
419+
* <p>
420+
* A value equal to the constant {@link #UNINITIALIZED} (= -1) indicates
421+
* the number of arguments has not been specified.
422+
* A value equal to the constant {@link #UNLIMITED_VALUES} (= -2) indicates
423+
* that this options takes an unlimited amount of values.
424+
* </p>
418425
*
419426
* @return num the number of argument values
427+
* @see #UNINITIALIZED
428+
* @see #UNLIMITED_VALUES
420429
*/
421430
public int getArgs()
422431
{

0 commit comments

Comments
 (0)