Skip to content

Commit 50ae4fe

Browse files
carlossanlopjozkee
authored andcommitted
Automatically port System.Text.Json.Serialization.JsonConverter`1 (#2888)
* Automatically port System.Text.Json.Serialization.JsonConverter`1 * Applied edits. * suggestion by Jozkee Co-Authored-By: David Cantu <[email protected]>
1 parent 2edad53 commit 50ae4fe

File tree

1 file changed

+34
-18
lines changed

1 file changed

+34
-18
lines changed

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

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
</Base>
1818
<Interfaces />
1919
<Docs>
20-
<typeparam name="T">To be added.</typeparam>
21-
<summary>To be added.</summary>
20+
<typeparam name="T">The type of object or value handled by the converter.</typeparam>
21+
<summary>Converts an object or value to or from JSON.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -35,7 +35,7 @@
3535
</AssemblyInfo>
3636
<Parameters />
3737
<Docs>
38-
<summary>To be added.</summary>
38+
<summary>Initializes a new <see cref="T:System.Text.Json.Serialization.JsonConverter`1" /> instance.</summary>
3939
<remarks>To be added.</remarks>
4040
</Docs>
4141
</Member>
@@ -58,10 +58,18 @@
5858
<Parameter Name="typeToConvert" Type="System.Type" />
5959
</Parameters>
6060
<Docs>
61-
<param name="typeToConvert">To be added.</param>
62-
<summary>To be added.</summary>
63-
<returns>To be added.</returns>
64-
<remarks>To be added.</remarks>
61+
<param name="typeToConvert">The type to compare against.</param>
62+
<summary>Determines whether the specified type can be converted.</summary>
63+
<returns><see langword="true" /> if the type can be converted; otherwise, <see langword="false" />.</returns>
64+
<remarks>
65+
<format type="text/markdown"><![CDATA[
66+
67+
## Remarks
68+
69+
The default implementation is to return `true` when `typeToConvert` equals `typeof(T)`.
70+
71+
]]></format>
72+
</remarks>
6573
</Docs>
6674
</Member>
6775
<Member MemberName="Read">
@@ -85,11 +93,11 @@
8593
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" />
8694
</Parameters>
8795
<Docs>
88-
<param name="reader">To be added.</param>
89-
<param name="typeToConvert">To be added.</param>
90-
<param name="options">To be added.</param>
91-
<summary>To be added.</summary>
92-
<returns>To be added.</returns>
96+
<param name="reader">The reader.</param>
97+
<param name="typeToConvert">The type to convert.</param>
98+
<param name="options">An object that specifies serialization options to use.</param>
99+
<summary>Reads and converts the JSON to type <typeparamref name="T" />.</summary>
100+
<returns>The converted value.</returns>
93101
<remarks>To be added.</remarks>
94102
</Docs>
95103
</Member>
@@ -114,12 +122,20 @@
114122
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" />
115123
</Parameters>
116124
<Docs>
117-
<param name="writer">To be added.</param>
118-
<param name="value">To be added.</param>
119-
<param name="options">To be added.</param>
120-
<summary>To be added.</summary>
121-
<remarks>To be added.</remarks>
125+
<param name="writer">The writer to write to.</param>
126+
<param name="value">The value to convert to JSON.</param>
127+
<param name="options">An object that specifies serialization options to use.</param>
128+
<summary>Writes a specified value as JSON.</summary>
129+
<remarks>
130+
<format type="text/markdown"><![CDATA[
131+
132+
## Remarks
133+
134+
A converter may throw any exception, but it should throw <xref:System.Text.Json.JsonException> when the JSON cannot be created.
135+
136+
]]></format>
137+
</remarks>
122138
</Docs>
123139
</Member>
124140
</Members>
125-
</Type>
141+
</Type>

0 commit comments

Comments
 (0)