commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brit...@apache.org
Subject [19/50] [abbrv] commons-cli git commit: Better explain how getArgs works. Thanks to Thomas Brand for pointing this out.
Date Thu, 08 Jun 2017 17:36:48 GMT
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


Project: http://git-wip-us.apache.org/repos/asf/commons-cli/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-cli/commit/bbaf99f1
Tree: http://git-wip-us.apache.org/repos/asf/commons-cli/tree/bbaf99f1
Diff: http://git-wip-us.apache.org/repos/asf/commons-cli/diff/bbaf99f1

Branch: refs/heads/master
Commit: bbaf99f10729f95b4a1cb1be8ac56537c7027b32
Parents: 0304f59
Author: Benedikt Ritter <britter@apache.org>
Authored: Thu Aug 18 10:18:43 2016 +0000
Committer: Benedikt Ritter <britter@apache.org>
Committed: Thu Aug 18 10:18:43 2016 +0000

----------------------------------------------------------------------
 src/main/java/org/apache/commons/cli/Option.java | 9 +++++++++
 1 file changed, 9 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-cli/blob/bbaf99f1/src/main/java/org/apache/commons/cli/Option.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/cli/Option.java b/src/main/java/org/apache/commons/cli/Option.java
index e59c0c5..96118ec 100644
--- a/src/main/java/org/apache/commons/cli/Option.java
+++ b/src/main/java/org/apache/commons/cli/Option.java
@@ -415,8 +415,17 @@ public class Option implements Cloneable, Serializable
 
     /** 
      * 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()
     {


Mime
View raw message