Skip to content

Document TryFormat methods in System types #3436

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 TryFormat methods in System types #3436

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
8 changes: 4 additions & 4 deletions xml/System/Boolean.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1788,10 +1788,10 @@
<Parameter Name="charsWritten" Type="System.Int32" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<summary>Tries to format the value of the current boolean instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/Byte.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2301,12 +2301,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current 8-bit unsigned integer instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/DateTime.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8043,12 +8043,12 @@ The value of the current <xref:System.DateTime> object is formatted using the pa
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current datetime instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/DateTimeOffset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5351,12 +5351,12 @@ Me.ToUtcDateTime().ToFileTime()
<Parameter Name="formatProvider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="formatProvider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="formatProvider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current datetime offset instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/Decimal.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7182,12 +7182,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current decimal instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/Double.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3595,12 +3595,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current double instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</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 @@ -1681,8 +1681,7 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust
<param name="charsWritten">When this method returns, the number of characters written into the span.</param>
<param name="format">A read-only span containing the character representing one of the following specifiers that indicates the exact format to use when interpreting <paramref name="input" />: "N", "D", "B", "P", or "X".</param>
<summary>Tries to format the current GUID instance into the provided character span.</summary>
<returns>
<see langword="true" /> if the formatting operation was successful; <see langword="false" /> otherwise.</returns>
<returns><see langword="true" /> if the formatting operation was successful; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/Int16.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2224,12 +2224,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current short number instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/Int32.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2345,12 +2345,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current integer number instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/Int64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2270,12 +2270,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current long number instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/SByte.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2230,12 +2230,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current 8-bit signed integer instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/Single.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3597,12 +3597,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current float number instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/TimeSpan.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4523,12 +4523,12 @@ When a time interval component in the string to be parsed contains more than sev
<Parameter Name="formatProvider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="formatProvider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="formatProvider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current timespan number instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System/UInt16.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2270,12 +2270,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">>When this method returns, this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">A span containing the charactes that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current unsigned short number instance into the provided span of characters.</summary>
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading