Skip to content

Document Parse method overloads that take a Span in System types #3437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 6, 2019
Merged

Document Parse method overloads that take a Span in System types #3437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions xml/System/Boolean.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,9 +663,9 @@
<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" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">A span containing the characters representing the value to convert.</param>
<summary>Converts the specified span representation of a logical value to its <see cref="T:System.Boolean" /> equivalent.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -707,8 +707,7 @@
<Docs>
<param name="value">A string containing the value to convert.</param>
<summary>Converts the specified string representation of a logical value to its <see cref="T:System.Boolean" /> equivalent.</summary>
<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>
<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>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
10 changes: 5 additions & 5 deletions xml/System/Byte.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -978,11 +978,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters representing the value to convert.</param>
<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>
<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>
<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>
<returns>A byte value that is equivalent to the number contained in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/DateTimeOffset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3504,11 +3504,11 @@
<Parameter Name="styles" Type="System.Globalization.DateTimeStyles" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="input">To be added.</param>
<param name="formatProvider">To be added.</param>
<param name="styles">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="input">A span containing the characters that represent a date and time to convert.</param>
<param name="formatProvider">An object that provides culture-specific format information about <paramref name="input" />.</param>
<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>
<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>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/Decimal.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4599,11 +4599,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The span containing the characters representing the number to convert.</param>
<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>
<param name="provider">An <see cref="T:System.IFormatProvider" /> object that supplies culture-specific information about the format of <paramref name="s" />.</param>
<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>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/Double.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2133,11 +2133,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters representing the number to convert.</param>
<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>
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
<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>
<returns>A double-precision floating-point number that is equivalent to the numeric value or symbol specified in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
3 changes: 1 addition & 2 deletions xml/System/Guid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1077,8 +1077,7 @@ Use the <xref:System.Guid.TryParse%2A> method to catch any unsuccessful parse op

-or-

After trimming, the length of the read-only character span is 0.
</exception>
After trimming, the length of the read-only character span is 0.</exception>
</Docs>
</Member>
<Member MemberName="Parse">
Expand Down
10 changes: 5 additions & 5 deletions xml/System/Int16.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -904,11 +904,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters representing the number to convert.</param>
<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>
<param name="provider">An <see cref="T:System.IFormatProvider" /> that supplies culture-specific formatting information about <paramref name="s" />.</param>
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent.</summary>
<returns>A 16-bit signed integer equivalent to the number specified in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/Int32.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -977,11 +977,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters representing the number to convert.</param>
<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>
<param name="provider">An object that supplies culture-specific information about the format of <paramref name="s" />.</param>
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent.</summary>
<returns>A 32-bit signed integer equivalent to the number specified in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/Int64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,11 +931,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters representing the number to convert.</param>
<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>
<param name="provider">An <see cref="T:System.IFormatProvider" /> that supplies culture-specific formatting information about <paramref name="s" />.</param>
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent.</summary>
<returns>A 64-bit signed integer equivalent to the number specified in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/SByte.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -912,11 +912,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<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>
<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>
<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>
<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>
<returns>An 8-bit signed byte value that is equivalent to the number specified in the <paramref name="s" /> parameter.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/Single.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2162,11 +2162,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters representing the number to convert.</param>
<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.Float" /> combined with <see cref="F:System.Globalization.NumberStyles.AllowThousands" />.</param>
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
<summary>Converts the span representation of a number in a specified style and culture-specific format to its single-precision floating-point number equivalent.</summary>
<returns>A single-precision floating-point number equivalent to the numeric value or symbol specified in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
8 changes: 4 additions & 4 deletions xml/System/TimeSpan.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2876,10 +2876,10 @@ When a time interval component in the string to be parsed contains more than sev
<Parameter Name="formatProvider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="input">To be added.</param>
<param name="formatProvider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="input">A span containing the characters that represent the time interval to convert.</param>
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
<summary>Converts the span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified culture-specific format information.</summary>
<returns>A time interval that corresponds to <paramref name="input" />, as specified by <paramref name="formatProvider" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/UInt16.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -943,11 +943,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters that represent the number to convert. The span is interpreted by using the style specified by the <paramref name="style" /> parameter.</param>
<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.Integer" />.</param>
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 16-bit unsigned integer equivalent.</summary>
<returns>A 16-bit unsigned integer equivalent to the number specified in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/UInt32.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,11 +957,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters that represent the number to convert. The span is interpreted by using the style specified by the <paramref name="style" /> parameter.</param>
<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>
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 32-bit unsigned integer equivalent.</summary>
<returns>A 32-bit unsigned integer equivalent to the number specified in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System/UInt64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,11 +941,11 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A span containing the characters that represent the number to convert. The span is interpreted by using the style specified by the <paramref name="style" /> parameter.</param>
<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>
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
<summary>Converts the span representation of a number in a specified style and culture-specific format to its 64-bit unsigned integer equivalent.</summary>
<returns>A 64-bit unsigned integer equivalent to the number specified in <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down