Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c8ee7ad

Browse files
tdykstramairaw
tdykstra
and
mairaw
authored
Link to System.Text.Json conceptual docs (dotnet#3502)
* link to conceptual docs * typos * move links to remarks * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]> * Update xml/System.Text.Json.Serialization/JsonConverterAttribute.xml Co-Authored-By: Maira Wenzel <[email protected]> * Update xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml Co-Authored-By: Maira Wenzel <[email protected]> * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]> * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]>
1 parent 283b260 commit c8ee7ad

22 files changed

+342
-36
lines changed

‎xml/System.Text.Json.Serialization/JsonConverter.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,15 @@
1515
<Interfaces />
1616
<Docs>
1717
<summary>Converts an object or value to or from JSON.</summary>
18-
<remarks>To be added.</remarks>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md).
24+
25+
]]></format>
26+
</remarks>
1927
</Docs>
2028
<Members>
2129
<Member MemberName="CanConvert">

‎xml/System.Text.Json.Serialization/JsonConverterAttribute.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ The specified converter type must derive from <xref:System.Text.Json.Serializati
3030
When placed on a property, the specified converter will always be used.
3131
3232
When placed on a type, the specified converter will be used unless a compatible converter is added to the <xref:System.Text.Json.JsonSerializerOptions.Converters?displayProperty=nameWithType> collection or there is another <xref:System.Text.Json.Serialization.JsonConverterAttribute> on a property of the same type.
33-
33+
34+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md#register-a-custom-converter).
35+
3436
]]></format>
3537
</remarks>
3638
</Docs>

‎xml/System.Text.Json.Serialization/JsonConverterFactory.xml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
2323
This is useful for converters supporting generics, such as a converter for <xref:System.Collections.Generic.List`1>.
2424
25+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md#register-a-custom-converter).
26+
2527
]]></format>
2628
</remarks>
2729
</Docs>
@@ -67,7 +69,15 @@ This is useful for converters supporting generics, such as a converter for <xref
6769
<param name="options">The serialization options to use.</param>
6870
<summary>Creates a converter for a specified type.</summary>
6971
<returns>A converter for which <typeparamref name="T" /> is compatible with <paramref name="typeToConvert" />.</returns>
70-
<remarks>To be added.</remarks>
72+
<remarks>
73+
<format type="text/markdown"><![CDATA[
74+
75+
## Remarks
76+
77+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md#sample-factory-pattern-converter).
78+
79+
]]></format>
80+
</remarks>
7181
</Docs>
7282
</Member>
7383
</Members>

‎xml/System.Text.Json.Serialization/JsonConverter`1.xml

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,15 @@
1919
<Docs>
2020
<typeparam name="T">The type of object or value handled by the converter.</typeparam>
2121
<summary>Converts an object or value to or from JSON.</summary>
22-
<remarks>To be added.</remarks>
22+
<remarks>
23+
<format type="text/markdown"><![CDATA[
24+
25+
## Remarks
26+
27+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md).
28+
29+
]]></format>
30+
</remarks>
2331
</Docs>
2432
<Members>
2533
<Member MemberName=".ctor">
@@ -69,6 +77,8 @@
6977
7078
The default implementation is to return `true` when `typeToConvert` equals `typeof(T)`.
7179
80+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md#steps-to-follow-the-basic-pattern).
81+
7282
]]></format>
7383
</remarks>
7484
</Docs>
@@ -99,7 +109,15 @@ The default implementation is to return `true` when `typeToConvert` equals `type
99109
<param name="options">An object that specifies serialization options to use.</param>
100110
<summary>Reads and converts the JSON to type <typeparamref name="T" />.</summary>
101111
<returns>The converted value.</returns>
102-
<remarks>To be added.</remarks>
112+
<remarks>
113+
<format type="text/markdown"><![CDATA[
114+
115+
## Remarks
116+
117+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md#steps-to-follow-the-basic-pattern).
118+
119+
]]></format>
120+
</remarks>
103121
</Docs>
104122
</Member>
105123
<Member MemberName="Write">
@@ -134,6 +152,8 @@ The default implementation is to return `true` when `typeToConvert` equals `type
134152
135153
A converter may throw any exception, but it should throw <xref:System.Text.Json.JsonException> when the JSON cannot be created.
136154
155+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md#steps-to-follow-the-basic-pattern).
156+
137157
]]></format>
138158
</remarks>
139159
</Docs>

