Author: britter
Date: Thu Aug 18 10:18:43 2016
New Revision: 1756753
URL: http://svn.apache.org/viewvc?rev=1756753&view=rev
Log:
Better explain how getArgs works. Thanks to Thomas Brand for pointing this out.
Modified:
commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java
Modified:
commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java?rev=1756753&r1=1756752&r2=1756753&view=diff
==============================================================================
--- commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java
(original)
+++ commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java
Thu Aug 18 10:18:43 2016
@@ -415,8 +415,17 @@ public class Option implements Cloneable
/**
* Returns the number of argument values this Option can take.
+ *
+ * <p>
+ * A value equal to the constant {@link #UNINITIALIZED} (= -1) indicates
+ * the number of arguments has not been specified.
+ * A value equal to the constant {@link #UNLIMITED_VALUES} (= -2) indicates
+ * that this options takes an unlimited amount of values.
+ * </p>
*
* @return num the number of argument values
+ * @see #UNINITIALIZED
+ * @see #UNLIMITED_VALUES
*/
public int getArgs()
{
