commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From roxspr...@apache.org
Subject cvs commit: jakarta-commons/cli/src/java/org/apache/commons/cli CommandLine.java Option.java Options.java package.html OptionBuilder.java
Date Wed, 14 Apr 2004 19:32:18 GMT
roxspring    2004/04/14 12:32:18

  Modified:    cli/src/java/org/apache/commons/cli Tag:
                        RESEARCH_CLI_2_ROXSPRING CommandLine.java
                        Option.java Options.java package.html
                        OptionBuilder.java
  Log:
  Another Javadoc patch:
  dropped html paragraph formatting from html comments to deal with -breakiterator javadoc
warnings
  
  Revision  Changes    Path
  No                   revision
  No                   revision
  1.18.2.3  +18 -18    jakarta-commons/cli/src/java/org/apache/commons/cli/CommandLine.java
  
  Index: CommandLine.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/CommandLine.java,v
  retrieving revision 1.18.2.2
  retrieving revision 1.18.2.3
  diff -u -r1.18.2.2 -r1.18.2.3
  --- CommandLine.java	4 Feb 2004 02:01:50 -0000	1.18.2.2
  +++ CommandLine.java	14 Apr 2004 19:32:18 -0000	1.18.2.3
  @@ -55,14 +55,14 @@
       private Option[] optionsArray;
   
       /**
  -     * <p>Creates a command line.</p>
  +     * Creates a command line.
        */
       CommandLine()
       {
       }
   
       /** 
  -     * <p>Query to see if an option has been set.</p>
  +     * Query to see if an option has been set.
        *
        * @param opt Short name of the option
        * @return true if set, false if not
  @@ -73,7 +73,7 @@
       }
   
       /** 
  -     * <p>Query to see if an option has been set.</p>
  +     * Query to see if an option has been set.
        *
        * @param opt character name of the option
        * @return true if set, false if not
  @@ -84,7 +84,7 @@
       }
   
       /**
  -     * <p>Return the <code>Object</code> type of this <code>Option</code>.</p>
  +     * Return the <code>Object</code> type of this <code>Option</code>.
        *
        * @param opt the name of the option
        * @return the type of this <code>Option</code>
  @@ -104,7 +104,7 @@
       }
   
       /**
  -     * <p>Return the <code>Object</code> type of this <code>Option</code>.</p>
  +     * Return the <code>Object</code> type of this <code>Option</code>.
        *
        * @param opt the name of the option
        * @return the type of opt
  @@ -115,7 +115,7 @@
       }
   
       /** 
  -     * <p>Retrieve the argument, if any, of this option.</p>
  +     * Retrieve the 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,
  @@ -129,7 +129,7 @@
       }
   
       /** 
  -     * <p>Retrieve the argument, if any, of this option.</p>
  +     * Retrieve the 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,
  @@ -141,7 +141,7 @@
       }
   
       /** 
  -     * <p>Retrieves the array of values, if any, of an option.</p>
  +     * Retrieves the array of values, if any, of an option.
        *
        * @param opt string name of the option
        * @return Values of the argument if option is set, and has an argument,
  @@ -169,7 +169,7 @@
       }
   
       /** 
  -     * <p>Retrieves the array of values, if any, of an option.</p>
  +     * Retrieves the array of values, if any, of an option.
        *
        * @param opt character name of the option
        * @return Values of the argument if option is set, and has an argument,
  @@ -181,7 +181,7 @@
       }
   
       /** 
  -     * <p>Retrieve the argument, if any, of an option.</p>
  +     * Retrieve the argument, if any, of an option.
        *
        * @param opt name of the option
        * @param defaultValue is the default value to be returned if the option 
  @@ -197,7 +197,7 @@
       }
   
       /** 
  -     * <p>Retrieve the argument, if any, of an option.</p>
  +     * Retrieve the argument, if any, of an option.
        *
        * @param opt character name of the option
        * @param defaultValue is the default value to be returned if the option 
  @@ -211,7 +211,7 @@
       }
   
       /** 
  -     * <p>Retrieve any left-over non-recognized options and arguments</p>
  +     * Retrieve any left-over non-recognized options and arguments
        *
        * @return remaining items passed in but not parsed as an array
        */
  @@ -225,7 +225,7 @@
       }
   
       /** 
  -     * <p>Retrieve any left-over non-recognized options and arguments</p>
  +     * Retrieve any left-over non-recognized options and arguments
        *
        * @return remaining items passed in but not parsed as a <code>List</code>.
        */
  @@ -257,7 +257,7 @@
       */
   
       /**
  -     * <p>Add left-over unrecognized option/argument.</p>
  +     * Add left-over unrecognized option/argument.
        *
        * @param arg the unrecognised option/argument.
        */
  @@ -267,8 +267,8 @@
       }
   
       /**
  -     * <p>Add an option to the command line.  The values of 
  -     * the option are stored.</p>
  +     * Add an option to the command line.  The values of 
  +     * the option are stored.
        *
        * @param opt the processed option
        */
  @@ -291,7 +291,7 @@
       }
   
       /**
  -     * <p>Returns an iterator over the Option members of CommandLine.</p>
  +     * Returns an iterator over the Option members of CommandLine.
        *
        * @return an <code>Iterator</code> over the processed {@link Option} 
        * members of this {@link CommandLine}
  @@ -302,7 +302,7 @@
       }
   
       /**
  -     * <p>Returns an array of the processed {@link Option}s.</p>
  +     * Returns an array of the processed {@link Option}s.
        *
        * @return an array of the processed {@link Option}s.
        */
  
  
  
  1.21.2.3  +38 -35    jakarta-commons/cli/src/java/org/apache/commons/cli/Option.java
  
  Index: Option.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/Option.java,v
  retrieving revision 1.21.2.2
  retrieving revision 1.21.2.3
  diff -u -r1.21.2.2 -r1.21.2.3
  --- Option.java	4 Feb 2004 02:01:50 -0000	1.21.2.2
  +++ Option.java	14 Apr 2004 19:32:18 -0000	1.21.2.3
  @@ -109,7 +109,7 @@
       }
   
       /**
  -     * <p>Creates an Option using the specified parameters.</p>
  +     * Creates an Option using the specified parameters.
        *
        * @param opt short representation of the option
        * @param longOpt the long representation of the option
  @@ -140,9 +140,9 @@
       }
   
       /**
  -     * <p>Returns the id of this Option.  This is only set when the
  +     * Returns the id of this Option.  This is only set when the
        * Option shortOpt is a single character.  This is used for switch
  -     * statements.</p>
  +     * statements.
        *
        * @return the id of this Option
        */
  @@ -152,7 +152,7 @@
       }
   
       /**
  -     * <p>Returns the 'unique' Option identifier.</p>
  +     * Returns the 'unique' Option identifier.
        * 
        * @return the 'unique' Option identifier
        */
  @@ -167,12 +167,13 @@
           return this.opt;
       }
   
  -    /** <p>Retrieve the name of this Option.</p>
  +    /** 
  +     * Retrieve the name of this Option.
        *
  -     * <p>It is this String which can be used with
  +     * It is this String which can be used with
        * {@link CommandLine#hasOption(String opt)} and
        * {@link CommandLine#getOptionValue(String opt)} to check
  -     * for existence and argument.<p>
  +     * for existence and argument.
        *
        * @return The name of this option
        */
  @@ -182,7 +183,7 @@
       }
   
       /**
  -     * <p>Retrieve the type of this Option.</p>
  +     * Retrieve the type of this Option.
        * 
        * @return The type of this option
        */
  @@ -192,7 +193,7 @@
       }
   
       /**
  -     * <p>Sets the type of this Option.</p>
  +     * Sets the type of this Option.
        *
        * @param type the type of this Option
        */
  @@ -202,7 +203,7 @@
       }
   
       /** 
  -     * <p>Retrieve the long name of this Option.</p>
  +     * Retrieve the long name of this Option.
        *
        * @return Long name of this option, or null, if there is no long name
        */
  @@ -212,7 +213,7 @@
       }
   
       /**
  -     * <p>Sets the long name of this Option.</p>
  +     * Sets the long name of this Option.
        *
        * @param longOpt the long name of this Option
        */
  @@ -222,7 +223,7 @@
       }
   
       /**
  -     * <p>Sets whether this Option can have an optional argument.</p>
  +     * Sets whether this Option can have an optional argument.
        *
        * @param optionalArg specifies whether the Option can have
        * an optional argument.
  @@ -240,7 +241,8 @@
           return this.optionalArg;
       }
   
  -    /** <p>Query to see if this Option has a long name</p>
  +    /** 
  +     * Query to see if this Option has a long name
        *
        * @return boolean flag indicating existence of a long name
        */
  @@ -249,7 +251,8 @@
           return (this.longOpt != null);
       }
   
  -    /** <p>Query to see if this Option requires an argument</p>
  +    /** 
  +     * Query to see if this Option requires an argument
        *
        * @return boolean flag indicating if an argument is required
        */
  @@ -258,7 +261,8 @@
           return (this.numberOfArgs > 0) || (numberOfArgs == UNLIMITED_VALUES);
       }
   
  -    /** <p>Retrieve the self-documenting description of this Option</p>
  +    /** 
  +     * Retrieve the self-documenting description of this Option
        *
        * @return The string description of this option
        */
  @@ -268,7 +272,7 @@
       }
   
       /** 
  -     * <p>Query to see if this Option requires an argument</p>
  +     * Query to see if this Option requires an argument
        *
        * @return boolean flag indicating if an argument is required
        */
  @@ -278,7 +282,7 @@
       }
   
       /**
  -     * <p>Sets whether this Option is mandatory.</p>
  +     * Sets whether this Option is mandatory.
        *
        * @param required specifies whether this Option is mandatory
        */
  @@ -288,7 +292,7 @@
       }
   
       /**
  -     * <p>Sets the display name for the argument value.</p>
  +     * Sets the display name for the argument value.
        *
        * @param argName the display name for the argument value.
        */
  @@ -298,7 +302,7 @@
       }
   
       /**
  -     * <p>Gets the display name for the argument value.</p>
  +     * Gets the display name for the argument value.
        *
        * @return the display name for the argument value.
        */
  @@ -308,8 +312,8 @@
       }
   
       /**
  -     * <p>Returns whether the display name for the argument value
  -     * has been set.</p>
  +     * Returns whether the display name for the argument value
  +     * has been set.
        *
        * @return if the display name for the argument value has been
        * set.
  @@ -320,7 +324,7 @@
       }
   
       /** 
  -     * <p>Query to see if this Option can take many values</p>
  +     * Query to see if this Option can take many values.
        *
        * @return boolean flag indicating if multiple values are allowed
        */
  @@ -331,7 +335,7 @@
       }
   
       /** 
  -     * <p>Sets the number of argument values this Option can take.</p>
  +     * Sets the number of argument values this Option can take.
        *
        * @param num the number of argument values
        */
  @@ -341,8 +345,8 @@
       }
   
       /**
  -     * <p>Sets the value separator.  For example if the argument value
  -     * was a Java property, the value separator would be '='.</p>
  +     * Sets the value separator.  For example if the argument value
  +     * was a Java property, the value separator would be '='.
        *
        * @param sep The value separator.
        */
  @@ -352,7 +356,7 @@
       }
   
       /**
  -     * <p>Returns the value separator character.</p>
  +     * Returns the value separator character.
        *
        * @return the value separator character.
        */
  @@ -362,9 +366,9 @@
       }
   
       /**
  -     * <p>Return whether this Option has specified a value separator.</p>
  +     * Return whether this Option has specified a value separator.
        * 
  -     * @return whether this Option has specified a value separator.</p>
  +     * @return whether this Option has specified a value separator.
        */
       public boolean hasValueSeparator()
       {
  @@ -372,7 +376,7 @@
       }
   
       /** 
  -     * <p>Returns the number of argument values this Option can take.</p>
  +     * Returns the number of argument values this Option can take.
        *
        * @return num the number of argument values
        */
  @@ -382,7 +386,7 @@
       }
   
       /**
  -     * <p>Adds the specified value to this Option.</p>
  +     * Adds the specified value to this Option.
        * 
        * @param value is a/the value of this Option
        */
  @@ -399,11 +403,11 @@
       }
   
       /**
  -     * <p>Processes the value.  If this Option has a value separator
  +     * Processes the value.  If this Option has a value separator
        * the value will have to be parsed into individual tokens.  When
        * n-1 tokens have been processed and there are more value separators
        * in the value, parsing is ceased and the remaining characters are
  -     * added as a single token.</p>
  +     * added as a single token.
        *
        * @param value The String to be processed.
        *
  @@ -449,10 +453,9 @@
       }
   
       /**
  -     * <p>Add the value to this Option.  If the number of arguments
  +     * Add the value to this Option.  If the number of arguments
        * is greater than zero and there is enough space in the list then
        * add the value.  Otherwise, throw a runtime exception.
  -     * </p>
        *
        * @param value The value to be added to this Option
        *
  @@ -557,7 +560,7 @@
       }
   
       /** 
  -     * <p>Dump state, suitable for debugging.</p>
  +     * Dump state, suitable for debugging.
        *
        * @return Stringified form of this object
        */
  
  
  
  1.20.2.4  +24 -17    jakarta-commons/cli/src/java/org/apache/commons/cli/Options.java
  
  Index: Options.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/Options.java,v
  retrieving revision 1.20.2.3
  retrieving revision 1.20.2.4
  diff -u -r1.20.2.3 -r1.20.2.4
  --- Options.java	30 Mar 2004 01:43:09 -0000	1.20.2.3
  +++ Options.java	14 Apr 2004 19:32:18 -0000	1.20.2.4
  @@ -53,14 +53,14 @@
       /** a map of the option groups */
       private Map optionGroups = new HashMap();
   
  -    /** <p>Construct a new Options descriptor</p>
  +    /** Construct a new Options descriptor
        */
       public Options()
       {
       }
   
       /**
  -     * <p>Add the specified option group.</p>
  +     * Add the specified option group.
        *
        * @param group the OptionGroup that is to be added
        * @return the resulting Options instance
  @@ -99,8 +99,9 @@
       	return new HashSet(optionGroups.values());
       }
   
  -    /** <p>Add an option that only contains a short-name</p>
  -     * <p>It may be specified as requiring an argument.</p>
  +    /** 
  +     * Add an option that only contains a short-name.
  +     * It may be specified as requiring an argument.
        *
        * @param opt Short single-character name of the option.
        * @param hasArg flag signally if an argument is required after this option
  @@ -114,8 +115,9 @@
           return this;
       }
   
  -    /** <p>Add an option that contains a short-name and a long-name</p>
  -     * <p>It may be specified as requiring an argument.</p>
  +    /** 
  +     * Add an option that contains a short-name and a long-name.
  +     * It may be specified as requiring an argument.
        *
        * @param opt Short single-character name of the option.
        * @param longOpt Long multi-character name of the option.
  @@ -132,7 +134,7 @@
       }
   
       /**
  -     * <p>Adds an option instance</p>
  +     * Adds an option instance
        *
        * @param opt the option that is to be added 
        * @return the resulting Options instance
  @@ -161,7 +163,8 @@
           return this;
       }
   
  -    /** <p>Retrieve a read-only list of options in this set</p>
  +    /** 
  +     * Retrieve a read-only list of options in this set
        *
        * @return read-only Collection of {@link Option} objects in this descriptor
        */
  @@ -171,7 +174,7 @@
       }
   
       /**
  -     * <p>Returns the Options for use by the HelpFormatter.</p>
  +     * Returns the Options for use by the HelpFormatter.
        *
        * @return the List of Options
        */
  @@ -196,8 +199,9 @@
           return new ArrayList(opts);
       }
   
  -    /** <p>Returns the required options as a 
  -     * <code>java.util.Collection</code>.</p>
  +    /** 
  +     * Returns the required options as a
  +     * <code>java.util.Collection</code>.
        *
        * @return Collection of required options
        */
  @@ -206,7 +210,8 @@
           return requiredOpts;
       }
   
  -    /** <p>Retrieve the named {@link Option}</p>
  +    /** 
  +     * Retrieve the named {@link Option}
        *
        * @param opt short or long name of the {@link Option}
        * @return the option represented by opt
  @@ -224,8 +229,8 @@
       }
   
       /** 
  -     * <p>Returns whether the named {@link Option} is a member
  -     * of this {@link Options}</p>
  +     * Returns whether the named {@link Option} is a member
  +     * of this {@link Options}.
        *
        * @param opt short or long name of the {@link Option}
        * @return true if the named {@link Option} is a member
  @@ -238,8 +243,9 @@
           return shortOpts.containsKey(opt) || longOpts.containsKey(opt);
       }
   
  -    /** <p>Returns the OptionGroup the <code>opt</code>
  -     * belongs to.</p>
  +    /** 
  +     * Returns the OptionGroup the <code>opt</code>
  +     * belongs to.
        * @param opt the option whose OptionGroup is being queried.
        *
        * @return the OptionGroup if <code>opt</code> is part
  @@ -250,7 +256,8 @@
           return (OptionGroup) optionGroups.get(opt.getKey());
       }
   
  -    /** <p>Dump state, suitable for debugging.</p>
  +    /** 
  +     * Dump state, suitable for debugging.
        *
        * @return Stringified form of this object
        */
  
  
  
  1.2.6.1   +1 -1      jakarta-commons/cli/src/java/org/apache/commons/cli/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/package.html,v
  retrieving revision 1.2
  retrieving revision 1.2.6.1
  diff -u -r1.2 -r1.2.6.1
  --- package.html	5 Nov 2002 22:37:53 -0000	1.2
  +++ package.html	14 Apr 2004 19:32:18 -0000	1.2.6.1
  @@ -1,6 +1,6 @@
   
   <body>
   
  -    <p>Commons CLI 1.0</p>
  +    Commons CLI 1.0
   
   </body>
  
  
  
  1.16.2.3  +30 -30    jakarta-commons/cli/src/java/org/apache/commons/cli/OptionBuilder.java
  
  Index: OptionBuilder.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/OptionBuilder.java,v
  retrieving revision 1.16.2.2
  retrieving revision 1.16.2.3
  diff -u -r1.16.2.2 -r1.16.2.3
  --- OptionBuilder.java	4 Feb 2004 02:01:50 -0000	1.16.2.2
  +++ OptionBuilder.java	14 Apr 2004 19:32:18 -0000	1.16.2.3
  @@ -62,7 +62,7 @@
       }
   
       /**
  -     * <p>Resets the member variables to their default values.</p>
  +     * Resets the member variables to their default values.
        */
       private static void reset()
       {
  @@ -80,7 +80,7 @@
       }
   
       /**
  -     * <p>The next Option created will have the following long option value.</p>
  +     * The next Option created will have the following long option value.
        *
        * @param longopt the long option value
        * @return the OptionBuilder instance
  @@ -93,7 +93,7 @@
       }
   
       /**
  -     * <p>The next Option created will require an argument value.</p>
  +     * The next Option created will require an argument value.
        *
        * @return the OptionBuilder instance
        */
  @@ -105,8 +105,8 @@
       }
   
       /**
  -     * <p>The next Option created will require an argument value if
  -     * <code>hasArg</code> is true.</p>
  +     * The next Option created will require an argument value if
  +     * <code>hasArg</code> is true.
        *
        * @param hasArg if true then the Option has an argument value
        * @return the OptionBuilder instance
  @@ -119,8 +119,8 @@
       }
   
       /**
  -     * <p>The next Option created will have the specified argument value 
  -     * name.</p>
  +     * The next Option created will have the specified argument value 
  +     * name.
        *
        * @param name the name for the argument value
        * @return the OptionBuilder instance
  @@ -133,7 +133,7 @@
       }
   
       /**
  -     * <p>The next Option created will be required.</p>
  +     * The next Option created will be required.
        *
        * @return the OptionBuilder instance
        */
  @@ -145,8 +145,8 @@
       }
   
       /**
  -     * <p>The next Option created uses <code>sep</code> as a means to
  -     * separate argument values.</p>
  +     * The next Option created uses <code>sep</code> as a means to
  +     * separate argument values.
        *
        * <b>Example:</b>
        * <pre>
  @@ -170,8 +170,8 @@
       }
   
       /**
  -     * <p>The next Option created uses '<code>=</code>' as a means to
  -     * separate argument values.</p>
  +     * The next Option created uses '<code>=</code>' as a means to
  +     * separate argument values.
        *
        * <b>Example:</b>
        * <pre>
  @@ -193,8 +193,8 @@
       }
   
       /**
  -     * <p>The next Option created will be required if <code>required</code>
  -     * is true.</p>
  +     * The next Option created will be required if <code>required</code>
  +     * is true.
        *
        * @param required if true then the Option is required
        * @return the OptionBuilder instance
  @@ -207,7 +207,7 @@
       }
   
       /**
  -     * <p>The next Option created can have unlimited argument values.</p>
  +     * The next Option created can have unlimited argument values.
        *
        * @return the OptionBuilder instance
        */
  @@ -219,8 +219,8 @@
       }
   
       /**
  -     * <p>The next Option created can have <code>num</code> 
  -     * argument values.</p>
  +     * The next Option created can have <code>num</code> 
  +     * argument values.
        *
        * @param num the number of args that the option can have
        * @return the OptionBuilder instance
  @@ -233,7 +233,7 @@
       }
   
       /**
  -     * <p>The next Option can have an optional argument.</p>
  +     * The next Option can have an optional argument.
        *
        * @return the OptionBuilder instance
        */
  @@ -246,8 +246,8 @@
       }
   
       /**
  -     * <p>The next Option can have an unlimited number of
  -     * optional arguments.</p>
  +     * The next Option can have an unlimited number of
  +     * optional arguments.
        *
        * @return the OptionBuilder instance
        */
  @@ -260,8 +260,8 @@
       }
   
       /**
  -     * <p>The next Option can have the specified number of 
  -     * optional arguments.</p>
  +     * The next Option can have the specified number of 
  +     * optional arguments.
        *
        * @param numArgs - the maximum number of optional arguments
        * the next Option created can have.
  @@ -276,8 +276,8 @@
       }
   
       /**
  -     * <p>The next Option created will have a value that will be an instance 
  -     * of <code>type</code>.</p>
  +     * The next Option created will have a value that will be an instance 
  +     * of <code>type</code>.
        *
        * @param type the type of the Options argument value
        * @return the OptionBuilder instance
  @@ -290,7 +290,7 @@
       }
   
       /**
  -     * <p>The next Option created will have the specified description</p>
  +     * The next Option created will have the specified description
        *
        * @param description a description of the Option's purpose
        * @return the OptionBuilder instance
  @@ -303,8 +303,8 @@
       }
   
       /**
  -     * <p>Create an Option using the current settings and with 
  -     * the specified Option <code>char</code>.</p>
  +     * Create an Option using the current settings and with 
  +     * the specified Option <code>char</code>.
        *
        * @param opt the character representation of the Option
        * @return the Option instance
  @@ -318,7 +318,7 @@
       }
   
       /**
  -     * <p>Create an Option using the current settings</p>
  +     * Create an Option using the current settings
        *
        * @return the Option instance
        * @throws IllegalArgumentException if <code>longOpt</code> has
  @@ -336,8 +336,8 @@
       }
   
       /**
  -     * <p>Create an Option using the current settings and with 
  -     * the specified Option <code>char</code>.</p>
  +     * Create an Option using the current settings and with 
  +     * the specified Option <code>char</code>.
        *
        * @param opt the <code>java.lang.String</code> representation 
        * of the Option
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message