Skip to content

Commit 7def705

Browse files
author
Ron Petrusha
authored
Merge pull request #3246 from dotnet/master
Update live with current master
2 parents 0c9d2d0 + c60324f commit 7def705

File tree

4 files changed

+97
-46
lines changed

4 files changed

+97
-46
lines changed

xml/System.Reflection/AssemblyHashAlgorithm.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@
4646
<Docs>
4747
<summary>Retrieves the MD5 message-digest algorithm.</summary>
4848
<remarks>
49-
<format type="text/markdown">
50-
<![CDATA[
49+
<format type="text/markdown"><![CDATA[
5150
5251
## Remarks
5352
@@ -86,8 +85,7 @@ The algorithm consists of four distinct rounds, which has a slightly different d
8685
<Docs>
8786
<summary>A mask indicating that there is no hash algorithm.</summary>
8887
<remarks>
89-
<format type="text/markdown">
90-
<![CDATA[
88+
<format type="text/markdown"><![CDATA[
9189
9290
## Remarks
9391

xml/System.Text.Json/JsonSerializerOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -338,8 +338,8 @@ There is a performance cost associated with case-insensitie comparison (that is,
338338
<ReturnType>System.Text.Json.JsonNamingPolicy</ReturnType>
339339
</ReturnValue>
340340
<Docs>
341-
<summary>Gets or sets a value that specifies the policy used to convert a property's name on an object to another format, such as camel-casing. </summary>
342-
<value>One of the enum values from <see cref="T:System.Text.Json.JsonNamingPolicy" />.</value>
341+
<summary>Gets or sets a value that specifies the policy used to convert a property's name on an object to another format, such as camel-casing, or <see langword="null" /> to leave property names unchanged.</summary>
342+
<value>A property naming policy, or <see langword="null" /> to leave property names unchanged.</value>
343343
<remarks>
344344
<format type="text/markdown"><![CDATA[
345345

xml/System/Version.xml

Lines changed: 92 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1418,10 +1418,26 @@
14181418
<Parameter Name="input" Type="System.ReadOnlySpan&lt;System.Char&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
14191419
</Parameters>
14201420
<Docs>
1421-
<param name="input">To be added.</param>
1422-
<summary>To be added.</summary>
1423-
<returns>To be added.</returns>
1424-
<remarks>To be added.</remarks>
1421+
<param name="input">A read-only span of characters that contains a version number to convert.</param>
1422+
<summary>Converts the specified read-only span of characters that represents a version number to an equivalent <see cref="T:System.Version" /> object.</summary>
1423+
<returns>An object that is equivalent to the version number specified in the <paramref name="input" /> parameter.</returns>
1424+
<remarks>
1425+
<format type="text/markdown"><![CDATA[
1426+
1427+
## Remarks
1428+
1429+
The `input` parameter must have the following format:
1430+
1431+
`major.minor[.build[.revision]]`
1432+
1433+
where `major`, `minor`, `build`, and `revision` are the string representations of the version number's four components: major version number, minor version number, build number, and revision number, respectively. Optional components are shown in square brackets ([ and ]). The components must appear in the specified order and must be separated by periods.
1434+
1435+
]]></format>
1436+
</remarks>
1437+
<exception cref="T:System.ArgumentException"><paramref name="input" /> has fewer than two or more than four version components.</exception>
1438+
<exception cref="T:System.ArgumentOutOfRangeException">At least one component in <paramref name="input" /> is less than zero.</exception>
1439+
<exception cref="T:System.FormatException">At least one component in <paramref name="input" /> is not an integer.</exception>
1440+
<exception cref="T:System.OverflowException">At least one component in <paramref name="input" /> represents a number that is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
14251441
</Docs>
14261442
</Member>
14271443
<Member MemberName="Parse">
@@ -1467,12 +1483,9 @@
14671483
## Remarks
14681484
The `input` parameter must have the following format:
14691485
1470-
```
1486+
`major.minor[.build[.revision]]`
14711487
1472-
major.minor[.build[.revision]]
1473-
```
1474-
1475-
where *major*, *minor*, *build*, and *revision* are the string representations of the version number's four components: major version number, minor version number, build number, and revision number. Optional components are shown in square brackets ([ and ]). The components must appear in the specified order, and must be separated by periods.
1488+
where `major`, `minor`, `build`, and `revision` are the string representations of the version number's four components: major version number, minor version number, build number, and revision number, respectively. Optional components are shown in square brackets ([ and ]). The components must appear in the specified order and must be separated by periods.
14761489
14771490
> [!IMPORTANT]
14781491
> Because the string representation of a version number must conform to a recognized pattern, applications should always use exception handling when calling the <xref:System.Version.Parse%2A> method to parse user input. Alternatively, you can call the <xref:System.Version.TryParse%2A> method to parse the string representation of a version number and return a value that indicates whether the parse operation succeeded.
@@ -1489,10 +1502,8 @@ major.minor[.build[.revision]]
14891502
14901503
]]></format>
14911504
</remarks>
1492-
<exception cref="T:System.ArgumentNullException">
1493-
<paramref name="input" /> is <see langword="null" />.</exception>
1494-
<exception cref="T:System.ArgumentException">
1495-
<paramref name="input" /> has fewer than two or more than four version components.</exception>
1505+
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null" />.</exception>
1506+
<exception cref="T:System.ArgumentException"><paramref name="input" /> has fewer than two or more than four version components.</exception>
14961507
<exception cref="T:System.ArgumentOutOfRangeException">At least one component in <paramref name="input" /> is less than zero.</exception>
14971508
<exception cref="T:System.FormatException">At least one component in <paramref name="input" /> is not an integer.</exception>
14981509
<exception cref="T:System.OverflowException">At least one component in <paramref name="input" /> represents a number that is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
@@ -1584,10 +1595,41 @@ major.minor[.build[.revision]]
15841595
<Parameter Name="version" Type="System.Object" Index="0" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.5;netstandard-1.6" />
15851596
</Parameters>
15861597
<Docs>
1587-
<param name="version">To be added.</param>
1588-
<summary>To be added.</summary>
1589-
<returns>To be added.</returns>
1590-
<remarks>To be added.</remarks>
1598+
<param name="version">An object to compare, or <see langword="null" />.</param>
1599+
<summary>Compares the current <see cref="T:System.Version" /> object to a specified object and returns an indication of their relative values.</summary>
1600+
<returns>A signed integer that indicates the relative values of the two objects, as shown in the following table:
1601+
<list type="table">
1602+
<listheader>
1603+
<term>Return value</term>
1604+
<description>Meaning</description>
1605+
</listheader>
1606+
<item>
1607+
<term>Less than zero</term>
1608+
<description>The current <see cref="T:System.Version" /> object is a version before <paramref name="version" />.</description>
1609+
</item>
1610+
<item>
1611+
<term>Zero</term>
1612+
<description>The current <see cref="T:System.Version" /> object is the same version as <paramref name="version" />.</description>
1613+
</item>
1614+
<item>
1615+
<term>Greater than zero</term>
1616+
<description>The current <see cref="T:System.Version" /> object is a version subsequent to <paramref name="version" />.
1617+
1618+
-or-
1619+
1620+
<paramref name="version" /> is <see langword="null" />.</description>
1621+
</item>
1622+
</list>
1623+
</returns>
1624+
<remarks>
1625+
<format type="text/markdown"><![CDATA[
1626+
1627+
## Remarks
1628+
1629+
This member is an explicit interface member implementation.
1630+
1631+
]]></format>
1632+
</remarks>
15911633
</Docs>
15921634
</Member>
15931635
<MemberGroup MemberName="ToString">
@@ -1749,10 +1791,10 @@ major.minor[.build[.revision]]
17491791
<Parameter Name="charsWritten" Type="System.Int32" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
17501792
</Parameters>
17511793
<Docs>
1752-
<param name="destination">To be added.</param>
1753-
<param name="charsWritten">To be added.</param>
1754-
<summary>To be added.</summary>
1755-
<returns>To be added.</returns>
1794+
<param name="destination">When this method returns, the formatted version in the span of characters.</param>
1795+
<param name="charsWritten">When this method returns, the number of chars that were written in <paramref name="destination" />.</param>
1796+
<summary>Tries to format this version instance into a span of characters.</summary>
1797+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
17561798
<remarks>To be added.</remarks>
17571799
</Docs>
17581800
</Member>
@@ -1784,11 +1826,11 @@ major.minor[.build[.revision]]
17841826
<Parameter Name="charsWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
17851827
</Parameters>
17861828
<Docs>
1787-
<param name="destination">To be added.</param>
1788-
<param name="fieldCount">To be added.</param>
1789-
<param name="charsWritten">To be added.</param>
1790-
<summary>To be added.</summary>
1791-
<returns>To be added.</returns>
1829+
<param name="destination">When this method returns, the formatted version in the span of characters.</param>
1830+
<param name="fieldCount">The number of components to return. This value ranges from 0 to 4.</param>
1831+
<param name="charsWritten">When this method returns, the number of chars that were written in <paramref name="destination" />.</param>
1832+
<summary>Tries to format this version instance into a span of characters.</summary>
1833+
<returns><see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
17921834
<remarks>To be added.</remarks>
17931835
</Docs>
17941836
</Member>
@@ -1819,11 +1861,26 @@ major.minor[.build[.revision]]
18191861
<Parameter Name="result" Type="System.Version" RefType="out" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
18201862
</Parameters>
18211863
<Docs>
1822-
<param name="input">To be added.</param>
1823-
<param name="result">To be added.</param>
1824-
<summary>To be added.</summary>
1825-
<returns>To be added.</returns>
1826-
<remarks>To be added.</remarks>
1864+
<param name="input">A read-only span of characters that contains a version number to convert.</param>
1865+
<param name="result">When this method returns, the <see cref="T:System.Version" /> equivalent of the number that is contained in <paramref name="input" />, if the conversion succeeded. If <paramref name="input" /> is <see langword="null" />, <see cref="F:System.String.Empty" />, or if the conversion fails, <paramref name="result" /> is <see langword="null" /> when the method returns.</param>
1866+
<summary>Tries to convert the specified read-only span of characters representing a version number to an equivalent <see cref="T:System.Version" /> object, and returns a value that indicates whether the conversion succeeded.</summary>
1867+
<returns><see langword="true" /> if the <paramref name="input" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
1868+
<remarks>
1869+
<format type="text/markdown">
1870+
<![CDATA[
1871+
1872+
## Remarks
1873+
1874+
The `TryParse` method is similar to the <xref:System.Version.Parse%2A> method, except that it doesn't throw an exception if the conversion fails. Instead, it returns `false` if `input` is `null`, has fewer than two or more than four components, has at least one component that is not an integer, has at least one component that is less than zero, or has at least one component that is greater than <xref:System.Int32.MaxValue?displayProperty=nameWithType>.
1875+
1876+
For the parse operation to succeed, the `input` parameter must be in the following format:
1877+
1878+
`major.minor[.build[.revision]]`
1879+
1880+
where `major`, `minor`, `build`, and `revision` are the string representations of the version number's four components: major version number, minor version number, build number, and revision number, respectively. Optional components are shown in square brackets ([ and ]). The components must appear in order and must be separated by periods.
1881+
1882+
]]></format>
1883+
</remarks>
18271884
</Docs>
18281885
</Member>
18291886
<Member MemberName="TryParse">
@@ -1864,22 +1921,18 @@ major.minor[.build[.revision]]
18641921
<param name="input">A string that contains a version number to convert.</param>
18651922
<param name="result">When this method returns, contains the <see cref="T:System.Version" /> equivalent of the number that is contained in <paramref name="input" />, if the conversion succeeded. If <paramref name="input" /> is <see langword="null" />, <see cref="F:System.String.Empty" />, or if the conversion fails, <paramref name="result" /> is <see langword="null" /> when the method returns.</param>
18661923
<summary>Tries to convert the string representation of a version number to an equivalent <see cref="T:System.Version" /> object, and returns a value that indicates whether the conversion succeeded.</summary>
1867-
<returns>
1868-
<see langword="true" /> if the <paramref name="input" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
1924+
<returns><see langword="true" /> if the <paramref name="input" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
18691925
<remarks>
18701926
<format type="text/markdown"><![CDATA[
18711927
18721928
## Remarks
1873-
The <xref:System.Version.TryParse%2A> method is similar to the <xref:System.Version.Parse%2A> method, except that it does not throw an exception if the conversion fails. Instead, it returns `false` if `input` is null, has fewer than two or more than four components, has at least one component that is not an integer, has at least one component that is less than zero, or has at least one component that is greater than <xref:System.Int32.MaxValue?displayProperty=nameWithType>.
1929+
The `TryParse` method is similar to the <xref:System.Version.Parse%2A> method, except that it doesn't throw an exception if the conversion fails. Instead, it returns `false` if `input` is `null`, has fewer than two or more than four components, has at least one component that is not an integer, has at least one component that is less than zero, or has at least one component that is greater than <xref:System.Int32.MaxValue?displayProperty=nameWithType>.
18741930
18751931
For the parse operation to succeed, the `input` parameter must be in the following format:
18761932
1877-
```
1878-
1879-
major.minor[.build[.revision]]
1880-
```
1933+
`major.minor[.build[.revision]]`
18811934
1882-
where *major*, *minor*, *build*, and *revision* are the string representations of the version number's four components: major version number, minor version number, build number, and revision number. Optional components are shown in square brackets ([ and ]). The components must appear in order, and must be separated by periods.
1935+
where `major`, `minor`, `build`, and `revision` are the string representations of the version number's four components: major version number, minor version number, build number, and revision number, respectively. Optional components are shown in square brackets ([ and ]). The components must appear in order and must be separated by periods.
18831936
18841937
18851938
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Threading.Tasks.Sources">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types for creating <see cref="T:System.Threading.Tasks.ValueTask" /> and <see cref="T:System.Threading.Tasks.ValueTask`1" /> optimized to minimize allocations. The <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource" /> and <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1" /> interfaces can be implemented on objects used to provide the backing implementations for <see cref="T:System.Threading.Tasks.ValueTask" /> and <see cref="T:System.Threading.Tasks.ValueTask`1" />, and <see cref="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1" /> can be used to implement the core logic necessary to support the task lifecycle. These are advanced types and need only be used in specialized situations where performance is paramount.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

0 commit comments

Comments
 (0)