Skip to content

fix cdata formatting #2893

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.

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 1 commit into from
Jul 31, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
<Docs>
<summary>When placed on a property of type <see cref="T:System.Collections.Generic.IDictionary`2" />, any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand All @@ -34,8 +33,7 @@ During serialization, the name of the extension data property is not included in

If there is more than one property on a type with this extension data attribute, or if the property itself is not of the correct <see cref="T:System.Collections.Generic.IDictionary`2" /> type, an <xref:System.InvalidOperationException> is thrown during the first serialization or deserialization of that type.

]]>
</format>
]]></format>
</remarks>
</Docs>
<Members>
Expand Down
12 changes: 4 additions & 8 deletions xml/System.Text.Json/JsonElement.xml
Original file line number Diff line number Diff line change
Expand Up @@ -195,15 +195,13 @@ This method does not parse the contents of a JSON string value.
<summary>Gets the value of the element as a byte array.</summary>
<returns>The value decoded as a byte array.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

This method does not create a byte representation of values other than base 64-encoded JSON strings.

]]>
</format>
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
<exception cref="T:System.FormatException">The value is not encoded as base 64 text and hence cannot be decoded to bytes.</exception>
Expand Down Expand Up @@ -881,15 +879,13 @@ For other types, the value of <xref:System.Text.Json.JsonElement.GetRawText> is
<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>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

This method does not create a byte array representation of values other than base 64-encoded JSON strings.

]]>
</format>
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
Expand Down
30 changes: 10 additions & 20 deletions xml/System.Text.Json/JsonEncodedText.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,13 @@
<Docs>
<summary>Provides methods to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

This type can be used to cache and store known strings used for writing JSON ahead of time by pre-encoding them up front.

]]>
</format>
]]></format>
</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -160,15 +158,13 @@ This type can be used to cache and store known strings used for writing JSON ahe
<summary>Determines whether this instance and a specified object, which must also be a <see cref="T:System.Text.Json.JsonEncodedText" /> instance, have the same value.</summary>
<returns><see langword="true" /> if the current instance and <paramref name="obj" /> are equal; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

If `obj` is `null`, the method returns `false`.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -198,15 +194,13 @@ If `obj` is `null`, the method returns `false`.
<summary>Determines whether this instance and another specified <see cref="T:System.Text.Json.JsonEncodedText" /> instance have the same value.</summary>
<returns><see langword="true" /> if this instance and <paramref name="other" /> have the same value; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Default instances of <xref:System.Text.Json.JsonEncodedText> are treated as equal.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand All @@ -230,15 +224,13 @@ Default instances of <xref:System.Text.Json.JsonEncodedText> are treated as equa
<summary>Returns the hash code for this <see cref="T:System.Text.Json.JsonEncodedText" />.</summary>
<returns>The hash code for this instance.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

This method returns 0 on a default instance of <xref:System.Text.Json.JsonEncodedText>.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand All @@ -262,15 +254,13 @@ This method returns 0 on a default instance of <xref:System.Text.Json.JsonEncode
<summary>Converts the value of this instance to a <see cref="T:System.String" />.</summary>
<returns>The underlying UTF-16 encoded string.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

This method returns an empty string on a default instance of <xref:System.Text.Json.JsonEncodedText>.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down
12 changes: 4 additions & 8 deletions xml/System.Text.Json/JsonException.xml
Original file line number Diff line number Diff line change
Expand Up @@ -128,15 +128,13 @@
<param name="bytePositionInLine">The byte count within the current line (starting at 0) where the invalid JSON was encountered.</param>
<summary>Creates a new exception object to relay error information to the user.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Note that `bytePositionInLine` counts the number of bytes (that is, UTF-8 code units), and not characters or scalars.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -167,15 +165,13 @@ Note that `bytePositionInLine` counts the number of bytes (that is, UTF-8 code
<param name="innerException">The exception that caused the current exception.</param>
<summary>Creates a new exception object to relay error information to the user that includes a specified inner exception.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Note that the `bytePositionInLine` counts the number of bytes (that is, UTF-8 code units), and not characters or scalars.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down
12 changes: 4 additions & 8 deletions xml/System.Text.Json/JsonReaderOptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,13 @@
<summary>Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. </summary>
<value><see langword="true" /> if an exra comma is allowed; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

By default, this property is set to `false`, and a <xref:System.Text.Json.JsonException> is thrown if a trailing comma is encountered.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -113,15 +111,13 @@ By default, the reader throws a <xref:System.Text.Json.JsonException> if it enco
<summary>Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64. </summary>
<value>The maximum depth allowed when reading JSON.</value>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Reading past this depth will throw a <exception cref="T:System.Text.Json.JsonException>.

]]>
</format>
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The maximum depth is being set to a negative value.</exception>
</Docs>
Expand Down
6 changes: 2 additions & 4 deletions xml/System.Text.Json/JsonTokenType.xml
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,13 @@
<Docs>
<summary>There is no value (as distinct from <see cref="F:System.Text.Json.JsonTokenType.Null" />).</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

This is the default token type if no data has been read by the <xref:System.Text.Json.Utf8JsonReader>.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down
33 changes: 11 additions & 22 deletions xml/System.Text.Json/Utf8JsonReader.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
<Docs>
<summary>Provides a high-performance API for forward-only, read-only access to the UTF-8 encoded JSON text.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down Expand Up @@ -106,8 +105,7 @@ To be able to set max depth while reading OR allow skipping comments, create an
<param name="state">If this is the first call to the constructor, pass in a default state. Otherwise, capture the state from the previous instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> and pass that back.</param>
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> class.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down Expand Up @@ -142,8 +140,7 @@ This is the reason why the constructor accepts a <xref:System.Text.Json.JsonRead
<param name="state">A struct that contains the reader state. On the first call to the constructor, it should reflect a default state; otherwise, it should capture the state from the previous instance instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> and pass that back.</param>
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> class.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down Expand Up @@ -194,8 +191,7 @@ This is the reason why the constructor accepts a <xref:System.Text.Json.JsonRead
<summary>Gets the depth of the current token.</summary>
<value>The depth of the current token.</value>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down Expand Up @@ -224,8 +220,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a
<summary>Gets the current snapshot of the <see cref="T:System.Text.Json.Utf8JsonReader" /> state that must be captured by the caller and passed back in to the <see cref="T:System.Text.Json.Utf8JsonReader" /> constructor with more data.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down Expand Up @@ -873,8 +868,7 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
<Docs>
<summary>Skips the children of the current JSON token.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand All @@ -884,8 +878,7 @@ When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after adva

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.

]]>
</format>
]]></format>
</remarks>
<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>
<exception cref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
Expand Down Expand Up @@ -919,17 +912,15 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
<summary>Gets the index that the last processed JSON token starts at (within the given UTF-8 encoded input text), skipping any white space.</summary>
<value>The starting index of the last processed JSON token within the given UTF-8 encoded input text.</value>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

For JSON strings (including property names), this value points to before the start quote.

For comments, this value points to before the first comment delimiter (that is, '/').

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1406,8 +1397,7 @@ This method only parses <xref:System.Guid> values with hyphens and without any s
<returns>
<see langword="true" /> if there was enough data for the children to be skipped successfully; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down Expand Up @@ -1454,8 +1444,7 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
Otherwise, <see cref="P:System.Text.Json.Utf8JsonReader.ValueSequence" /> contains the token value.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Expand Down
Loading