‎xml/System.Text.Json.Serialization/JsonExtensionDataAttribute.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ During serialization, the name of the extension data property is not included in
3333
3434
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.
3535
36+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#handle-overflow-json).
37+
3638
]]></format>
3739
</remarks>
3840
</Docs>

‎xml/System.Text.Json.Serialization/JsonIgnoreAttribute.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,15 @@
2020
</Attributes>
2121
<Docs>
2222
<summary>Prevents a property from being serialized or deserialized.</summary>
23-
<remarks>To be added.</remarks>
23+
<remarks>
24+
<format type="text/markdown"><![CDATA[
25+
26+
## Remarks
27+
28+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#exclude-individual-properties).
29+
30+
]]></format>
31+
</remarks>
2432
</Docs>
2533
<Members>
2634
<Member MemberName=".ctor">

‎xml/System.Text.Json.Serialization/JsonPropertyNameAttribute.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,15 @@
2020
</Attributes>
2121
<Docs>
2222
<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>
23-
<remarks>To be added.</remarks>
23+
<remarks>
24+
<format type="text/markdown"><![CDATA[
25+
26+
## Remarks
27+
28+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#customize-individual-property-names).
29+
30+
]]></format>
31+
</remarks>
2432
</Docs>
2533
<Members>
2634
<Member MemberName=".ctor">

‎xml/System.Text.Json.Serialization/JsonStringEnumConverter.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
2323
Reading is case insensitive. Writing can be customized by using a <xref:System.Text.Json.JsonNamingPolicy>.
2424
25+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#enums-as-strings).
26+
2527
]]></format>
2628
</remarks>
2729
</Docs>

‎xml/System.Text.Json/JsonCommentHandling.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,15 @@
1414
</Base>
1515
<Docs>
1616
<summary>Defines how the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct handles comments.</summary>
17-
<remarks>To be added.</remarks>
17+
<remarks>
18+
<format type="text/markdown"><![CDATA[
19+
20+
## Remarks
21+
22+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#allow-comments-and-trailing-commas).
23+
24+
]]></format>
25+
</remarks>
1826
</Docs>
1927
<Members>
2028
<Member MemberName="Allow">

‎xml/System.Text.Json/JsonDocument.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
<format><![CDATA[
2424
2525
This class utilizes resources from pooled memory to minimize the impact of the garbage collector (GC) in high-usage scenarios. Failure to properly dispose this object will result in the memory not being returned to the pool, which will increase GC impact across various parts of the framework.
26+
27+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#utf8jsonreader-utf8jsonwriter-and-jsondocument).
28+
2629
2730
]]></format>
2831
</remarks>

‎xml/System.Text.Json/JsonDocumentOptions.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,15 @@
1515
<Interfaces />
1616
<Docs>
1717
<summary>Provides the ability for the user to define custom behavior when parsing JSON to create a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
18-
<remarks>To be added.</remarks>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md).
24+
25+
]]></format>
26+
</remarks>
1927
</Docs>
2028
<Members>
2129
<Member MemberName="AllowTrailingCommas">

‎xml/System.Text.Json/JsonElement.xml

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,15 @@
2020
</Attributes>
2121
<Docs>
2222
<summary>Represents a specific JSON value within a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
23-
<remarks>To be added.</remarks>
23+
<remarks>
24+
<format type="text/markdown"><![CDATA[
25+
26+
## Remarks
27+
28+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#use-jsondocument-for-access-to-data).
29+
30+
]]></format>
31+
</remarks>
2432
</Docs>
2533
<Members>
2634
<Member MemberName="Clone">
@@ -72,7 +80,15 @@ If this <xref:System.Text.Json.JsonElement> is itself the output of a previous c
7280
<Docs>
7381
<summary>Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement.</summary>
7482
<returns>An enumerator to enumerate the values in the JSON array represented by this JsonElement.</returns>
75-
<remarks>To be added.</remarks>
83+
<remarks>
84+
<format type="text/markdown"><![CDATA[
85+
86+
## Remarks
87+
88+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#use-jsondocument-for-access-to-data).
89+
90+
]]></format>
91+
</remarks>
7692
<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.Array" />.</exception>
7793
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
7894
</Docs>
@@ -120,7 +136,15 @@ If this <xref:System.Text.Json.JsonElement> is itself the output of a previous c
120136
<Docs>
121137
<summary>Gets the number of values contained within the current array value.</summary>
122138
<returns>The number of values contained within the current array value.</returns>
123-
<remarks>To be added.</remarks>
139+
<remarks>
140+
<format type="text/markdown"><![CDATA[
141+
142+
## Remarks
143+
144+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#use-jsondocument-for-access-to-data).
145+
146+
]]></format>
147+
</remarks>
124148
<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.Array" />.</exception>
125149
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
126150
</Docs>
@@ -502,6 +526,8 @@ Property name matching is performed as an ordinal, case-sensitive comparison.
502526
503527
If a property is defined multiple times for the same object, the method matches the last such definition.
504528
529+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#use-jsondocument-for-access-to-data).
530+
505531
]]></format>
506532
</remarks>
507533
<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.Object" />.</exception>
@@ -1285,6 +1311,8 @@ Property name matching is performed as an ordinal, case-sensitive comparison.
12851311
12861312
If a property is defined multiple times for the same object, the method matches the last such definition.
12871313
1314+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#use-jsondocument-for-access-to-data).
1315+
12881316
]]></format>
12891317
</remarks>
12901318
<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.Object" />.</exception>

