Skip to content

Commit d2cebd7

Browse files
carlossanlopThraka
andauthored
Document TryParse Span method overloads for System.I-U (#3434)
* Document TryParse Span methods overloads for System.I-U * suggestions by Thraka Co-Authored-By: Andy De George <[email protected]> * suggestion by Thraka Co-Authored-By: Andy De George <[email protected]>
1 parent 979ea6a commit d2cebd7

File tree

9 files changed

+106
-123
lines changed

9 files changed

+106
-123
lines changed

xml/System/Int16.xml

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2274,10 +2274,10 @@
22742274
<Parameter Name="result" Type="System.Int16" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
22752275
</Parameters>
22762276
<Docs>
2277-
<param name="s">To be added.</param>
2278-
<param name="result">To be added.</param>
2279-
<summary>To be added.</summary>
2280-
<returns>To be added.</returns>
2277+
<param name="s">A span containing the characters representing the number to convert.</param>
2278+
<param name="result">When this method returns, contains the 16-bit signed integer value equivalent to the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not in a format compliant with <paramref name="style" />, or represents a number less than <see cref="F:System.Int16.MinValue" /> or greater than <see cref="F:System.Int16.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
2279+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.</summary>
2280+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
22812281
<remarks>To be added.</remarks>
22822282
</Docs>
22832283
</Member>
@@ -2402,12 +2402,12 @@
24022402
<Parameter Name="result" Type="System.Int16" RefType="out" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
24032403
</Parameters>
24042404
<Docs>
2405-
<param name="s">To be added.</param>
2406-
<param name="style">To be added.</param>
2407-
<param name="provider">To be added.</param>
2408-
<param name="result">To be added.</param>
2409-
<summary>To be added.</summary>
2410-
<returns>To be added.</returns>
2405+
<param name="s">A span containing the characters representing the number to convert. The span is interpreted using the style specified by <paramref name="style" />.</param>
2406+
<param name="style">A bitwise combination of enumeration values that indicates the style elements that can be present in <paramref name="s" />. A typical value to specify is <see cref="F:System.Globalization.NumberStyles.Integer" />.</param>
2407+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
2408+
<param name="result">When this method returns, contains the 16-bit signed integer value equivalent to the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not in a format compliant with <paramref name="style" />, or represents a number less than <see cref="F:System.Int16.MinValue" /> or greater than <see cref="F:System.Int16.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
2409+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.</summary>
2410+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
24112411
<remarks>To be added.</remarks>
24122412
</Docs>
24132413
</Member>
@@ -2454,8 +2454,7 @@
24542454
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
24552455
<param name="result">When this method returns, contains the 16-bit signed integer value equivalent to the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not in a format compliant with <paramref name="style" />, or represents a number less than <see cref="F:System.Int16.MinValue" /> or greater than <see cref="F:System.Int16.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
24562456
<summary>Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.</summary>
2457-
<returns>
2458-
<see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
2457+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
24592458
<remarks>
24602459
<format type="text/markdown"><![CDATA[
24612460

xml/System/Int32.xml

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2395,10 +2395,10 @@
23952395
<Parameter Name="result" Type="System.Int32" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
23962396
</Parameters>
23972397
<Docs>
2398-
<param name="s">To be added.</param>
2399-
<param name="result">To be added.</param>
2400-
<summary>To be added.</summary>
2401-
<returns>To be added.</returns>
2398+
<param name="s">A span containing the characters that represent the number to convert.</param>
2399+
<param name="result">When this method returns, contains the 32-bit signed integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not in a format compliant with <paramref name="style" />, or represents a number less than <see cref="F:System.Int32.MinValue" /> or greater than <see cref="F:System.Int32.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
2400+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.</summary>
2401+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
24022402
<remarks>To be added.</remarks>
24032403
</Docs>
24042404
</Member>
@@ -2441,8 +2441,7 @@
24412441
<param name="s">A string containing a number to convert.</param>
24422442
<param name="result">When this method returns, contains the 32-bit signed integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not of the correct format, or represents a number less than <see cref="F:System.Int32.MinValue" /> or greater than <see cref="F:System.Int32.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
24432443
<summary>Converts the string representation of a number to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.</summary>
2444-
<returns>
2445-
<see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
2444+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
24462445
<remarks>
24472446
<format type="text/markdown"><![CDATA[
24482447
@@ -2524,12 +2523,12 @@
25242523
<Parameter Name="result" Type="System.Int32" RefType="out" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
25252524
</Parameters>
25262525
<Docs>
2527-
<param name="s">To be added.</param>
2528-
<param name="style">To be added.</param>
2529-
<param name="provider">To be added.</param>
2530-
<param name="result">To be added.</param>
2531-
<summary>To be added.</summary>
2532-
<returns>To be added.</returns>
2526+
<param name="s">A span containing the characters that represent the number to convert. The span is interpreted using the style specified by <paramref name="style" /></param>
2527+
<param name="style">A bitwise combination of enumeration values that indicates the style elements that can be present in <paramref name="s" />. A typical value to specify is <see cref="F:System.Globalization.NumberStyles.Integer" />.</param>
2528+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
2529+
<param name="result">When this method returns, contains the 32-bit signed integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not in a format compliant with <paramref name="style" />, or represents a number less than <see cref="F:System.Int32.MinValue" /> or greater than <see cref="F:System.Int32.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
2530+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.</summary>
2531+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
25332532
<remarks>To be added.</remarks>
25342533
</Docs>
25352534
</Member>
@@ -2581,8 +2580,7 @@
25812580
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
25822581
<param name="result">When this method returns, contains the 32-bit signed integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not in a format compliant with <paramref name="style" />, or represents a number less than <see cref="F:System.Int32.MinValue" /> or greater than <see cref="F:System.Int32.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
25832582
<summary>Converts the string representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.</summary>
2584-
<returns>
2585-
<see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
2583+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
25862584
<remarks>
25872585
<format type="text/markdown"><![CDATA[
25882586

xml/System/Int64.xml

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2320,10 +2320,10 @@
23202320
<Parameter Name="result" Type="System.Int64" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
23212321
</Parameters>
23222322
<Docs>
2323-
<param name="s">To be added.</param>
2324-
<param name="result">To be added.</param>
2325-
<summary>To be added.</summary>
2326-
<returns>To be added.</returns>
2323+
<param name="s">A span containing the characters representing the number to convert.</param>
2324+
<param name="result">When this method returns, contains the 64-bit signed integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not of the correct format, or represents a number less than <see cref="F:System.Int64.MinValue" /> or greater than <see cref="F:System.Int64.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
2325+
<summary>Converts the span representation of a number to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.</summary>
2326+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
23272327
<remarks>To be added.</remarks>
23282328
</Docs>
23292329
</Member>
@@ -2371,8 +2371,7 @@
23712371
<param name="s">A string containing a number to convert.</param>
23722372
<param name="result">When this method returns, contains the 64-bit signed integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not of the correct format, or represents a number less than <see cref="F:System.Int64.MinValue" /> or greater than <see cref="F:System.Int64.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
23732373
<summary>Converts the string representation of a number to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.</summary>
2374-
<returns>
2375-
<see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
2374+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
23762375
<remarks>
23772376
<format type="text/markdown"><![CDATA[
23782377
@@ -2453,12 +2452,12 @@
24532452
<Parameter Name="result" Type="System.Int64" RefType="out" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
24542453
</Parameters>
24552454
<Docs>
2456-
<param name="s">To be added.</param>
2457-
<param name="style">To be added.</param>
2458-
<param name="provider">To be added.</param>
2459-
<param name="result">To be added.</param>
2460-
<summary>To be added.</summary>
2461-
<returns>To be added.</returns>
2455+
<param name="s">A span containing the characters representing the number to convert. The span is interpreted using the style specified by <paramref name="style" />.</param>
2456+
<param name="style">A bitwise combination of enumeration values that indicates the style elements that can be present in <paramref name="s" />. A typical value to specify is <see cref="F:System.Globalization.NumberStyles.Integer" />.</param>
2457+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
2458+
<param name="result">When this method returns, contains the 64-bit signed integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not in a format compliant with <paramref name="style" />, or represents a number less than <see cref="F:System.Int64.MinValue" /> or greater than <see cref="F:System.Int64.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
2459+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.</summary>
2460+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
24622461
<remarks>To be added.</remarks>
24632462
</Docs>
24642463
</Member>
@@ -2510,8 +2509,7 @@
25102509
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
25112510
<param name="result">When this method returns, contains the 64-bit signed integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />, is not in a format compliant with <paramref name="style" />, or represents a number less than <see cref="F:System.Int64.MinValue" /> or greater than <see cref="F:System.Int64.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in <paramref name="result" /> will be overwritten.</param>
25122511
<summary>Converts the string representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.</summary>
2513-
<returns>
2514-
<see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
2512+
<returns><see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
25152513
<remarks>
25162514
<format type="text/markdown"><![CDATA[
25172515

0 commit comments

Comments
 (0)