Skip to content

Automatically port System.Text.Json.Serialization.JsonConverterAttribute #2887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 5, 2019
Merged
Changes from all commits
Commits
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
34 changes: 23 additions & 11 deletions xml/System.Text.Json.Serialization/JsonConverterAttribute.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,20 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>When placed on a property or type, specifies the converter type to use.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The specified converter type must derive from <xref:System.Text.Json.Serialization.JsonConverter>.

When placed on a property, the specified converter will always be used.

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.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -36,7 +48,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -56,8 +68,8 @@
<Parameter Name="converterType" Type="System.Type" />
</Parameters>
<Docs>
<param name="converterType">To be added.</param>
<summary>To be added.</summary>
<param name="converterType">The type of the converter.</param>
<summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" /> with the specified converter type.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -77,8 +89,8 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<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>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -101,11 +113,11 @@
<Parameter Name="typeToConvert" Type="System.Type" />
</Parameters>
<Docs>
<param name="typeToConvert">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="typeToConvert">The type of the converter.</param>
<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>
<returns>The custom converter.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>