Skip to content

JsonElement and Utf8JsonReader consistency for TryParse... methods #7427

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 5 commits into from
Nov 29, 2021
Merged

JsonElement and Utf8JsonReader consistency for TryParse... methods #7427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
61e6c5e
#7426: JsonElement and Utf8JsonReader documentation consistency
CodeCasterNL Nov 26, 2021
2131a5d
Pleasing the parser
CodeCasterNL Nov 26, 2021
a233aca
Then it'll be "MinValue" and "Empty" instead of "DateTime.MinValue" a…
CodeCasterNL Nov 26, 2021
3682a17
Complains about consistency, consistently copy-pastes incorrect XML
CodeCasterNL Nov 26, 2021
643b6e1
This should be the last ones
CodeCasterNL Nov 26, 2021
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
28 changes: 14 additions & 14 deletions xml/System.Text.Json/JsonElement.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,7 +1069,7 @@ For other types, the value of <xref:System.Text.Json.JsonElement.GetRawText> is
<Parameter Name="value" Type="System.Byte" RefType="out" />
</Parameters>
<Docs>
<param name="value">When the method returns, contains the byte equivalent of the current JSON number if the conversion succeeded.</param>
<param name="value">When this method returns, contains the byte equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as a <see cref="T:System.Byte" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as a <see cref="T:System.Byte" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1155,7 +1155,7 @@ This method does not create a byte array representation of values other than Bas
<Parameter Name="value" Type="System.DateTime" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the date and time value equivalent to the current JSON string.</param>
<param name="value">When this method returns, contains the date and time value equivalent to the current JSON string if the conversion succeeded, or <see cref="P:System.DateTime.MinValue" /> if the conversion failed.</param>
<summary>Attempts to represent the current JSON string as a <see cref="T:System.DateTime" />.</summary>
<returns>
<see langword="true" /> if the string can be represented as a <see cref="T:System.DateTime" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1194,7 +1194,7 @@ This method only creates a DateTime representation of JSON strings that conform
<Parameter Name="value" Type="System.DateTimeOffset" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the date and time equivalent to the current JSON string.</param>
<param name="value">When this method returns, contains the date and time value equivalent to the current JSON string if the conversion succeeded, or <see cref="P:System.DateTimeOffset.MinValue" /> if the conversion failed.</param>
<summary>Attempts to represent the current JSON string as a <see cref="T:System.DateTimeOffset" />.</summary>
<returns>
<see langword="true" /> if the string can be represented as a <see cref="T:System.DateTimeOffset" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1233,7 +1233,7 @@ This method only creates a DateTimeOffset representation of JSON strings that co
<Parameter Name="value" Type="System.Decimal" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the decimal equivalent of the current JSON number.</param>
<param name="value">When this method returns, contains the decimal equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as a <see cref="T:System.Decimal" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as a <see cref="T:System.Decimal" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1272,7 +1272,7 @@ This method does not parse the contents of a JSON string value.
<Parameter Name="value" Type="System.Double" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains a double-precision floating point value equivalent to the current JSON number.</param>
<param name="value">When this method returns, contains a double-precision floating point value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as a <see cref="T:System.Double" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as a <see cref="T:System.Double" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1313,7 +1313,7 @@ On .NET Core, this method does not return `false` for values larger than <xref:S
<Parameter Name="value" Type="System.Guid" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the GUID equivalent to the current JSON string.</param>
<param name="value">When this method returns, contains the GUID equivalent to the current JSON string if the conversion succeeded, or <see cref="P:System.Guid.Empty" /> if the conversion failed.</param>
<summary>Attempts to represent the current JSON string as a <see cref="T:System.Guid" />.</summary>
<returns>
<see langword="true" /> if the string can be represented as a <see cref="T:System.Guid" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1352,7 +1352,7 @@ This method does not create a Guid representation of values other than JSON stri
<Parameter Name="value" Type="System.Int16" RefType="out" />
</Parameters>
<Docs>
<param name="value">When the method returns, contains the 16-bit integer equivalent of the current JSON number if the conversion succeeded.</param>
<param name="value">When this method returns, contains the 16-bit integer value equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as an <see cref="T:System.Int16" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as an <see cref="T:System.Int16" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1391,7 +1391,7 @@ This method does not parse the contents of a JSON string value.
<Parameter Name="value" Type="System.Int32" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the 32-bit integer value equivalent to the current JSON number.</param>
<param name="value">When this method returns, contains the 32-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as an <see cref="T:System.Int32" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as an <see cref="T:System.Int32" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1430,7 +1430,7 @@ This method does not parse the contents of a JSON string value.
<Parameter Name="value" Type="System.Int64" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the 64-bit integer value equivalent to the current JSON number.</param>
<param name="value">When this method returns, contains the 64-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as a <see cref="T:System.Int64" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as a <see cref="T:System.Int64" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1608,7 +1608,7 @@ If a property is defined multiple times for the same object, the method matches
<Parameter Name="value" Type="System.SByte" RefType="out" />
</Parameters>
<Docs>
<param name="value">When the method returns, contains the signed byte equivalent of the current JSON number if the conversion succeeded.</param>
<param name="value">When this method returns, contains the signed byte equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as an <see cref="T:System.SByte" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as an <see cref="T:System.SByte" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1647,7 +1647,7 @@ This method does not parse the contents of a JSON string value.
<Parameter Name="value" Type="System.Single" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains the single-precision floating point value equivalent to the current JSON number.</param>
<param name="value">When this method returns, contains the single-precision floating point value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as a <see cref="T:System.Single" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as a <see cref="T:System.Single" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1694,7 +1694,7 @@ On .NET Core, this method does not return `false` for values larger than <xref:S
<Parameter Name="value" Type="System.UInt16" RefType="out" />
</Parameters>
<Docs>
<param name="value">When the method returns, contains the unsigned 16-bit integer equivalent of the current JSON number if the conversion succeeded.</param>
<param name="value">When this method returns, contains the unsigned 16-bit integer value equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt16" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as a <see cref="T:System.UInt16" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1739,7 +1739,7 @@ This method does not parse the contents of a JSON string value.
<Parameter Name="value" Type="System.UInt32" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number.</param>
<param name="value">When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt32" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as a <see cref="T:System.UInt32" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -1784,7 +1784,7 @@ This method does not parse the contents of a JSON string value.
<Parameter Name="value" Type="System.UInt64" RefType="out" />
</Parameters>
<Docs>
<param name="value">When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number.</param>
<param name="value">When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed.</param>
<summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt64" />.</summary>
<returns>
<see langword="true" /> if the number can be represented as a <see cref="T:System.UInt64" />; otherwise, <see langword="false" />.</returns>
Expand Down
Loading