[JEDI.NET-commits] docs Jedi.System.CommandLine.xml,1.4,1.5 Jedi.System.Strings.xml,1.7,1.8

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

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

Modified Files:
	Jedi.System.CommandLine.xml Jedi.System.Strings.xml 
Log Message:
Obviously, the tool's member translation doesn't work correctly yet.

Index: Jedi.System.Strings.xml
===================================================================
RCS file: /cvsroot/jedidotnet/docs/Jedi.System.Strings.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** Jedi.System.Strings.xml	8 Mar 2005 10:14:46 -0000	1.7
--- Jedi.System.Strings.xml	8 Mar 2005 10:34:39 -0000	1.8
***************
*** 262,286 ****
--- 262,319 ----
    <member name="M:Jedi.System.StringUtils.BinToInt(System.String,System.Int32,System.Boolean,System.Int32@)">
      <summary>
+       Converts a string to an integer from its binary representation, only taking the first
+       <paramref name="maxDigits" /> characters in account, optionally ignoring leading 0 characters and returning
+       the number of digits actually used.
      </summary>
      <param name="s">
+       A <see cref="T:System.String" /> containing a binary representation of an integer value.
      </param>
      <param name="maxDigits">
+       The maximum number of digits to consider for conversion.
      </param>
      <param name="ignoreLeadingZeros">
+       Ignore leading <c>0</c> characters when determining the number of digits to consider. If set to
+       <see langword="true" />, the <paramref name="maxDigits" /> parameter refers to the number of digits following
+       any leading <c>0</c> characters.
      </param>
      <param name="digitsUsed">
+       An <see cref="T:System.Int32" /> variable to receive the number of digits processed during the conversion. This
+       number includes any leading <c>0</c> characters if <paramref name="ignoreLeadingZeros" /> is set to
+       <see langword="true" />.
      </param>
      <returns>
+       An <see cref="T:System.Int32" /> equivalent to the binary version specified in the <paramref name="s" /> parameter.
      </returns>
+     <remarks>
+       The method will consider a number completely parsed when it
+       <list type="bullet">
+         <item>has reached the end of the string.</item>
+         <item>reads an invalid character.</item>
+         <item>has read the number of characters specified by the <paramref name="maxDigits" />.</item>
+       </list>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.BinToInt(System.String,System.Int32@)">
      <summary>
+       Converts a string to an integer from its binary representation, additionally returning the number of digits
+       used.
      </summary>
      <param name="s">
+       A <see cref="T:System.String" /> containing a binary representation of an integer value.
      </param>
      <param name="digitsUsed">
+       An <see cref="T:System.Int32" /> variable to receive the number of digits processed during the conversion.
      </param>
      <returns>
+       An <see cref="T:System.Int32" /> equivalent to the binary version specified in the <paramref name="s" /> parameter.
      </returns>
+     <remarks>
+       The method will consider a number completely parsed when it
+       <list type="bullet">
+         <item>has reached the end of the string.</item>
+         <item>reads an invalid character.</item>
+         <item>has read 32 characters.</item>
+       </list>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.EscapeString(System.String)">
***************
*** 532,542 ****
--- 565,613 ----
    <member name="M:Jedi.System.StringUtils.ExtractQuotedString(System.String,System.Int32@)">
      <summary>
+       Extracts a quoted string, returning the index of the last used character in the process.
      </summary>
      <param name="s">
+       A quoted string.
      </param>
      <param name="lastUsedChar">
+       On return of this method, this parameter will indicate the last used character in the extraction process. See
+       the remarks section for more information.
      </param>
      <returns>
+       A <see cref="T:System.String" /> which is the dequoted equivalent of the string in the <paramref name="s" />
+       parameter.
      </returns>
