Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
74587ec
Automatically port System.Text.Json triple slash comments
carlossanlop Jul 9, 2019
b9f3fb8
Update JsonAttribute.xml
Jul 17, 2019
6aec448
Update JsonExtensionDataAttribute.xml
Jul 17, 2019
8f1dfdc
Update JsonPropertyNameAttribute.xml
Jul 17, 2019
663a3ba
Update JsonExtensionDataAttribute.xml
Jul 17, 2019
9ee98a0
Update JsonElement.xml
Jul 17, 2019
5a071ee
Update JsonEncodedText.xml
Jul 17, 2019
56710b2
Update JsonException.xml
Jul 17, 2019
7c450f2
Update JsonReaderOptions.xml
Jul 17, 2019
e3c89a9
Update JsonTokenType.xml
Jul 17, 2019
eef0826
Update Utf8JsonReader.xml
Jul 17, 2019
80f4479
suggestions by rpetrusha
carlossanlop Jul 17, 2019
1fb07d1
Fixed malformed XML
Jul 17, 2019
ce0727e
fixed bad paramref
Jul 17, 2019
53d7a14
Update Utf8JsonReader.xml
Jul 17, 2019
eee8886
Update Utf8JsonWriter.xml
Jul 17, 2019
33f597f
Update Utf8JsonWriter.xml
Jul 17, 2019
5ed4fd1
Update Utf8JsonWriter.xml
Jul 17, 2019
b9d48be
Update Utf8JsonWriter.xml
Jul 17, 2019
dddb507
Fixed broken xref.
Jul 17, 2019
771baa4
suggestions by ahsonkhan
carlossanlop Jul 18, 2019
63f04f4
suggestion by ahsonkhan for TryGetBytesFromBase64
carlossanlop Jul 19, 2019
889eaf6
suggestions by ahsonkhan and bartonjs
carlossanlop Jul 19, 2019
3afa1da
Bold JSON literals
carlossanlop Jul 23, 2019
8322d36
smaller exception for Utf8JsonReader.GetBytesFromBase64
carlossanlop Jul 23, 2019
4766c5c
Merge branch 'master' into Json
Jul 24, 2019
e9bc3e9
suggestions by ahsonkhan
carlossanlop Jul 25, 2019
5e93316
JSON literal null for WriteNullValue
carlossanlop Jul 25, 2019
498fa68
Changed type name
Jul 26, 2019
7daf66c
Corrected enum type name
Jul 26, 2019
b15ff4e
Fixed bad cref
Jul 26, 2019
d1f8a14
JSON literals
carlossanlop Jul 29, 2019
86c65ea
Fixed broken links
Jul 29, 2019
89210ba
Fixed broken link
Jul 29, 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: 3 additions & 3 deletions xml/System.Text.Json.Serialization/JsonAttribute.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides the base class for serialization attributes.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -31,9 +31,9 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Creates a new instance of the <see cref="T:System.Text.Json.Serialization.JsonAttribute" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
24 changes: 20 additions & 4 deletions xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,24 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<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[

## Remarks

The dictionary's `TKey` value must be <xref:System.String>, and `TValue` must be <xref:System.Text.Json.JsonElement> or <xref:System.Object>.

During deserialization, when using <xref:System.Object>, a "null" JSON value is treated as a `null` object reference, and when using <xref:System.Text.Json.JsonElement>, a "null" is treated as a JsonElement with <xref:System.Text.Json.JsonElement.ValueKind> set to <xref:System.Text.Json.JsonValueKind.Null?displayProperty=nameWithType>.

During serialization, the name of the extension data property is not included in the JSON; the data contained within the extension data is serialized as properties of the JSON object.

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>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -36,9 +52,9 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Instantiates a new instance of the <see cref="T:System.Text.Json.Serialization.JsonExtensionDataAttribute" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
4 changes: 2 additions & 2 deletions xml/System.Text.Json.Serialization/JsonIgnoreAttribute.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Prevents a property from being serialized or deserialized.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -36,7 +36,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonIgnoreAttribute" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by <see cref="T:System.Text.Json.JsonNamingPolicy" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -39,8 +39,8 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>To be added.</summary>
<param name="name">The name of the property.</param>
<summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonPropertyNameAttribute" /> with the specified property name.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -60,10 +60,10 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the name of the property.</summary>
<value>The name of the property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
168 changes: 96 additions & 72 deletions xml/System.Text.Json/JsonElement.xml

Large diffs are not rendered by default.

104 changes: 79 additions & 25 deletions xml/System.Text.Json/JsonEncodedText.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,18 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<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[

## 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>
</remarks>
</Docs>
<Members>
<Member MemberName="Encode">
Expand All @@ -46,10 +56,11 @@
<Parameter Name="utf8Value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
</Parameters>
<Docs>
<param name="utf8Value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="utf8Value">The UTF-8 encoded value to be transformed as JSON encoded text.</param>
<summary>Encodes a UTF-8 encoded byte span as a JSON string.</summary>
<returns>The JSON string.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException"><paramref name="utf8Value" /> is too large or contains invalid UTF-8 bytes.</exception>
</Docs>
</Member>
<Member MemberName="Encode">
Expand All @@ -71,10 +82,11 @@
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The value to be transformed as JSON encoded text.</param>
<summary>Encodes a UTF-16 encoded character span as a JSON string.</summary>
<returns>The JSON string.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException"><paramref name="value" /> is too large or contains invalid UTF-16 characters.</exception>
</Docs>
</Member>
<Member MemberName="Encode">
Expand All @@ -96,10 +108,12 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<param name="value">The value to be transformed as JSON encoded text.</param>
<summary>Encodes the string text value as a JSON string.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException"><paramref name="value" /> is too large or contains invalid UTF-16 characters.</exception>
</Docs>
</Member>
<Member MemberName="EncodedUtf8Bytes">
Expand All @@ -118,8 +132,8 @@
<ReturnType>System.ReadOnlySpan&lt;System.Byte&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the UTF-8 encoded representation of the pre-encoded JSON text.</summary>
<value>The UTF-8 encoded representation of the pre-encoded JSON text.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -143,9 +157,19 @@
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<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[

## Remarks

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

]]>
</format>
</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
Expand All @@ -171,9 +195,19 @@
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<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[

## Remarks

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

]]>
</format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
Expand All @@ -193,9 +227,19 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<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[

## Remarks

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

]]>
</format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
Expand All @@ -215,10 +259,20 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<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[

## Remarks

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

]]>
</format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
Loading