[JEDI.NET-commits] docs Jedi.System.Strings.xml,1.2,1.3

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

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

Modified Files:
	Jedi.System.Strings.xml 
Log Message:
Completed documentation

Index: Jedi.System.Strings.xml
===================================================================
RCS file: /cvsroot/jedidotnet/docs/Jedi.System.Strings.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Jedi.System.Strings.xml	3 Mar 2005 14:32:14 -0000	1.2
--- Jedi.System.Strings.xml	3 Mar 2005 20:52:29 -0000	1.3
***************
*** 228,237 ****
      </summary>
      <param name="s">
!     	A <see cref="T:System.String" /> contain a binary representation of an integer value. It will stop reading after
!     	either 32 characters or the first one that is not a 0 or 1, whichever comes first.
      </param>
      <returns>
      	An <see cref="System.Int32" /> equivalent to the binary version specified in the <paramref name="s" /> parameter.
      </returns>
    </member>
    <member name="M:Jedi.System.StringUtils.BinToInt(System.String,System.Int32,System.Boolean)">
--- 228,244 ----
      </summary>
      <param name="s">
!     	A <see cref="T:System.String" /> containing a binary representation of an integer value.
      </param>
      <returns>
      	An <see cref="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.BinToInt(System.String,System.Int32,System.Boolean)">
***************
*** 241,246 ****
      </summary>
      <param name="s">
!     	A <see cref="T:System.String" /> contain a binary representation of an integer value. It will stop reading after
!     	either 32 characters or the first one that is not a 0 or 1, whichever comes first.
      </param>
      <param name="maxDigits">
--- 248,252 ----
      </summary>
      <param name="s">
!     	A <see cref="T:System.String" /> containing a binary representation of an integer value.
      </param>
      <param name="maxDigits">
***************
*** 255,258 ****
--- 261,272 ----
      	An <see cref="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,System.Boolean,System.Int32@)">
***************
*** 263,268 ****
      </summary>
      <param name="s">
!     	A <see cref="T:System.String" /> contain a binary representation of an integer value. It will stop reading after
!     	either 32 characters or the first one that is not a 0 or 1, whichever comes first.
      </param>
      <param name="maxDigits">
--- 277,281 ----
      </summary>
      <param name="s">
!     	A <see cref="T:System.String" /> containing a binary representation of an integer value.
      </param>
      <param name="maxDigits">
***************
*** 282,294 ****
      	An <see cref="System.Int32" /> equivalent to the binary version specified in the <paramref name="s" /> parameter.
      </returns>
    </member>
    <member name="M:Jedi.System.StringUtils.BinToInt(System.String,System.Int32@)">
      <summary>
!     	Converts a string to an integer from its binary representation, additionallu returning the number of digits
      	used.
      </summary>
      <param name="s">
!     	A <see cref="T:System.String" /> contain a binary representation of an integer value. It will stop reading after
!     	either 32 characters or the first one that is not a 0 or 1, whichever comes first.
      </param>
      <param name="digitsUsed">
--- 295,314 ----
      	An <see cref="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">
***************
*** 298,301 ****
--- 318,329 ----
      	An <see cref="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)">
***************
*** 676,816 ****
--- 704,993 ----
    </member>
    <member name="M:Jedi.System.StringUtils.HexToInt(System.String)">
+   	<overloads>
+     	Converts a string to an integer from its hexadecimal representation.
+   	</overloads>
      <summary>
+     	Converts a string to an integer from its hexadecimal representation.
      </summary>
      <param name="s">
+     	A <see cref="T:System.String" /> containing a hexadecimal representation of an integer value.
      </param>
      <returns>
+     	An <see cref="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.HexToInt(System.String,System.Int32,System.Boolean)">
      <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.
      </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>
      <returns>
+     	An <see cref="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 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,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="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="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)">
      <summary>
+     	Converts an integer to a string in any base.
      </summary>
      <param name="value">
+     	The value to convert to a string.
      </param>
      <param name="base">
+     	The base to which the value should be converted.
      </param>
      <param name="minDigits">
+     	The minimun number of digits needed. If the conversion leads to less digits than this, the value is padded to the
+     	left with zeroes.
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter transposed into the base
+     	given by the <paramref name="base" /> parameter.
      </returns>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToBin(System.Int32)">
+   	<overloads>
+   		Converts an integer into a binary string representation.
+   	</overloads>
      <summary>
+   		Converts an integer into a binary string representation.
      </summary>
      <param name="value">
+     	The value to convert to a binary string representation.
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to a binary
+     	representation.
      </returns>
+     <remarks>
+     	<para>
+     		A call to this overloaded version is similar to
+     		<c><see cref="M:Jedi.System.StringUtils.IntToBin(System.Int32,System.Int32)">IntToBin(<paramref name="value" />, 1)</see></c>.
+     	</para>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToBin(System.Int32,System.Boolean)">
      <summary>