+     <remarks>
+       <para>
+         A quoted string should start and end with a <b>'</b> or <b>"</b> character (the start and end quote should be
+         the same). In addition, every occurance of the used quote character in the original string will have been
+         doubled.
+       </para>
+       <para>
+         If the string specified in the <paramref name="s" /> parameter does not start with either of the quote
+         characters, the entire string will be returned instead.
+       </para>
+       <para>
+         The extraction ends at the first single occurance of the starting quote character, thus ignoring the remainer
+         of the original string.
+       </para>
+       <para>
+         The lastUseChar parameter will contain the following value upon return:
+         <list type="table">
+           <listheader>
+             <term>Value range</term>
+             <description>Description</description>
+           </listheader>
+           <item>
+             <term>0 &lt;= lastUsedChar &lt; s.Length</term>
+             <description>The ending quote was found at this location in the string and processing stopped.</description>
+           </item>
+           <item>
+             <term>Ones complement of s.Length</term>
+             <description>No ending quote was found, but the entire string was used.</description>
+           </item>
+         </list>
+       </para>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.HexToInt(System.String)">
***************
*** 584,608 ****
--- 655,714 ----
    <member name="M:Jedi.System.StringUtils.HexToInt(System.String,System.Int32,System.Boolean,System.Int32@)">
      <summary>
+       Converts a string to an integer from its hexadecimal representation, only taking the first
+       <paramref name="maxDigits" /> characters in account, optionally ignoring leading 0 characters and returning
+       the number of digits actually used.
      </summary>
      <param name="s">
+       A <see cref="T:System.String" /> containing a hexadecimal representation of an integer value.
      </param>
      <param name="maxDigits">
+       The maximum number of digits to consider for conversion.
      </param>
      <param name="ignoreLeadingZeros">
+       Ignore leading <c>0</c> characters when determining the number of digits to consider. If set to
+       <see langword="true" />, the <paramref name="maxDigits" /> parameter refers to the number of digits following
+       any leading <c>0</c> characters.
      </param>
      <param name="digitsUsed">
+       An <see cref="T:System.Int32" /> variable to receive the number of digits processed during the conversion. This
+       number includes any leading <c>0</c> characters if <paramref name="ignoreLeadingZeros" /> is set to
+       <see langword="true" />.
      </param>
      <returns>
+       An <see cref="T:System.Int32" /> equivalent to the hexadecimal version specified in the <paramref name="s" />
+       parameter.
      </returns>
+     <remarks>
+       The method will consider a number completely parsed when it
+       <list type="bullet">
+         <item>has reaches the end of the string.</item>
+         <item>reads an invalid character.</item>
+         <item>has read the number of characters specified by the <paramref name="maxDigits" />.</item>
+       </list>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.HexToInt(System.String,System.Int32@)">
      <summary>
+       Converts a string to an integer from its hexadecimal representation, additionally returning the number of digits
+       used.
      </summary>
      <param name="s">
+       A <see cref="T:System.String" /> containing a hexadecimal representation of an integer value.
      </param>
      <param name="digitsUsed">
+       An <see cref="T:System.Int32" /> variable to receive the number of digits processed during the conversion.
      </param>
      <returns>
+       An <see cref="T:System.Int32" /> equivalent to the hexadecimal version specified in the <paramref name="s" />
+       parameter.
      </returns>
+     <remarks>
+       The method will consider a number completely parsed when it
+       <list type="bullet">
+         <item>has reached the end of the string.</item>
+         <item>reads an invalid character.</item>
+         <item>has read 8 characters.</item>
+       </list>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.IntBaseToStringImpl(System.Int32,System.Int32,System.Int32)">
***************
*** 865,889 ****
--- 971,1030 ----
    <member name="M:Jedi.System.StringUtils.OctToInt(System.String,System.Int32,System.Boolean,System.Int32@)">
      <summary>
+       Converts a string to an integer from its octal representation, only taking the first
+       <paramref name="maxDigits" /> characters in account, optionally ignoring leading 0 characters and returning
+       the number of digits actually used.
      </summary>
      <param name="s">
+       A <see cref="T:System.String" /> containing an octal representation of an integer value.
      </param>
      <param name="maxDigits">
+       The maximum number of digits to consider for conversion.
      </param>
      <param name="ignoreLeadingZeros">
+       Ignore leading <c>0</c> characters when determining the number of digits to consider. If set to
+       <see langword="true" />, the <paramref name="maxDigits" /> parameter refers to the number of digits following
+       any leading <c>0</c> characters.
      </param>
      <param name="digitsUsed">
