Skip to content

Update live with current master #3246

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 4 commits into from
Sep 27, 2019
Merged

Update live with current master #3246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2576558
Document System.Version (#3232)
carlossanlop Sep 26, 2019
4f9dbb8
L124989: Fixing CDATA formatting (#3243)
v-maudel Sep 26, 2019
7f6c225
Correct JsonNamingPolicy docs (#3244)
breyed Sep 26, 2019
c60324f
Document namespace System.Threading.Tasks.Sources (#3231)
carlossanlop Sep 27, 2019
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
6 changes: 2 additions & 4 deletions xml/System.Reflection/AssemblyHashAlgorithm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@
<Docs>
<summary>Retrieves the MD5 message-digest algorithm.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down Expand Up @@ -86,8 +85,7 @@ The algorithm consists of four distinct rounds, which has a slightly different d
<Docs>
<summary>A mask indicating that there is no hash algorithm.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down
4 changes: 2 additions & 2 deletions xml/System.Text.Json/JsonSerializerOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,8 +338,8 @@ There is a performance cost associated with case-insensitie comparison (that is,
<ReturnType>System.Text.Json.JsonNamingPolicy</ReturnType>
</ReturnValue>
<Docs>
<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>
<value>One of the enum values from <see cref="T:System.Text.Json.JsonNamingPolicy" />.</value>
<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>
<value>A property naming policy, or <see langword="null" /> to leave property names unchanged.</value>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
131 changes: 92 additions & 39 deletions xml/System/Version.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1418,10 +1418,26 @@
<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" />
</Parameters>
<Docs>
<param name="input">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="input">A read-only span of characters that contains a version number to convert.</param>
<summary>Converts the specified read-only span of characters that represents a version number to an equivalent <see cref="T:System.Version" /> object.</summary>
<returns>An object that is equivalent to the version number specified in the <paramref name="input" /> parameter.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The `input` parameter must have the following format:

`major.minor[.build[.revision]]`

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.

]]></format>
</remarks>
<exception cref="T:System.ArgumentException"><paramref name="input" /> has fewer than two or more than four version components.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">At least one component in <paramref name="input" /> is less than zero.</exception>
<exception cref="T:System.FormatException">At least one component in <paramref name="input" /> is not an integer.</exception>
<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>
</Docs>
</Member>
<Member MemberName="Parse">
Expand Down Expand Up @@ -1467,12 +1483,9 @@
## Remarks
The `input` parameter must have the following format:

```
`major.minor[.build[.revision]]`

major.minor[.build[.revision]]
```

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.
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.

> [!IMPORTANT]
> 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.
Expand All @@ -1489,10 +1502,8 @@ major.minor[.build[.revision]]

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="input" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="input" /> has fewer than two or more than four version components.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException"><paramref name="input" /> has fewer than two or more than four version components.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">At least one component in <paramref name="input" /> is less than zero.</exception>
<exception cref="T:System.FormatException">At least one component in <paramref name="input" /> is not an integer.</exception>
<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>
Expand Down Expand Up @@ -1584,10 +1595,41 @@ major.minor[.build[.revision]]
<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" />
</Parameters>
<Docs>
<param name="version">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="version">An object to compare, or <see langword="null" />.</param>
<summary>Compares the current <see cref="T:System.Version" /> object to a specified object and returns an indication of their relative values.</summary>
<returns>A signed integer that indicates the relative values of the two objects, as shown in the following table:
<list type="table">
<listheader>
<term>Return value</term>
<description>Meaning</description>
</listheader>
<item>
<term>Less than zero</term>
<description>The current <see cref="T:System.Version" /> object is a version before <paramref name="version" />.</description>
</item>
<item>
<term>Zero</term>
<description>The current <see cref="T:System.Version" /> object is the same version as <paramref name="version" />.</description>
</item>
<item>
<term>Greater than zero</term>
<description>The current <see cref="T:System.Version" /> object is a version subsequent to <paramref name="version" />.

-or-

<paramref name="version" /> is <see langword="null" />.</description>
</item>
</list>
</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation.

]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="ToString">
Expand Down Expand Up @@ -1749,10 +1791,10 @@ major.minor[.build[.revision]]
<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, the formatted version in the span of characters.</param>
<param name="charsWritten">When this method returns, the number of chars that were written in <paramref name="destination" />.</param>
<summary>Tries to format this version instance into a 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 Expand Up @@ -1784,11 +1826,11 @@ major.minor[.build[.revision]]
<Parameter Name="charsWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="fieldCount">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, the formatted version in the span of characters.</param>
<param name="fieldCount">The number of components to return. This value ranges from 0 to 4.</param>
<param name="charsWritten">When this method returns, the number of chars that were written in <paramref name="destination" />.</param>
<summary>Tries to format this version instance into a 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 Expand Up @@ -1819,11 +1861,26 @@ major.minor[.build[.revision]]
<Parameter Name="result" Type="System.Version" RefType="out" 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="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="input">A read-only span of characters that contains a version number to convert.</param>
<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>
<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>
<returns><see langword="true" /> if the <paramref name="input" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[

## Remarks

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>.

For the parse operation to succeed, the `input` parameter must be in the following format:

`major.minor[.build[.revision]]`

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down Expand Up @@ -1864,22 +1921,18 @@ major.minor[.build[.revision]]
<param name="input">A string that contains a version number to convert.</param>
<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>
<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>
<returns>
<see langword="true" /> if the <paramref name="input" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
<returns><see langword="true" /> if the <paramref name="input" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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>.
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>.

For the parse operation to succeed, the `input` parameter must be in the following format:

```

major.minor[.build[.revision]]
```
`major.minor[.build[.revision]]`

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.
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.



Expand Down
2 changes: 1 addition & 1 deletion xml/ns-System.Threading.Tasks.Sources.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Namespace Name="System.Threading.Tasks.Sources">
<Docs>
<summary>To be added.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Namespace>