+   		Converts an integer into a binary string representation, optionally padded to the nearest word size.
      </summary>
      <param name="value">
+     	The value to convert to a binary string representation.
      </param>
      <param name="padToShortestByteSize">
+     	If set to <see langword="true" />, the resulting string will be padded to the left with zeroes to the shortest
+     	word size the value can be represented in (8, 16 or 32 bits).
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to a binary
+     	representation.
      </returns>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToBin(System.Int32,System.Int32)">
      <summary>
+   		Converts an integer into a binary string representation padded to a specified number of digits.
      </summary>
      <param name="value">
+     	The value to convert to a binary string representation.
      </param>
      <param name="minimumDigits">
+     	The minimum number of digits required. If the resulting string is shorter, it will be padded to the left with
+     	zeroes.
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to a binary
+     	representation.
      </returns>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToHex(System.Int32)">
+   	<overloads>
+   		Converts an integer into a hexadecimal string representation.
+   	</overloads>
      <summary>
+   		Converts an integer into a hexadecimal string representation.
      </summary>
      <param name="value">
+     	The value to convert to a hexadecimal string representation.
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to a hexadecimal
+     	representation.
      </returns>
+     <remarks>
+     	<para>
+     		A call to this overloaded version is similar to
+     		<c><see cref="M:Jedi.System.StringUtils.IntToHex(System.Int32,System.Int32)">IntToHex(<paramref name="value" />, 1)</see></c>.
+     	</para>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToHex(System.Int32,System.Boolean)">
      <summary>
+   		Converts an integer into a hexadecimal string representation, optionally padded to the nearest word size.
      </summary>
      <param name="value">
+     	The value to convert to a hexadecimal string representation.
      </param>
      <param name="padToShortestByteSize">
+     	If set to <see langword="true" />, the resulting string will be padded to the left with zeroes to the shortest
+     	word size the value can be represented in (2, 4 or 8 digits).
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to a hexadecimal
+     	representation.
      </returns>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToHex(System.Int32,System.Int32)">
      <summary>
+   		Converts an integer into a hexadecimal string representation padded to a specified number of digits.
      </summary>
      <param name="value">
+     	The value to convert to a hexadecimal string representation.
      </param>
      <param name="minimumDigits">
+     	The minimum number of digits required. If the resulting string is shorter, it will be padded to the left with
+     	zeroes.
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to a hexadecimal
+     	representation.
      </returns>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToOct(System.Int32)">
+   	<overloads>
+   		Converts an integer into an octal string representation.
+   	</overloads>
      <summary>
+   		Converts an integer into an octal string representation.
      </summary>
      <param name="value">
+     	The value to convert to an octal string representation.
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to an octal
+     	representation.
      </returns>
+     <remarks>
+     	<para>
+     		A call to this overloaded version is similar to
+     		<c><see cref="M:Jedi.System.StringUtils.IntToOct(System.Int32,System.Int32)">IntToOct(<paramref name="value" />, 1)</see></c>.
+     	</para>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToOct(System.Int32,System.Boolean)">
      <summary>
+   		Converts an integer into an octal string representation, optionally padded to the nearest word size.
      </summary>
      <param name="value">
+     	The value to convert to an octal string representation.
      </param>
      <param name="padToShortestByteSize">
+     	If set to <see langword="true" />, the resulting string will be padded to the left with zeroes to the shortest
+     	word size the value can be represented in (3, 6 or 12 digits).
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to an octal
+     	representation.
      </returns>
    </member>
    <member name="M:Jedi.System.StringUtils.IntToOct(System.Int32,System.Int32)">
      <summary>
+   		Converts an integer into an octal string representation padded to a specified number of digits.
      </summary>
      <param name="value">
+     	The value to convert to an octal string representation.
      </param>
      <param name="minimumDigits">
+     	The minimum number of digits required. If the resulting string is shorter, it will be padded to the left with
+     	zeroes.
      </param>
      <returns>
+     	A <see cref="T:System.String" /> equivalent to the <paramref name="value" /> parameter converted to an octal
+     	representation.
      </returns>
    </member>
***************
*** 853,898 ****
--- 1030,1142 ----
    </member>
    <member name="M:Jedi.System.StringUtils.OctToInt(System.String)">
+   	<overloads>
+     	Converts a string to an integer from its octal representation.
+   	</overloads>
      <summary>
+     	Converts a string to an integer from its octal representation.
      </summary>
      <param name="s">
+     	A <see cref="T:System.String" /> contain a octal representation of an integer value.
      </param>
      <returns>
+     	An <see cref="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 12 characters.</item>
+     	</list>
+     </remarks>
    </member>
    <member name="M:Jedi.System.StringUtils.OctToInt(System.String,System.Int32,System.Boolean)">
      <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.
      </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>
      <returns>
+     	An <see cref="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 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,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="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="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)">
***************
*** 982,998 ****
--- 1226,1261 ----
    <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="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)">