‎xml/System.Text.Json/JsonException.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,15 @@
1515
<Interfaces />
1616
<Docs>
1717
<summary>Defines a custom exception object that is thrown when invalid JSON text is encountered, when the defined maximum depth is passed, or the JSON text is not compatible with the type of a property on an object.</summary>
18-
<remarks>To be added.</remarks>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
For more information, see [How to write custom converters for JSON serialization](~/docs/standard/serialization/system-text-json-converters-how-to.md#error-handling).
24+
25+
]]></format>
26+
</remarks>
1927
</Docs>
2028
<Members>
2129
<Member MemberName=".ctor">

‎xml/System.Text.Json/JsonNamingPolicy.xml

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,15 @@
1515
<Interfaces />
1616
<Docs>
1717
<summary>Determines the naming policy used to convert a string-based name to another format, such as a camel-casing format.</summary>
18-
<remarks>To be added.</remarks>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#customize-json-names-and-values).
24+
25+
]]></format>
26+
</remarks>
1927
</Docs>
2028
<Members>
2129
<Member MemberName=".ctor">
@@ -53,7 +61,15 @@
5361
<Docs>
5462
<summary>Gets the naming policy for camel-casing.</summary>
5563
<value>The naming policy for camel-casing.</value>
56-
<remarks>To be added.</remarks>
64+
<remarks>
65+
<format type="text/markdown"><![CDATA[
66+
67+
## Remarks
68+
69+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#use-camel-case-for-all-json-property-names).
70+
71+
]]></format>
72+
</remarks>
5773
</Docs>
5874
</Member>
5975
<Member MemberName="ConvertName">
@@ -78,7 +94,15 @@
7894
<param name="name">The name to convert.</param>
7995
<summary>When overridden in a derived class, converts the specified name according to the policy.</summary>
8096
<returns>The converted name.</returns>
81-
<remarks>To be added.</remarks>
97+
<remarks>
98+
<format type="text/markdown"><![CDATA[
99+
100+
## Remarks
101+
102+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#use-a-custom-json-property-naming-policy).
103+
104+
]]></format>
105+
</remarks>
82106
</Docs>
83107
</Member>
84108
</Members>

‎xml/System.Text.Json/JsonReaderOptions.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,15 @@
1515
<Interfaces />
1616
<Docs>
1717
<summary>Provides the ability for the user to define custom behavior when reading JSON.</summary>
18-
<remarks>To be added.</remarks>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
For more information, see [How to serialize and deserialize JSON](~/docs/standard/serialization/system-text-json-how-to.md#use-utf8jsonreader).
24+
25+
]]></format>
26+
</remarks>
1927
</Docs>
2028
<Members>
2129
<Member MemberName="AllowTrailingCommas">
@@ -41,7 +49,7 @@
4149
<Docs>
4250
<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>
4351
<value>
44-
<see langword="true" /> if an exra comma is allowed; otherwise, <see langword="false" />.</value>
52+
<see langword="true" /> if an extra comma is allowed; otherwise, <see langword="false" />.</value>
4553
<remarks>
4654
<format type="text/markdown"><![CDATA[
4755

0 commit comments

Comments
 (0)