[CLI-218] Clarify javadoc of CommandLine.getOptionValue.

netomi · netomi · commit e89475ca66e2 · 2013-02-09T14:21:27.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1444365 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -23,6 +23,10 @@
   <body>
     
     <release version="1.3" date="in SVN">
+      <action type="fix" dev="tn" issue="CLI-218" due-to="Sven">
+        Clarify javadoc for CommandLine.getOptionValue() that the first specified
+        argument will be returned.
+      </action>
       <action type="add" dev="tn" issue="CLI-214" due-to="Alexandru Mocanu">
         Added new method Options.addOption(String, String).
       </action>
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -133,7 +133,7 @@ public Object getOptionObject(char opt)
     }
 
     /** 
-     * Retrieve the argument, if any, of this option.
+     * Retrieve the first argument, if any, of this option.
      *
      * @param opt the name of the option
      * @return Value of the argument if option is set, and has an argument,
@@ -147,7 +147,7 @@ public String getOptionValue(String opt)
     }
 
     /** 
-     * Retrieve the argument, if any, of this option.
+     * Retrieve the first argument, if any, of this option.
      *
      * @param opt the character name of the option
      * @return Value of the argument if option is set, and has an argument,
@@ -218,7 +218,7 @@ public String[] getOptionValues(char opt)
     }
 
     /** 
-     * Retrieve the argument, if any, of an option.
+     * Retrieve the first argument, if any, of an option.
      *
      * @param opt name of the option
      * @param defaultValue is the default value to be returned if the option

Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ public Object getOptionObject(char opt)`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`/**`
`136`		`- * Retrieve the argument, if any, of this option.`
	`136`	`+ * Retrieve the first argument, if any, of this option.`
`137`	`137`	`*`
`138`	`138`	`* @param opt the name of the option`
`139`	`139`	`* @return Value of the argument if option is set, and has an argument,`
`@@ -147,7 +147,7 @@ public String getOptionValue(String opt)`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`/**`
`150`		`- * Retrieve the argument, if any, of this option.`
	`150`	`+ * Retrieve the first argument, if any, of this option.`
`151`	`151`	`*`
`152`	`152`	`* @param opt the character name of the option`
`153`	`153`	`* @return Value of the argument if option is set, and has an argument,`
`@@ -218,7 +218,7 @@ public String[] getOptionValues(char opt)`
`218`	`218`	`}`
`219`	`219`
`220`	`220`	`/**`
`221`		`- * Retrieve the argument, if any, of an option.`
	`221`	`+ * Retrieve the first argument, if any, of an option.`
`222`	`222`	`*`
`223`	`223`	`* @param opt name of the option`
`224`	`224`	`* @param defaultValue is the default value to be returned if the option`