Skip to content

Commit 87c9813

Browse files
committed
Improved the Javadoc of MissingOptionException (CLI-220)
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1130785 13f79535-47bb-0310-9956-ffa450edef68
1 parent 6d5ab6a commit 87c9813

1 file changed

Lines changed: 6 additions & 7 deletions

File tree

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@
2828
*/
2929
public class MissingOptionException extends ParseException
3030
{
31-
/**
32-
* This exception {@code serialVersionUID}.
33-
*/
31+
/** This exception {@code serialVersionUID}. */
3432
private static final long serialVersionUID = 8161889051578563249L;
3533

3634
/** The list of missing options and groups */
@@ -51,7 +49,7 @@ public MissingOptionException(String message)
5149
* Constructs a new <code>MissingSelectedException</code> with the
5250
* specified list of missing options.
5351
*
54-
* @param missingOptions the list of missing options
52+
* @param missingOptions the list of missing options and groups
5553
* @since 1.2
5654
*/
5755
public MissingOptionException(List missingOptions)
@@ -61,9 +59,10 @@ public MissingOptionException(List missingOptions)
6159
}
6260

6361
/**
64-
* Return the list of options (as strings) missing in the command line parsed.
62+
* Returns the list of options or option groups missing in the command line parsed.
6563
*
66-
* @return the missing options
64+
* @return the missing options, consisting of String instances for simple
65+
* options, and OptionGroup instances for required option groups.
6766
* @since 1.2
6867
*/
6968
public List getMissingOptions()
@@ -74,7 +73,7 @@ public List getMissingOptions()
7473
/**
7574
* Build the exception message from the specified list of options.
7675
*
77-
* @param missingOptions
76+
* @param missingOptions the list of missing options and groups
7877
* @since 1.2
7978
*/
8079
private static String createMessage(List missingOptions)

0 commit comments

Comments
 (0)