Skip to content

Commit 5337181

Browse files
carlossanlopRon Petrusha
authored andcommitted
Automatically port System.Text.Json.Serialization.JsonConverterAttribute (#2887)
* Automatically port System.Text.Json.Serialization.JsonConverterAttribute * suggestions by rpetrusha and Jozkee Co-Authored-By: Ron Petrusha <[email protected]> Co-Authored-By: David Cantu <[email protected]> * missing value
1 parent b36bcbd commit 5337181

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

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

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,20 @@
1919
</Attribute>
2020
</Attributes>
2121
<Docs>
22-
<summary>To be added.</summary>
23-
<remarks>To be added.</remarks>
22+
<summary>When placed on a property or type, specifies the converter type to use.</summary>
23+
<remarks>
24+
<format type="text/markdown"><![CDATA[
25+
26+
## Remarks
27+
28+
The specified converter type must derive from <xref:System.Text.Json.Serialization.JsonConverter>.
29+
30+
When placed on a property, the specified converter will always be used.
31+
32+
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+
34+
]]></format>
35+
</remarks>
2436
</Docs>
2537
<Members>
2638
<Member MemberName=".ctor">
@@ -36,7 +48,7 @@
3648
</AssemblyInfo>
3749
<Parameters />
3850
<Docs>
39-
<summary>To be added.</summary>
51+
<summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" />.</summary>
4052
<remarks>To be added.</remarks>
4153
</Docs>
4254
</Member>
@@ -56,8 +68,8 @@
5668
<Parameter Name="converterType" Type="System.Type" />
5769
</Parameters>
5870
<Docs>
59-
<param name="converterType">To be added.</param>
60-
<summary>To be added.</summary>
71+
<param name="converterType">The type of the converter.</param>
72+
<summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" /> with the specified converter type.</summary>
6173
<remarks>To be added.</remarks>
6274
</Docs>
6375
</Member>
@@ -77,8 +89,8 @@
7789
<ReturnType>System.Type</ReturnType>
7890
</ReturnValue>
7991
<Docs>
80-
<summary>To be added.</summary>
81-
<value>To be added.</value>
92+
<summary>Gets the type of the <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute"/>, or <see langword="null" /> if it was created without a type.</summary>
93+
<value>The type of the <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute"/>, or <see langword="null" /> if it was created without a type.</value>
8294
<remarks>To be added.</remarks>
8395
</Docs>
8496
</Member>
@@ -101,11 +113,11 @@
101113
<Parameter Name="typeToConvert" Type="System.Type" />
102114
</Parameters>
103115
<Docs>
104-
<param name="typeToConvert">To be added.</param>
105-
<summary>To be added.</summary>
106-
<returns>To be added.</returns>
116+
<param name="typeToConvert">The type of the converter.</param>
117+
<summary>When overridden in a derived class and <see cref="P:System.Text.Json.Serialization.JsonConverterAttribute.ConverterType" /> is <see langword="null" />, allows the derived class to create a <see cref="T:System.Text.Json.Serialization.JsonConverter"/> in order to pass additional state.</summary>
118+
<returns>The custom converter.</returns>
107119
<remarks>To be added.</remarks>
108120
</Docs>
109121
</Member>
110122
</Members>
111-
</Type>
123+
</Type>

0 commit comments

Comments
 (0)