+       An <see cref="T:System.Int32" /> variable to receive the number of digits processed during the conversion. This
+       number includes any leading <c>0</c> characters if <paramref name="ignoreLeadingZeros" /> is set to
+       <see langword="true" />.
      </param>
      <returns>
+       An <see cref="T:System.Int32" /> equivalent to the octal version specified in the <paramref name="s" />
+       parameter.
      </returns>
+     <remarks>
+       The method will consider a number completely parsed when it
+       <list type="bullet">
+         <item>has reaches the end of the string.</item>
+         <item>reads an invalid character.</item>
+         <item>has read the number of characters specified by the <paramref name="maxDigits" />.</item>
+       </list>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.OctToInt(System.String,System.Int32@)">
      <summary>
+       Converts a string to an integer from its octal representation, additionally returning the number of digits
+       used.
      </summary>
      <param name="s">
+       A <see cref="T:System.String" /> containing an octal representation of an integer value.
      </param>
      <param name="digitsUsed">
+       An <see cref="T:System.Int32" /> variable to receive the number of digits processed during the conversion.
      </param>
      <returns>
+       An <see cref="T:System.Int32" /> equivalent to the octal version specified in the <paramref name="s" />
+       parameter.
      </returns>
+     <remarks>
+       The method will consider a number completely parsed when it
+       <list type="bullet">
+         <item>has reached the end of the string.</item>
+         <item>reads an invalid character.</item>
+         <item>has read 11 characters.</item>
+       </list>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.ParseEscapedString(System.String)">
***************
*** 921,937 ****
--- 1062,1097 ----
    <member name="M:Jedi.System.StringUtils.ParseIntBaseImpl(System.String,System.Int32,System.Int32,System.Boolean,System.Int32@)">
      <summary>
+       Parses a string for an integer in a particular base.
      </summary>
      <param name="s">
+       A <see cref="T:System.String" /> to parse for an integer in any base.
      </param>
      <param name="base">
+       The base in which the integer in the string is.
      </param>
      <param name="maxDigits">
+       The maximum number of digits to consider.
      </param>
      <param name="ignoreLeadingZeros">
+       Ignore leading <c>0</c> characters when determining the number of digits to consider. If set to
+       <see langword="true" />, the <paramref name="maxDigits" /> parameter refers to the number of digits following
+       any leading <c>0</c> characters.
      </param>
      <param name="digitsUsed">
+       An <see cref="T:System.Int32" /> variable to receive the number of digits processed during the conversion. This
+       number includes any leading <c>0</c> characters if <paramref name="ignoreLeadingZeros" /> is set to
+       <see langword="true" />.
      </param>
      <returns>
+       An <see cref="T:System.Int32" /> equivalent to the value specified in the <paramref name="s" /> parameter.
      </returns>
+     <remarks>
+       The method will consider a number completely parsed when it
+       <list type="bullet">
+         <item>has reached the end of the string.</item>
+         <item>reads an invalid character.</item>
+         <item>has read the number of characters specified by the <paramref name="maxDigits" />.</item>
+       </list>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.QuoteString(System.String)">

Index: Jedi.System.CommandLine.xml
===================================================================
RCS file: /cvsroot/jedidotnet/docs/Jedi.System.CommandLine.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** Jedi.System.CommandLine.xml	8 Mar 2005 10:14:46 -0000	1.4
--- Jedi.System.CommandLine.xml	8 Mar 2005 10:34:39 -0000	1.5
***************
*** 20,28 ****
--- 20,47 ----
    <member name="M:Jedi.System.CommandLine.AddLiteral(System.String,System.Int32@)">
      <summary>
+       Adds a literal command line argument to the list of literals.
      </summary>
      <param name="commandLine">
+       The complete command line.
      </param>
      <param name="index">
+       <para>
+         Upon entry to the method, points to the 0-based index into the <paramref name="commandLine" /> parameter at
+         which the literal starts.
+       </para>
+       <para>
+         Upon leaving the method, the index should be pointing to the next argument.
+       </para>
      </param>
+     <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>
+         The list of literals is returned by any of the <see cref="M:Jedi.System.CommandLine.Parse" /> methods.
+       </para>
+     </remarks>
    </member>
    <member name="T:Jedi.System.CommandLine.Argument">