Skip to content

Commit b9b222e

Browse files
carlossanlopahsonkhan
authored andcommitted
Automatically port Utf8JsonReader remark (#3081)
* Automatically port Utf8JsonReader remark * Fully qualified JsonTokenType.Null * remove BOM character * Update xml/System.Text.Json/Utf8JsonReader.xml Co-Authored-By: Ahson Khan <[email protected]>
1 parent 44acdef commit b9b222e

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

xml/System.Text.Json/Utf8JsonReader.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -675,8 +675,16 @@ The `GetSingle` method throws an exception if the entire UTF-8 encoded token val
675675
<Docs>
676676
<summary>Reads the next JSON token value from the source, unescaped, and transcoded as a string.</summary>
677677
<returns>The token value parsed to a string, or <see langword="null" /> if <see cref="P:System.Text.Json.Utf8JsonReader.TokenType" /> is <see cref="F:System.Text.Json.JsonTokenType.Null" />.</returns>
678-
<remarks>To be added.</remarks>
679-
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a string (that is, not a <see cref="F:System.Text.Json.JsonTokenType.String" /> or <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />).
678+
<remarks>
679+
<format type="text/markdown"><![CDATA[
680+
681+
## Remarks
682+
683+
Returns `null` when <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.Null?displayProperty=nameWithType>.
684+
685+
]]></format>
686+
</remarks>
687+
<exception cref="T:System.InvalidOperationException">The JSON token value isn't a string (that is, not a <see cref="F:System.Text.Json.JsonTokenType.String" />, <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />, or <see cref="F:System.Text.Json.JsonTokenType.Null" />).
680688

681689
-or-
682690

0 commit comments

Comments
 (0)