Skip to content

Commit 5e7fc0d

Browse files
carlossanlopBillWagner
carlossanlop
authored and
BillWagner
committed
Document Parse method overloads that take a Span in System types (#3437)
1 parent ed108bc commit 5e7fc0d

15 files changed

+69
-71
lines changed

‎xml/System/Boolean.xml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -663,9 +663,9 @@
663663
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
664664
</Parameters>
665665
<Docs>
666-
<param name="value">To be added.</param>
667-
<summary>To be added.</summary>
668-
<returns>To be added.</returns>
666+
<param name="value">A span containing the characters representing the value to convert.</param>
667+
<summary>Converts the specified span representation of a logical value to its <see cref="T:System.Boolean" /> equivalent.</summary>
668+
<returns><see langword="true" /> if <paramref name="value" /> is equivalent to <see cref="F:System.Boolean.TrueString" />; <see langword="false" /> if <paramref name="value" /> is equivalent to <see cref="F:System.Boolean.FalseString" />.</returns>
669669
<remarks>To be added.</remarks>
670670
</Docs>
671671
</Member>
@@ -707,8 +707,7 @@
707707
<Docs>
708708
<param name="value">A string containing the value to convert.</param>
709709
<summary>Converts the specified string representation of a logical value to its <see cref="T:System.Boolean" /> equivalent.</summary>
710-
<returns>
711-
<see langword="true" /> if <paramref name="value" /> is equivalent to <see cref="F:System.Boolean.TrueString" />; <see langword="false" /> if <paramref name="value" /> is equivalent to <see cref="F:System.Boolean.FalseString" />.</returns>
710+
<returns><see langword="true" /> if <paramref name="value" /> is equivalent to <see cref="F:System.Boolean.TrueString" />; <see langword="false" /> if <paramref name="value" /> is equivalent to <see cref="F:System.Boolean.FalseString" />.</returns>
712711
<remarks>
713712
<format type="text/markdown"><![CDATA[
714713

‎xml/System/Byte.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -978,11 +978,11 @@
978978
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
979979
</Parameters>
980980
<Docs>
981-
<param name="s">To be added.</param>
982-
<param name="style">To be added.</param>
983-
<param name="provider">To be added.</param>
984-
<summary>To be added.</summary>
985-
<returns>To be added.</returns>
981+
<param name="s">A span containing the characters representing the value to convert.</param>
982+
<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>
983+
<param name="provider">An object that supplies culture-specific information about the format of <paramref name="s" />. If <paramref name="provider" /> is <see langword="null" />, the thread current culture is used.</param>
984+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its <see cref="T:System.Byte" /> equivalent.</summary>
985+
<returns>A byte value that is equivalent to the number contained in <paramref name="s" />.</returns>
986986
<remarks>To be added.</remarks>
987987
</Docs>
988988
</Member>

‎xml/System/DateTimeOffset.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3504,11 +3504,11 @@
35043504
<Parameter Name="styles" Type="System.Globalization.DateTimeStyles" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
35053505
</Parameters>
35063506
<Docs>
3507-
<param name="input">To be added.</param>
3508-
<param name="formatProvider">To be added.</param>
3509-
<param name="styles">To be added.</param>
3510-
<summary>To be added.</summary>
3511-
<returns>To be added.</returns>
3507+
<param name="input">A span containing the characters that represent a date and time to convert.</param>
3508+
<param name="formatProvider">An object that provides culture-specific format information about <paramref name="input" />.</param>
3509+
<param name="styles">A bitwise combination of enumeration values that indicates the permitted format of <paramref name="input" />. A typical value to specify is <see cref="F:System.Globalization.DateTimeStyles.None" />.</param>
3510+
<summary>Converts the specified span representation of a date and time to its <see cref="T:System.DateTimeOffset" /> equivalent using the specified culture-specific format information and formatting style.</summary>
3511+
<returns>An object that is equivalent to the date and time that is contained in <paramref name="input" /> as specified by <paramref name="formatProvider" /> and <paramref name="styles" />.</returns>
35123512
<remarks>To be added.</remarks>
35133513
</Docs>
35143514
</Member>

‎xml/System/Decimal.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4599,11 +4599,11 @@
45994599
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
46004600
</Parameters>
46014601
<Docs>
4602-
<param name="s">To be added.</param>
4603-
<param name="style">To be added.</param>
4604-
<param name="provider">To be added.</param>
4605-
<summary>To be added.</summary>
4606-
<returns>To be added.</returns>
4602+
<param name="s">The span containing the characters representing the number to convert.</param>
4603+
<param name="style">A bitwise combination of <see cref="T:System.Globalization.NumberStyles" /> 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.Number" />.</param>
4604+
<param name="provider">An <see cref="T:System.IFormatProvider" /> object that supplies culture-specific information about the format of <paramref name="s" />.</param>
4605+
<summary>Converts the span representation of a number to its <see cref="T:System.Decimal" /> equivalent using the specified style and culture-specific format.</summary>
4606+
<returns>The <see cref="T:System.Decimal" /> number equivalent to the number contained in <paramref name="s" /> as specified by <paramref name="style" /> and <paramref name="provider" />.</returns>
46074607
<remarks>To be added.</remarks>
46084608
</Docs>
46094609
</Member>

‎xml/System/Double.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2133,11 +2133,11 @@
21332133
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
21342134
</Parameters>
21352135
<Docs>
2136-
<param name="s">To be added.</param>
2137-
<param name="style">To be added.</param>
2138-
<param name="provider">To be added.</param>
2139-
<summary>To be added.</summary>
2140-
<returns>To be added.</returns>
2136+
<param name="s">A span containing the characters representing the number to convert.</param>
2137+
<param name="style">A bitwise combination of enumeration values that indicate the style elements that can be present in <paramref name="s" />. A typical value to specify is <see cref="F:System.Globalization.NumberStyles.Float" /> combined with <see cref="F:System.Globalization.NumberStyles.AllowThousands" />.</param>
2138+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
2139+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent.</summary>
2140+
<returns>A double-precision floating-point number that is equivalent to the numeric value or symbol specified in <paramref name="s" />.</returns>
21412141
<remarks>To be added.</remarks>
21422142
</Docs>
21432143
</Member>

‎xml/System/Guid.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1077,8 +1077,7 @@ Use the <xref:System.Guid.TryParse%2A> method to catch any unsuccessful parse op
10771077

10781078
-or-
10791079

1080-
After trimming, the length of the read-only character span is 0.
1081-
</exception>
1080+
After trimming, the length of the read-only character span is 0.</exception>
10821081
</Docs>
10831082
</Member>
10841083
<Member MemberName="Parse">

‎xml/System/Int16.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -904,11 +904,11 @@
904904
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
905905
</Parameters>
906906
<Docs>
907-
<param name="s">To be added.</param>
908-
<param name="style">To be added.</param>
909-
<param name="provider">To be added.</param>
910-
<summary>To be added.</summary>
911-
<returns>To be added.</returns>
907+
<param name="s">A span containing the characters representing the number to convert.</param>
908+
<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>
909+
<param name="provider">An <see cref="T:System.IFormatProvider" /> that supplies culture-specific formatting information about <paramref name="s" />.</param>
910+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent.</summary>
911+
<returns>A 16-bit signed integer equivalent to the number specified in <paramref name="s" />.</returns>
912912
<remarks>To be added.</remarks>
913913
</Docs>
914914
</Member>

‎xml/System/Int32.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -977,11 +977,11 @@
977977
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
978978
</Parameters>
979979
<Docs>
980-
<param name="s">To be added.</param>
981-
<param name="style">To be added.</param>
982-
<param name="provider">To be added.</param>
983-
<summary>To be added.</summary>
984-
<returns>To be added.</returns>
980+
<param name="s">A span containing the characters representing the number to convert.</param>
981+
<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>
982+
<param name="provider">An object that supplies culture-specific information about the format of <paramref name="s" />.</param>
983+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent.</summary>
984+
<returns>A 32-bit signed integer equivalent to the number specified in <paramref name="s" />.</returns>
985985
<remarks>To be added.</remarks>
986986
</Docs>
987987
</Member>

‎xml/System/Int64.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -931,11 +931,11 @@
931931
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
932932
</Parameters>
933933
<Docs>
934-
<param name="s">To be added.</param>
935-
<param name="style">To be added.</param>
936-
<param name="provider">To be added.</param>
937-
<summary>To be added.</summary>
938-
<returns>To be added.</returns>
934+
<param name="s">A span containing the characters representing the number to convert.</param>
935+
<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>
936+
<param name="provider">An <see cref="T:System.IFormatProvider" /> that supplies culture-specific formatting information about <paramref name="s" />.</param>
937+
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent.</summary>
938+
<returns>A 64-bit signed integer equivalent to the number specified in <paramref name="s" />.</returns>
939939
<remarks>To be added.</remarks>
940940
</Docs>
941941
</Member>

‎xml/System/SByte.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -912,11 +912,11 @@
912912
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
913913
</Parameters>
914914
<Docs>
915-
<param name="s">To be added.</param>
916-
<param name="style">To be added.</param>
917-
<param name="provider">To be added.</param>
918-
<summary>To be added.</summary>
919-
<returns>To be added.</returns>
915+
<param name="s">A span containing the characters representing the number to convert. The span is interpreted by using the style specified by <paramref name="style" />.</param>
916+
<param name="style">A bitwise combination of the 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>
917+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />. If <paramref name="provider" /> is <see langword="null" />, the thread current culture is used.</param>
918+
<summary>Converts the span representation of a number that is in a specified style and culture-specific format to its 8-bit signed equivalent.</summary>
919+
<returns>An 8-bit signed byte value that is equivalent to the number specified in the <paramref name="s" /> parameter.</returns>
920920
<remarks>To be added.</remarks>
921921
</Docs>
922922
</Member>

0 commit comments

Comments
 (0)