Skip to content

Commit 6f5f668

Browse files
carlossanlopBillWagner
carlossanlop
authored and
BillWagner
committed
Document TryFormat methods in System types (#3436)
1 parent 5e7fc0d commit 6f5f668

17 files changed

+93
-96
lines changed

‎xml/System/Boolean.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1787,10 +1787,10 @@
17871787
<Parameter Name="charsWritten" Type="System.Int32" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
17881788
</Parameters>
17891789
<Docs>
1790-
<param name="destination">To be added.</param>
1791-
<param name="charsWritten">To be added.</param>
1792-
<summary>To be added.</summary>
1793-
<returns>To be added.</returns>
1790+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
1791+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
1792+
<summary>Tries to format the value of the current boolean instance into the provided span of characters.</summary>
1793+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
17941794
<remarks>To be added.</remarks>
17951795
</Docs>
17961796
</Member>

‎xml/System/Byte.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2301,12 +2301,12 @@
23012301
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
23022302
</Parameters>
23032303
<Docs>
2304-
<param name="destination">To be added.</param>
2305-
<param name="charsWritten">To be added.</param>
2306-
<param name="format">To be added.</param>
2307-
<param name="provider">To be added.</param>
2308-
<summary>To be added.</summary>
2309-
<returns>To be added.</returns>
2304+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
2305+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
2306+
<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>
2307+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
2308+
<summary>Tries to format the value of the current 8-bit unsigned integer instance into the provided span of characters.</summary>
2309+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
23102310
<remarks>To be added.</remarks>
23112311
</Docs>
23122312
</Member>

‎xml/System/DateTime.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8043,12 +8043,12 @@ The value of the current <xref:System.DateTime> object is formatted using the pa
80438043
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
80448044
</Parameters>
80458045
<Docs>
8046-
<param name="destination">To be added.</param>
8047-
<param name="charsWritten">To be added.</param>
8048-
<param name="format">To be added.</param>
8049-
<param name="provider">To be added.</param>
8050-
<summary>To be added.</summary>
8051-
<returns>To be added.</returns>
8046+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
8047+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
8048+
<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>
8049+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
8050+
<summary>Tries to format the value of the current datetime instance into the provided span of characters.</summary>
8051+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
80528052
<remarks>To be added.</remarks>
80538053
</Docs>
80548054
</Member>

‎xml/System/DateTimeOffset.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5351,12 +5351,12 @@ Me.ToUtcDateTime().ToFileTime()
53515351
<Parameter Name="formatProvider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
53525352
</Parameters>
53535353
<Docs>
5354-
<param name="destination">To be added.</param>
5355-
<param name="charsWritten">To be added.</param>
5356-
<param name="format">To be added.</param>
5357-
<param name="formatProvider">To be added.</param>
5358-
<summary>To be added.</summary>
5359-
<returns>To be added.</returns>
5354+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
5355+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
5356+
<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>
5357+
<param name="formatProvider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
5358+
<summary>Tries to format the value of the current datetime offset instance into the provided span of characters.</summary>
5359+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
53605360
<remarks>To be added.</remarks>
53615361
</Docs>
53625362
</Member>

‎xml/System/Decimal.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7182,12 +7182,12 @@
71827182
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
71837183
</Parameters>
71847184
<Docs>
7185-
<param name="destination">To be added.</param>
7186-
<param name="charsWritten">To be added.</param>
7187-
<param name="format">To be added.</param>
7188-
<param name="provider">To be added.</param>
7189-
<summary>To be added.</summary>
7190-
<returns>To be added.</returns>
7185+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
7186+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
7187+
<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>
7188+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
7189+
<summary>Tries to format the value of the current decimal instance into the provided span of characters.</summary>
7190+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
71917191
<remarks>To be added.</remarks>
71927192
</Docs>
71937193
</Member>

‎xml/System/Double.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3595,12 +3595,12 @@
35953595
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
35963596
</Parameters>
35973597
<Docs>
3598-
<param name="destination">To be added.</param>
3599-
<param name="charsWritten">To be added.</param>
3600-
<param name="format">To be added.</param>
3601-
<param name="provider">To be added.</param>
3602-
<summary>To be added.</summary>
3603-
<returns>To be added.</returns>
3598+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
3599+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
3600+
<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>
3601+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
3602+
<summary>Tries to format the value of the current double instance into the provided span of characters.</summary>
3603+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
36043604
<remarks>To be added.</remarks>
36053605
</Docs>
36063606
</Member>

‎xml/System/Guid.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1680,8 +1680,7 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust
16801680
<param name="charsWritten">When this method returns, the number of characters written into the span.</param>
16811681
<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>
16821682
<summary>Tries to format the current GUID instance into the provided character span.</summary>
1683-
<returns>
1684-
<see langword="true" /> if the formatting operation was successful; <see langword="false" /> otherwise.</returns>
1683+
<returns><see langword="true" /> if the formatting operation was successful; <see langword="false" /> otherwise.</returns>
16851684
<remarks>To be added.</remarks>
16861685
</Docs>
16871686
</Member>

‎xml/System/Int16.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2224,12 +2224,12 @@
22242224
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
22252225
</Parameters>
22262226
<Docs>
2227-
<param name="destination">To be added.</param>
2228-
<param name="charsWritten">To be added.</param>
2229-
<param name="format">To be added.</param>
2230-
<param name="provider">To be added.</param>
2231-
<summary>To be added.</summary>
2232-
<returns>To be added.</returns>
2227+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
2228+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
2229+
<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>
2230+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
2231+
<summary>Tries to format the value of the current short number instance into the provided span of characters.</summary>
2232+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
22332233
<remarks>To be added.</remarks>
22342234
</Docs>
22352235
</Member>

‎xml/System/Int32.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2345,12 +2345,12 @@
23452345
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
23462346
</Parameters>
23472347
<Docs>
2348-
<param name="destination">To be added.</param>
2349-
<param name="charsWritten">To be added.</param>
2350-
<param name="format">To be added.</param>
2351-
<param name="provider">To be added.</param>
2352-
<summary>To be added.</summary>
2353-
<returns>To be added.</returns>
2348+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
2349+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
2350+
<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>
2351+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
2352+
<summary>Tries to format the value of the current integer number instance into the provided span of characters.</summary>
2353+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
23542354
<remarks>To be added.</remarks>
23552355
</Docs>
23562356
</Member>

‎xml/System/Int64.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2270,12 +2270,12 @@
22702270
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
22712271
</Parameters>
22722272
<Docs>
2273-
<param name="destination">To be added.</param>
2274-
<param name="charsWritten">To be added.</param>
2275-
<param name="format">To be added.</param>
2276-
<param name="provider">To be added.</param>
2277-
<summary>To be added.</summary>
2278-
<returns>To be added.</returns>
2273+
<param name="destination">When this method returns, this instance's value formatted as a span of characters.</param>
2274+
<param name="charsWritten">When this method returns, the number of characters that were written in <paramref name="destination" />.</param>
2275+
<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>
2276+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
2277+
<summary>Tries to format the value of the current long number instance into the provided span of characters.</summary>
2278+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
22792279
<remarks>To be added.</remarks>
22802280
</Docs>
22812281
</Member>

0 commit comments

Comments
 (0)