[JEDI.NET-commits] docs Jedi.System.CommandLine.xml,1.5,1.6

[Marcel B. <jed...@us...>]

Update of /cvsroot/jedidotnet/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14679/docs

Modified Files:
	Jedi.System.CommandLine.xml 
Log Message:
* Various corrections of mismatched tags
* Added some more documentation (still not complete)

Index: Jedi.System.CommandLine.xml
===================================================================
RCS file: /cvsroot/jedidotnet/docs/Jedi.System.CommandLine.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** Jedi.System.CommandLine.xml	8 Mar 2005 10:34:39 -0000	1.5
--- Jedi.System.CommandLine.xml	12 Mar 2005 13:11:29 -0000	1.6
***************
*** 36,42 ****
      <remarks>
        <para>
!         A literal is considered to be anything that can't be seens a possible switch or option. The parser considers any
!         of the prefix characters as a possible switch, where only the first character of a prefix string with more than
!         one character is considered.
        </para>
        <para>
--- 36,45 ----
      <remarks>
        <para>
!         A literal is considered to be anything that can't be seen as a possible switch or option. The parser considers
!         any of the prefix characters as a possible switch, where only the first character of a prefix string with more
!         than one character is considered.
!       </para>
!       <para>
!         A literal can be enclosed in either a single quote (') or a double quote (").
        </para>
        <para>
***************
*** 69,74 ****
        </para>
        <para>
!         A <see langword="null" /> if the property or method is <see langword="static" /> to the
!         <see cref="T:System.Type" />.
        </para>
      </param>
--- 72,76 ----
        </para>
        <para>
!         A <see langword="null" /> if the property or method is <see langword="static" />.
        </para>
      </param>
***************
*** 79,84 ****
--- 81,89 ----
    <member name="P:Jedi.System.CommandLine.Argument.CaseSensitive">
      <summary>
+     	Indicates whether comparisons with this argument should be done case sensitive.
      </summary>
      <value>
+       <see langword="true" /> if the value in the <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> property
+       should be compared case sensitive; otherwise, <see langword="false" />.
      </value>
    </member>
***************
*** 93,179 ****
--- 98,319 ----
    <member name="P:Jedi.System.CommandLine.Argument.Instance">
      <summary>
+     	The instance to which this switch belongs.
      </summary>
      <value>
+       <para>
+         The instance to which the property or method for this switch belongs.
+       </para>
+       <para>
+         -or-
+       </para>
+       <para>
+         A <see langword="null" /> if the property or method is <see langword="static" />.
+       </para>
      </value>
    </member>
    <member name="P:Jedi.System.CommandLine.Argument.Matches">
      <summary>
+       Indicates the <see cref="T:System.String" /> to match on the command line.
      </summary>
      <value>
+       The <see cref="T:System.String" /> to match on the command line. This will be the concatenation of the prefix,
+       name and value separator strings specified by the <see cref="T:Jedi.System.CommandLineArgumentAttribute" />
+       attribute.
      </value>
    </member>
    <member name="P:Jedi.System.CommandLine.Argument.MemberInfo">
      <summary>
+       Indicates the method or property this switch is linked to.
      </summary>
      <value>
+       <para>
+         A <see cref="T:System.Reflection.PropertyInfo" /> representing the property this switch is linked to.
+       </para>
+       <para>
+         -or-
+       </para>
+       <para>
+         A <see cref="T:System.Reflection.MethodInfo" /> representing the method this switch is linked to.
+       </para>
      </value>
    </member>
    <member name="M:Jedi.System.CommandLine.Argument.Process(System.String,System.Int32@)">
      <summary>
+       Processes the argument.
      </summary>
      <param name="commandLine">
+       The command line being parsed.
      </param>
      <param name="index">
+       <para>
+         Upon entry, the index where the switch was detected.
+       </para>
+       <para>
+         Upon exit, the index where the next switch or literal can be found (any spaces following this switch are
+         skipped).
+       </para>
      </param>
+     <remarks>
+       This method is called by the <see cref="T:Jedi.System.CommandLine">command line parser</see> when the switch
+       specified by the <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> was found. The method will delegate
+       processing to either the linked method or handle set the property to the correct value.
+     </remarks>
    </member>
    <member name="M:Jedi.System.CommandLine.Argument.ProcessBoolean(System.String,System.String,System.Int32@)">
      <summary>
+     	Processes the argument as a boolean.
      </summary>
      <param name="match">
+       The match string of the argument as found on the command line. This can differ in case only from the
+       <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> property.
      </param>
      <param name="commandLine">
+       The command line being parsed.
      </param>
      <param name="index">
+       <para>
+         Upon entry, the index where the optional + or - operand should be.
+       </para>
+       <para>
+         Upon exit, the index where the next switch or literal can be found (any spaces following this switch are
+         skipped).
+       </para>
      </param>
+     <remarks>
+       <para>
+         This method is called for a property of the type <see cref="T:System.Boolean" />. It will look for a plus, minus
+         or space character.
+       </para>
+       <para>
+         If a plus (+) character is detected, the linked property will be set to <see langword="true" />. The minus (-)
+         character will set the property to <see langword="false" />. The space character will toggle the property.
+       </para>
+       <exception cref="T:Jedi.System.CommandLineException">
+         The first character after the switch is invalid (ie. it is not a plus (+), minus (-) or space character).
+       </exception>
+     </remarks>
    </member>
    <member name="M:Jedi.System.CommandLine.Argument.ProcessInt(System.String,System.String,System.Int32@)">
      <summary>
+     	Processes the argument as an integer type.
      </summary>
      <param name="match">
+       The match string of the argument as found on the command line. This can differ in case only from the
+       <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> property.
      </param>
      <param name="commandLine">
+       The command line being parsed.
      </param>
      <param name="index">
+       <para>
+         Upon entry, the index where the integer operand should be.
+       </para>
+       <para>
+         Upon exit, the index where the next switch or literal can be found (any spaces following this switch are
+         skipped).
+       </para>
      </param>
+     <remarks>
+       <para>
+       	This method is called for a property of any integer type (<see cref="T:System.Int16" />),
+         <see cref="T:System.Int32" />), <see cref="T:System.Int64" />)). It will use the property type's Parse
+         method to parse the operand text as a string.
+       </para>
+       <para>
+         Because it uses the actual Parse method of the integer type of the property, parsing is limited to the format
+         allowed by the various Parse methods. The Parse method of the type will be called with the
+         <see cref="F:System.Globalization.NumberFormatInfo.InvariantInfo" /> and
+         <see cref="F:System.Globalization.CultureInfo.InvariantCulture" /> arguments.
+       </para>
+     </remarks>
    </member>
    <member name="M:Jedi.System.CommandLine.Argument.ProcessString(System.String,System.String,System.Int32@)">
      <summary>
