Skip to content

Commit 53d7a14

Browse files
author
Ron Petrusha
authored
Update Utf8JsonReader.xml
1 parent ce0727e commit 53d7a14

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

xml/System.Text.Json/Utf8JsonReader.xml

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -667,8 +667,8 @@ For input data within a `ReadOnlySpan<byte>`, this always returns `false`. For i
667667
<ReturnType>System.Boolean</ReturnType>
668668
</ReturnValue>
669669
<Docs>
670-
<summary>Returns the mode of this instance of the <see cref="T:System.Text.Json.Utf8JsonReader" />.</summary>
671-
<value><see langword="true" /> when the reader was constructed with the input span containing the entire data to process. <see langword="false" /> when the reader was constructed knowing that the input span may contain partial data with more data to follow.</value>
670+
<summary>Gets the mode of this instance of the <see cref="T:System.Text.Json.Utf8JsonReader" />.</summary>
671+
<value><see langword="true" /> if the reader was constructed with the input span containing the entire data to process. <see langword="false" /> if the reader was constructed with an input span that may contain partial data with more data to follow.</value>
672672
<remarks>To be added.</remarks>
673673
</Docs>
674674
</Member>
@@ -745,17 +745,21 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
745745
746746
## Remarks
747747
748-
When <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.PropertyName>, the reader first moves to the property value.
748+
When <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.PropertyName?displayProperty=nameWithType>, the reader first moves to the property value.
749749
750-
When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after advancing) is <xref:System.Text.Json.JsonTokenType.StartObject> or <xref:System.Text.Json.JsonTokenType.StartArray>, the reader advances to the matching <xref:System.Text.Json.JsonTokenType.EndObject> or <xref:System.Text.Json.JsonTokenType.EndArray>.
750+
When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after advancing) is <xref:System.Text.Json.JsonTokenType.StartObject?displayProperty=nameWithtype> or <xref:System.Text.Json.JsonTokenType.StartArray?displayProperty=nameWithType>, the reader advances to the matching <xref:System.Text.Json.JsonTokenType.EndObject?displayProperty=nameWithType> or <xref:System.Text.Json.JsonTokenType.EndArray?displayProperty=nameWithType>.
751751
752752
For all other token types, the reader does not move. After the next call to <xref:System.Text.Json.Utf8JsonReader.Read>, the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token.
753753
754754
]]>
755755
</format>
756756
</remarks>
757-
<exception cref="T:System.InvalidOperationException">Thrown when the reader was given partial data with more data to follow (i.e. <see cref="P:System.Text.Json.Utf8JsonReader.IsFinalBlock" /> is false).</exception>
758-
<exception cref="T:System.Text.Json.JsonException">Thrown when an invalid JSON token is encountered while skipping, according to the JSON RFC, or if the current depth exceeds the recursive limit set by the max depth.</exception>
757+
<exception cref="T:System.InvalidOperationException">The reader was given partial data with more data to follow (that is, <see cref="P:System.Text.Json.Utf8JsonReader.IsFinalBlock" /> is <see langword="false" />).</exception>
758+
<exception cref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
759+
760+
- or -
761+
762+
The current depth exceeds the recursive limit set by the maximum depth.</exception>
759763
</Docs>
760764
</Member>
761765
<Member MemberName="TextEquals">
@@ -840,17 +844,17 @@ If the look up text is invalid or incomplete UTF-16 text (such as unpaired surro
840844
<ReturnType>System.Int64</ReturnType>
841845
</ReturnValue>
842846
<Docs>
843-
<summary>Returns the index that the last processed JSON token starts at within the given UTF-8 encoded input text, skipping any white space.</summary>
844-
<value>To be added.</value>
847+
<summary>Gets the index that the last processed JSON token within the given UTF-8 encoded input text starts at, skipping any white space.</summary>
848+
<value>The starting index of the last processed JSON token within the given UTF-8 encoded input text.</value>
845849
<remarks>
846850
<format type="text/markdown">
847851
<![CDATA[
848852
849853
## Remarks
850854
851-
For JSON strings (including property names), this points to before the start quote.
855+
For JSON strings (including property names), this value points to before the start quote.
852856
853-
For comments, this points to before the first comment delimiter (i.e. '/').
857+
For comments, this value points to before the first comment delimiter (that is, '/').
854858
855859
]]>
856860
</format>
@@ -897,11 +901,11 @@ For comments, this points to before the first comment delimiter (i.e. '/').
897901
<Parameter Name="value" Type="System.Byte[]" RefType="out" />
898902
</Parameters>
899903
<Docs>
900-
<param name="value">To be added.</param>
901-
<summary>Parses the current JSON token value from the source and decodes the base 64 encoded JSON string as bytes.</summary>
902-
<returns><see langword="true" /> if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes, <see langword="false" /> otherwise.</returns>
904+
<param name="value">When the method returns, a byte array that contains the base 64-encoded JSON string if the method succeeds.</param>
905+
<summary>Tries to parse the current JSON token value from the source and decodes the base 64 encoded JSON string as a byte array.</summary>
906+
<returns><see langword="true" /> if the entire token value is encoded as valid base 64 text and can be successfully decoded; <see langword="false" /> otherwise.</returns>
903907
<remarks>To be added.</remarks>
904-
<exception cref="T:System.InvalidOperationException">Thrown if trying to get the value of a JSON token that is not a <see cref="F:System.Text.Json.JsonTokenType.String" />. <seealso cref="P:System.Text.Json.Utf8JsonReader.TokenType" />.</exception>
908+
<exception cref="T:System.InvalidOperationException">The JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
905909
</Docs>
906910
</Member>
907911
<Member MemberName="TryGetDateTime">
@@ -1218,7 +1222,7 @@ This method only parses <xref:System.Guid> values with hyphens and without any s
12181222
<Docs>
12191223
<summary>Tries to skip the children of the current JSON token.</summary>
12201224
<returns>
1221-
<see langword="true" /> if there was enough data for the children to be skipped successfully, else <see langword="false" />.</returns>
1225+
<see langword="true" /> if there was enough data for the children to be skipped successfully; otherwise, <see langword="false" />.</returns>
12221226
<remarks>
12231227
<format type="text/markdown">
12241228
<![CDATA[
@@ -1227,15 +1231,19 @@ This method only parses <xref:System.Guid> values with hyphens and without any s
12271231
12281232
If the reader did not have enough data to completely skip the children of the current token, it will be reset to the state it was in before the method was called.
12291233
1230-
When <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.PropertyName>, the reader first moves to the property value.
1234+
When <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.PropertyName?displayProperty=nameWithType>, the reader first moves to the property value.
12311235
1232-
When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after advancing) is <xref:System.Text.Json.JsonTokenType.StartObject> or <xref:System.Text.Json.JsonTokenType.StartArray>, the reader advances to the matching <xref:System.Text.Json.JsonTokenType.EndObject> or <xref:System.Text.Json.JsonTokenType.EndArray>.
1236+
When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after advancing) is <xref:System.Text.Json.JsonTokenType.StartObject?displayProperty=nameWithType> or <xref:System.Text.Json.JsonTokenType.StartArray?displayProperty=nameWithType>, the reader advances to the matching <xref:System.Text.Json.JsonTokenType.EndObject?displayProperty=nameWithType> or <xref:System.Text.Json.JsonTokenType.EndArray?displayProperty=nameWithType>.
12331237
12341238
For all other token types, the reader does not move. After the next call to <xref:System.Text.Json.Utf8JsonReader.Read>, the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token.
12351239
12361240
]]></format>
12371241
</remarks>
1238-
<exception cref="T:System.Text.Json.JsonException">Thrown when an invalid JSON token is encountered while skipping, according to the JSON RFC, or if the current depth exceeds the recursive limit set by the max depth.</exception>
1242+
<exception cref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
1243+
1244+
- or -
1245+
1246+
The current depth exceeds the recursive limit set by the maximum depth.</exception>
12391247
</Docs>
12401248
</Member>
12411249
<Member MemberName="ValueSequence">

0 commit comments

Comments
 (0)