Skip to content

Update JsonSerializerOptions.AddContext documentation. #8792

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.

Sign up for GitHub

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 1 commit into from
Jan 17, 2023
Merged

Update JsonSerializerOptions.AddContext documentation. #8792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion xml/System.Text.Json.Serialization.Metadata/JsonTypeInfoResolver.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Can be used to combine multiple <xref:System.Text.Json.Serialization.JsonSeriali
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="resolvers" /> or any of its elements is <see langword="null" />.</exception>
<paramref name="resolvers" /> is <see langword="null" />.</exception>
</Docs>
</Member>
</Members>
Expand Down
5 changes: 4 additions & 1 deletion xml/System.Text.Json/JsonSerializerOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,17 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa
<Parameters />
<Docs>
<typeparam name="TContext">The generic definition of the specified context type.</typeparam>
<summary>Binds current <see cref="T:System.Text.Json.JsonSerializerOptions" /> instance with a new instance of the specified <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" /> type.</summary>
<summary>Appends a new <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" /> to the metadata resolution of the current <see cref="T:System.Text.Json.JsonSerializerOptions" /> instance.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

When serializing and deserializing types using the options instance, metadata for the types will be fetched from the context instance.

The methods supports adding multiple contexts per options instance. Metadata will be resolved in the order of configuration,
similar to how <xref:System.Text.Json.Serialization.Metadata.JsonTypeInfoResolver.Combine /> resolves metadata.

]]></format>
</remarks>
</Docs>
Expand Down