+       Processes the argument as a string type.
      </summary>
      <param name="match">
+       The match string of the argument as found on the command line. This can differ in case only from the
+       <see cref="P:Jedi.System.CommandLine.Argument.Matches" /> property.
      </param>
      <param name="commandLine">
+       The command line being parsed.
      </param>
      <param name="index">
+       <para>
+         Upon entry, the index where the string operand should be.
+       </para>
+       <para>
+         Upon exit, the index where the next switch or literal can be found (any spaces following this switch are
+         skipped).
+       </para>
      </param>
    </member>
    <member name="M:Jedi.System.CommandLine.CheckAndProcessArgument(System.String,System.Int32@)">
      <summary>
+       Checks the command line for a switch and processes it if found.
      </summary>
      <param name="commandLine">
+       The command line being parsed.
      </param>
      <param name="index">
+       <para>
+         Upon entry, the index to check for a response file argument.
+       </para>
+       <para>
+         Upon exit, unchanged if the current argument did not start with one of the switch starting characters;
+         otherwise, the index to the start of the next argument.
+       </para>
      </param>
      <returns>
+       <see langword="true" /> if the current argument was a registered switch; otherwise, <see langword="false" />.
      </returns>
+     <exception cref="T:Jedi.System.CommandLineException">
+       The command line encountered an unknown switch (one that started with a switch starting character but did not
+       match).
+     </exception>
    </member>
    <member name="M:Jedi.System.CommandLine.CheckAndProcessResponseFile(System.String,System.Int32@)">
      <summary>
+       Checks the command line for a response file argument and processes it if found.
      </summary>
      <param name="commandLine">
