[JEDI.NET-commits] docs Jedi.System.Strings.xml,1.1,1.2
Status: Pre-Alpha
Brought to you by:
jedi_mbe
Menu
▾
▴
[JEDI.NET-commits] docs Jedi.System.Strings.xml,1.1,1.2
|
From: Marcel B. <jed...@us...> - 2005-03-03 14:32:24
|
Update of /cvsroot/jedidotnet/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28089/docs Modified Files: Jedi.System.Strings.xml Log Message: Updated documentation a bit. Index: Jedi.System.Strings.xml =================================================================== RCS file: /cvsroot/jedidotnet/docs/Jedi.System.Strings.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** Jedi.System.Strings.xml 2 Mar 2005 16:59:37 -0000 1.1 --- Jedi.System.Strings.xml 3 Mar 2005 14:32:14 -0000 1.2 *************** *** 221,293 **** --- 221,474 ---- </member> <member name="M:Jedi.System.StringUtils.BinToInt(System.String)"> + <overloads> + Converts a string to an integer from its binary representation. + </overloads> <summary> + Converts a string to an integer from its binary representation. </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)"> <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. </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"> + 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 binary version specified in the <paramref name="s" /> parameter. </returns> </member> <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" /> 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"> + 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 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"> + 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 binary version specified in the <paramref name="s" /> parameter. </returns> </member> <member name="M:Jedi.System.StringUtils.EscapeString(System.String)"> + <overloads> + Performs C-style escaping on a string. + </overloads> <summary> + Performs C-style escaping on a string on all the standard characters. </summary> <param name="s"> + The A <see cref="T:System.String" /> on which to perform C-style escaping. </param> <returns> + A <see cref="T:System.String" /> equivalent to the one specified by the <paramref name="s" /> parameter, but with + all characters with an ordinal value < 32 (the space character) as well as the <c>\</c> (backslash) character + escaped. </returns> + <remarks> + <para> + Like in C, a number of characters have a special escape sequence. For all non-printable characters (anything + before the space character in the ASCII table) not specified in that list, the character will be replaced with + <c>\x<i>ordinal value of the character in hexadecimal</i></c>. For all printable characters (including the + backslash (<c>\</c>), the escape sequence will be <c>\<i>character</i></c>. + </para> + <para> + The following characters are treated as specialized escape sequences: + <list type="table"> + <listheader> + <term>Character</term> + <description>Escape sequence</description> + </listheader> + <item> + <term>NUL (0, Null)</term> + <description> + <para> + <c>\0</c> + </para> + <para> + -or- + </para> + <para> + <c>\000</c> (this is only the case if the NULL character is followed by a digit in the range + <c>0</c>..<c>7</c>, since the resulting escape sequence could be considered an octal value. + </para> + </description> + </item> + <item> + <term>BEL (7, Bell)</term> + <description>\a</description> + </item> + <item> + <term>BS (8, Backspace)</term> + <description>\b</description> + </item> + <item> + <term>TAB (9, Horizontal tab)</term> + <description><c>\t</c></description> + </item> + <item> + <term>LF/NL (10, Line Feed/New Line)</term> + <description><c>\n</c></description> + </item> + <item> + <term>VT (11, Vertical Tab)</term> + <description><c>\v</c></description> + </item> + <item> + <term>FF/NP (12, Form Feed, New Page)</term> + <description><c>\f</c></description> + </item> + <item> + <term>CR (13, Carriage Return)</term> + <description><c>\r</c></description> + </item> + </list> + </para> + </remarks> </member> <member name="M:Jedi.System.StringUtils.EscapeString(System.String,System.Char[])"> <summary> + Performs C-style escaping on a string on all the standard characters as well as the specified characters. </summary> <param name="s"> + The A <see cref="T:System.String" /> on which to perform C-style escaping. </param> <param name="escapeCharacters"> + A list of <see cref="T:System.Char" />, specifying additional characters to escape, besides the default ones. It's + not an error to specify one of the default characters in this list. </param> <returns> + A <see cref="T:System.String" /> equivalent to the one specified by the <paramref name="s" /> parameter, but with + all characters with an ordinal value < 32 (the space character) as well as the <c>\</c> (backslash) character + and any character specified in the <paramref name="escapeCharacters" /> escaped. </returns> + <remarks> + <para> + Like in C, a number of characters have a special escape sequence. For all non-printable characters (anything + before the space character in the ASCII table) not specified in that list, the character will be replaced with + <c>\x<i>ordinal value of the character in hexadecimal</i></c>. For all printable characters (including the + backslash (<c>\</c>), the escape sequence will be <c>\<i>character</i></c>. + </para> + <para> + The following characters are treated as specialized escape sequences: + <list type="table"> + <listheader> + <term>Character</term> + <description>Escape sequence</description> + </listheader> + <item> + <term>NUL (0, Null)</term> + <description> + <para> + <c>\0</c> + </para> + <para> + -or- + </para> + <para> + <c>\000</c> (this is only the case if the NULL character is followed by a digit in the range + <c>0</c>..<c>7</c>, since the resulting escape sequence could be considered an octal value. + </para> + </description> + </item> + <item> + <term>BEL (7, Bell)</term> + <description>\a</description> + </item> + <item> + <term>BS (8, Backspace)</term> + <description>\b</description> + </item> + <item> + <term>TAB (9, Horizontal tab)</term> + <description><c>\t</c></description> + </item> + <item> + <term>LF/NL (10, Line Feed/New Line)</term> + <description><c>\n</c></description> + </item> + <item> + <term>VT (11, Vertical Tab)</term> + <description><c>\v</c></description> + </item> + <item> + <term>FF/NP (12, Form Feed, New Page)</term> + <description><c>\f</c></description> + </item> + <item> + <term>CR (13, Carriage Return)</term> + <description><c>\r</c></description> + </item> + </list> + </para> + <para> + Becareful when specifying the list of characters to escape. If you specify, for example, that the <c>r</c> + character should be escaped, it would be escaped as <c>\r</c> which will be interpreted as a Carriage Return + character on a subsequent call to <see cref="M:Jedi.System.StringUtils.ParseEscapedString(System.String)" />. + </para> + </remarks> </member> <member name="M:Jedi.System.StringUtils.EscapeStringImpl(System.String,System.Char[])"> <summary> + Performs C-style escaping on a string on all the specified characters. </summary> <param name="s"> + The A <see cref="T:System.String" /> on which to perform C-style escaping. </param> <param name="escapeCharacters"> + A list of <see cref="T:System.Char" />, specifying which characters to escape. Only characters in this list will + be escaped. </param> <returns> + A <see cref="T:System.String" /> equivalent to the one specified by the <paramref name="s" /> parameter, but with + all characters specified in the <paramref name="escapeCharacters" /> parameter escaped. </returns> </member> *************** *** 717,725 **** --- 898,982 ---- <member name="M:Jedi.System.StringUtils.ParseEscapedString(System.String)"> <summary> + Converts an C-style escaped string into it's non-escaped form. </summary> <param name="s"> + A <see cref="T:System.String" /> possibly containing C-style escape sequences. </param> <returns> + A <see cref="T:System.String" /> equivalent to the one specified in the <paramref name="s" /> parameter, with all + escape sequences converted back to their actualy characters. </returns> + <remarks> + <para> + C-style escaped sequences consist of a backslash (<c>\</c>) character followed by one or more characters + indicating which character the sequence represents. It has uses in those situation where non-standard + characters, like the carriage return or null characters, can not be used directly (for example in storage + situations). + </para> + <para> + Like in C, a number of sequences have special meaning: + </para> + <para> + The following characters are treated as specialized escape sequences: + <list type="table"> + <listheader> + <term>Sequence</term> + <description>Character</description> + </listheader> + <item> + <term><c>\0</c></term> + <description>NUL (0, null)</description> + </item> + <item> + <term><c>\<i>integer</i></c></term> + <description> + <para>The character whose ordinal value is specified in octal after the backslash.</para> + <para> + The parser considers characters until it reaches the end of the string, finds a character not in the + range <c>0..7</c> or until it has read three digits, whichever comes first. + </para> + </description> + </item> + <item> + <term><c>\x<i>integer</i></c></term> + <description> + <para>The character whose ordinal value is specified in hexadecimal after the <c>\x</c>.</para> + <para> + The parser considers characters until it reaches the end of the string, finds a character not in the + range <c>0..9, A..F, a..f</c> or until it has read two digits, whichever comes first. + </para> + </description> + </item> + <item> + <term><c>\a</c></term> + <description>BEL (7, Bell)</description> + </item> + <item> + <term><c>\b</c></term> + <description>BS (8, Backspace)</description> + </item> + <item> + <term><c>\f</c></term> + <description>FF/NP (12, Form Feed, New Page)</description> + </item> + <item> + <term><c>\n</c></term> + <description>LF/NL (10, Line Feed/New Line)</description> + </item> + <item> + <term><c>\r</c></term> + <description>CR (13, Carriage Return)</description> + </item> + <item> + <term><c>\t</c></term> + <description>TAB (9, Horizontal tab)</description> + </item> + <item> + <term><c>\v</c></term> + <description>VT (11, Vertical Tab)</description> + </item> + </list> + </para> + </remarks> </member> <member name="M:Jedi.System.StringUtils.ParseIntBaseImpl(System.String,System.Int32,System.Int32,System.Boolean,System.Int32@)"> *************** *** 846,855 **** </member> <member name="F:Jedi.System.StringUtils.SpecialEscapeChars"> ! <summary> ! </summary> </member> <member name="F:Jedi.System.StringUtils.SpecialEscapeSequences"> ! <summary> ! </summary> </member> <member name="T:Jedi.System.StringUtils.TabSet"> --- 1103,1110 ---- </member> <member name="F:Jedi.System.StringUtils.SpecialEscapeChars"> ! <exclude /> </member> <member name="F:Jedi.System.StringUtils.SpecialEscapeSequences"> ! <exclude /> </member> <member name="T:Jedi.System.StringUtils.TabSet"> *************** *** 1158,1199 **** </member> <member name="M:Jedi.System.StringUtils.TabSet.ToString"> <summary> Converts this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure to a human-readable string. </summary> <returns> ! A string containing the defines tabulation positions (if any) comma separated, enclosed in brackets (<b>[</b> ! and <b>]</b>), followed by the plus character and the default width (optionally suffixed by the constant ! <c>(automatic)</c> if <see cref="P:Jedi.System.StringUtils.TabSet.DefaultWidth" /> is set to 0). </returns> </member> <member name="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean)"> <summary> </summary> <param name="wantBrackets"> </param> <returns> </returns> </member> <member name="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean,System.Boolean)"> <summary> </summary> <param name="wantBrackets"> </param> <param name="emptyBrackets"> </param> <returns> </returns> </member> <member name="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean,System.Boolean,System.Boolean)"> <summary> </summary> <param name="wantBrackets"> </param> <param name="emptyBrackets"> </param> <param name="includeDefaultWidth"> </param> <returns> </returns> </member> </members> \ No newline at end of file --- 1413,1536 ---- </member> <member name="M:Jedi.System.StringUtils.TabSet.ToString"> + <overloads> + Converts this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure to a human-readable string. + </overloads> <summary> Converts this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure to a human-readable string. </summary> <returns> ! A <see cref="T:System>String" /> representing this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure. </returns> + <remarks> + <para> + The string will be formatting as <c><b>[</b><i>comma-separated list of defined positions if any are + defined</i><b>] and every </b><i>tab width beyond defined positions</i></c>. Additionally, the text + <c> (automatic)</c> will be added if <see cref="P:Jedi.System.StringUtils.TabSet.DefaultWidth" /> is set to + 0 (zero). + </para> + <para> + This method is equivalent to a call to + <c><see cref="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean,System.Boolean,System.Boolean)">ToString</see>(<see langword="true" />, <see langword="true" />, <see langword="true" />)</c> + </para> + </remarks> </member> <member name="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean)"> <summary> + Converts this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure to a human-readable string, optionally + adding brackets around the defined positions. </summary> <param name="wantBrackets"> + When set to <see langword="true" />, the defined position, if any, are enclosed in square brackets (<c>[</c> and + <c>]</c>). If no tabulation positions are defined, the brackets will still be outputted. </param> <returns> + A <see cref="T:System>String" /> representing this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure. </returns> + <remarks> + <para> + The string will be formatting as <c><b>[</b><i>comma-separated list of defined positions if any are + defined</i><b>] and every </b><i>tab width beyond defined positions</i></c>. Additionally, the text + <c> (automatic)</c> will be added if <see cref="P:Jedi.System.StringUtils.TabSet.DefaultWidth" /> is set to + 0 (zero). The brackets will be ommitted if <paramref name="wantBrackets" /> is set to <see langword="false" />. + </para> + <para> + This method is equivalent to a call to + <c><see cref="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean,System.Boolean,System.Boolean) /">ToString</see>(<paramref name="wantBrackets" />, <paramref name="wantBrackets" />, <see langword="true" />)</c> + </para> + </remarks> </member> <member name="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean,System.Boolean)"> <summary> + Converts this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure to a human-readable string, with optional + brackets around the defined positions and brackets only if no positions are defined. </summary> <param name="wantBrackets"> + When set to <see langword="true" />, the defined position, if any, are enclosed in square brackets (<c>[</c> and + <c>]</c>). </param> <param name="emptyBrackets"> + When set to <see langword="true" /> and if <paramref name="wantBrackets" /> is set to <see langword="true" />, + brackets will also be present if no tabulation positions are defined. If <paramref name="wantBrackets" /> is set + to <see langword="false" />, the value of this parameter is ignored. </param> <returns> + A <see cref="T:System>String" /> representing this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure. </returns> + <remarks> + <para> + The string will be formatted as <c><b>[</b><i>comma-separated list of defined positions if any are + defined</i><b>] and every </b><i>tab width beyond defined positions</i></c>. Additionally, the text + <c> (automatic)</c> will be added if <see cref="P:Jedi.System.StringUtils.TabSet.DefaultWidth" /> is set to + 0 (zero). The brackets will be ommitted if <paramref name="wantBrackets" /> is set to <see langword="false" /> or + if <paramref name="emptyBrackets" /> is set to <see langword="false" /> and no tabulation positions have been + defined. + </para> + <para> + This method is equivalent to a call to + <c><see cref="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean,System.Boolean,System.Boolean) /">ToString</see>(<paramref name="wantBrackets" />, <paramref name="emptyBrackets" />, <see langword="true" />)</c> + </para> + </remarks> </member> <member name="M:Jedi.System.StringUtils.TabSet.ToString(System.Boolean,System.Boolean,System.Boolean)"> <summary> + Converts this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure to a human-readable string, with optional + brackets around the defined positions, brackets only if no positions are defined and tabulation width beyond + defined positions. </summary> <param name="wantBrackets"> + When set to <see langword="true" />, the defined position, if any, are enclosed in square brackets (<c>[</c> and + <c>]</c>). </param> <param name="emptyBrackets"> + When set to <see langword="true" /> and if <paramref name="wantBrackets" /> is set to <see langword="true" />, + brackets will also be present if no tabulation positions are defined. If <paramref name="wantBrackets" /> is set + to <see langword="false" />, the value of this parameter is ignored. </param> <param name="includeDefaultWidth"> + When set to <see langword="true" /> the text <c>every </c> and the tab width beyond the defined tabulation + positions is added to the resulting <see cref="T:System.String" />. The width is optionally suffixed with the text + <c> and </c> if both wantBrackets and emptyBrackets are set to <see langword="true" /> or if tabulation + positions have been defined. </param> <returns> + A <see cref="T:System>String" /> representing this <see cref="T:Jedi.System.StringUtils.TabSet" /> structure. </returns> + <remarks> + <para> + The string will be formatted as <c><b>[</b><i>comma-separated list of defined positions if any are + defined</i><b>]</b></c>. Additionally, the text + <c> (automatic)</c> will be added if <see cref="P:Jedi.System.StringUtils.TabSet.DefaultWidth" /> is set to + 0 (zero). The brackets will be ommitted if <paramref name="wantBrackets" /> is set to <see langword="false" /> or + if <paramref name="emptyBrackets" /> is set to <see langword="false" /> and no tabulation positions have been + defined. + </para> + <para> + If the <paramref name="includeDefaultWidth" /> parameter is set to <see langword="true" />, the string is + extended in the format <c><b> and every </b><i>tab width beyond defined positions</i></c>. The leading space + and the word "and" is only outputted if the string up to that point was not empty (in other words, there have + either been tabulation positions defined or both the <paramref name="wantBrackets" /> and + <paramref name="emptyBrackets" /> parameters were set to <see langword="true" />. + </para> + </remarks> </member> </members> \ No newline at end of file |
