Skip to content

Commit 945f718

Browse files
carlossanlopRon Petrusha
andcommitted
Automatically port System.Text.Json.Serialization.JsonStringEnumConverter (#2878)
* Automatically port System.Text.Json.Serialization.JsonStringEnumConverter * suggestions by Jozkee Co-Authored-By: David Cantu <[email protected]> * suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]>
1 parent fbf6333 commit 945f718

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

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

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,16 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
18-
<remarks>To be added.</remarks>
17+
<summary>Converts enumeration values to and from strings.</summary>
18+
<remarks>
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
Reading is case insensitive. Writing can be customized by using a <xref:System.Text.Json.JsonNamingPolicy>.
24+
25+
]]></format>
26+
</remarks>
1927
</Docs>
2028
<Members>
2129
<Member MemberName=".ctor">
@@ -31,7 +39,7 @@
3139
</AssemblyInfo>
3240
<Parameters />
3341
<Docs>
34-
<summary>To be added.</summary>
42+
<summary>Initializes an instance of the <see cref="T:System.Text.Json.Serialization.JsonStringEnumConverter" /> class with the default naming policy that allows integer values.</summary>
3543
<remarks>To be added.</remarks>
3644
</Docs>
3745
</Member>
@@ -51,9 +59,9 @@
5159
<Parameter Name="allowIntegerValues" Type="System.Boolean" />
5260
</Parameters>
5361
<Docs>
54-
<param name="namingPolicy">To be added.</param>
55-
<param name="allowIntegerValues">To be added.</param>
56-
<summary>To be added.</summary>
62+
<param name="namingPolicy">The optional naming policy for writing enum values.</param>
63+
<param name="allowIntegerValues"><see langword="true" /> to allow undefined enum values; otherwise, <see langword="false" />. When <see langword="true" />, if an enum value isn't defined, it will output as a number rather than a string.</param>
64+
<summary>Initializes an instance of the <see cref="T:System.Text.Json.Serialization.JsonStringEnumConverter" /> class with a specified naming policy and a value that indicates whether undefined enumeration values are allowed.</summary>
5765
<remarks>To be added.</remarks>
5866
</Docs>
5967
</Member>
@@ -108,4 +116,4 @@
108116
</Docs>
109117
</Member>
110118
</Members>
111-
</Type>
119+
</Type>

0 commit comments

Comments
 (0)