+       The command line being parsed.
      </param>
      <param name="index">
+       <para>
+         Upon entry, the index to check for a response file argument.
+       </para>
+       <para>
+         Upon exit, unchanged if the current argument wasn't a response file argument; otherwise, the index to the start
+         of the next argument.
+       </para>
      </param>
      <returns>
+       <see langword="true" /> if the current argument was a response file argument; otherwise, <see langword="false" />.
      </returns>
    </member>
    <member name="M:Jedi.System.CommandLine.GetLiteral(System.String,System.Int32@)">
      <summary>
+       Retrieves a literal string.
      </summary>
      <param name="commandLine">
+       The command line to retrieve the string from.
      </param>
      <param name="index">
+       <para>
+         Upon entry, the index to start retrieving from.
+       </para>
+       <para>
+         Upon exit, the index to the start of the next argument.
+       </para>
      </param>
      <returns>
+       A <see cref="T:System.String" /> equivalent to the string found in the <paramref name="commandLine" /> parameter.
      </returns>
+     <remarks>
+       The string can be quoted following the rules of the
+       <see cref="M:Jedi.System.StringUtils.ExtractQuotedString(System.String,System.Int32@)" /> method and parsing
+       doesn't stop until the first unquoted space character.
+     </remarks>
    </member>
    <member name="M:Jedi.System.CommandLine.GetLiterals">
***************
*** 185,232 ****
--- 325,405 ----
    <member name="M:Jedi.System.CommandLine.Parse(System.Object[])">
      <overloads>
+       <summary>
+         Parses the command line.
+       </summary>
+       <remarks>
+         <para>
+           The array contains the instances and/or types to scan for properties and/or methods decorated with the
+           <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute. The switches found will be matched with
+           the command line and the results stored in the specified properties.
+         </para>
+       </remarks>
      </overloads>
      <summary>
+       Parses the command line returned by <see cref="M:System.Environment.GetCommandLine" />.
      </summary>
      <param name="arguments">
+       List of instances and/or types to scan for properties and methods decorated with the
+       <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute.
      </param>
      <returns>
+       A list of <see cref="T:System.String" /> found on the command line that could not be switches.
      </returns>
    </member>
    <member name="M:Jedi.System.CommandLine.Parse(System.Object[],System.String)">
      <summary>
+       Parses the command line returned by <see cref="M:System.Environment.GetCommandLine" />. Also parses the response
+       files specified in the command line.
      </summary>
      <param name="arguments">
+       List of instances and/or types to scan for properties and methods decorated with the
+       <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute.
      </param>
      <param name="responseFilePrefix">
+       Prefix used to indicate response files.
      </param>
      <returns>
+       A list of <see cref="T:System.String" /> found on the command line that could not be switches or a response file.
      </returns>
    </member>
    <member name="M:Jedi.System.CommandLine.Parse(System.String,System.Object[])">
      <summary>
+       Parses the specified command line.
      </summary>
      <param name="commandLine">
+       The command line to parse. The first argument is considered to be the process name and will be ignored.
      </param>
      <param name="arguments">
+       List of instances and/or types to scan for properties and methods decorated with the
+       <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute.
      </param>
      <returns>
+       A list of <see cref="T:System.String" /> found on the command line that could not be switches.
      </returns>
    </member>
    <member name="M:Jedi.System.CommandLine.Parse(System.String,System.Object[],System.String)">
      <summary>
+       Parses the specified command line. Also parses the response files specified in the command line.
      </summary>
      <param name="commandLine">
+       The command line to parse. The first argument is considered to be the process name and will be ignored.
      </param>
      <param name="arguments">
+       List of instances and/or types to scan for properties and methods decorated with the
+       <see cref="T:Jedi.System.CommandLineArgumentAttribute" /> attribute.
      </param>
      <param name="responseFilePrefix">
+       Prefix used to indicate response files.
      </param>
      <returns>
+       A list of <see cref="T:System.String" /> found on the command line that could not be switches or a response file.
      </returns>
    </member>
    <member name="M:Jedi.System.CommandLine.ParseImpl(System.String)">
      <summary>
+       Parses the specified command line.
      </summary>
      <param name="commandLine">
+       The command line to parse.
      </param>
    </member>