Skip to content

Port System.Text.Json triple slash to docs #7094

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 3 commits into from
Sep 8, 2021
Merged

Port System.Text.Json triple slash to docs #7094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f101fe
Port System.Text.Json triple slash to docs
carlossanlop Sep 3, 2021
04e2243
fix warnings
carlossanlop Sep 3, 2021
f2f4e78
Apply suggestions from code review
carlossanlop Sep 8, 2021
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
12 changes: 7 additions & 5 deletions xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,12 +821,14 @@
<Parameter Name="objectInfo" Type="System.Text.Json.Serialization.Metadata.JsonObjectInfoValues&lt;T&gt;" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="options">To be added.</param>
<param name="objectInfo">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the class or struct.</typeparam>
<param name="options">The <see cref="T:System.Text.Json.JsonSerializerOptions" /> to initialize the metadata with.</param>
<param name="objectInfo">Provides serialization metadata about an object type with constructors, properties, and fields.</param>
<summary>Creates metadata for a complex class or struct.</summary>
<returns>A <see cref="T:System.Text.Json.Serialization.Metadata.JsonTypeInfo`1" /> instance representing the class or struct.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> or <paramref name="objectInfo" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="CreatePropertyInfo&lt;T&gt;">
Expand Down
16 changes: 8 additions & 8 deletions xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
</Base>
<Interfaces />
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>To be added.</summary>
<typeparam name="T">The object type to serialize or deserialize.</typeparam>
<summary>Provides serialization metadata about an object type with constructors, properties, and fields.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -55,7 +55,7 @@
<ReturnType>System.Func&lt;System.Text.Json.Serialization.Metadata.JsonParameterInfoValues[]&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Provides a mechanism to initialize metadata for a parameterized constructor of the class or struct to be used when deserializing.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -76,7 +76,7 @@
<ReturnType>System.Text.Json.Serialization.JsonNumberHandling</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets an object that specifies how number properties and fields should be processed when serializing and deserializing.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -97,7 +97,7 @@
<ReturnType>System.Func&lt;T&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a mechanism to create an instance of the class or struct using a parameterless constructor during deserialization.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -118,7 +118,7 @@
<ReturnType>System.Func&lt;System.Object[],T&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a mechanism to create an instance of the class or struct using a parameterized constructor during deserialization.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -139,7 +139,7 @@
<ReturnType>System.Func&lt;System.Text.Json.Serialization.JsonSerializerContext,System.Text.Json.Serialization.Metadata.JsonPropertyInfo[]&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a mechanism to initialize metadata for properties and fields of the class or struct.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -160,7 +160,7 @@
<ReturnType>System.Action&lt;System.Text.Json.Utf8JsonWriter,T&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a serialization implementation for instances of the class or struct that assumes options specified by <see cref="T:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
12 changes: 6 additions & 6 deletions xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides information about a constructor parameter required for JSON deserialization.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -51,7 +51,7 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the default value of the parameter.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -72,7 +72,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a value that specifies whether a default value was specified for the parameter.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -93,7 +93,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the name of the parameter.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -114,7 +114,7 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the type of the parameter.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -135,7 +135,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the zero-based position of the parameter in the formal parameter list.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
38 changes: 27 additions & 11 deletions xml/System.Text.Json.Serialization/JsonConverter`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,12 +184,20 @@ For more information, see [How to write custom converters for JSON serialization
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" Index="2" FrameworkAlternate="net-6.0" />
</Parameters>
<Docs>
<param name="reader">To be added.</param>
<param name="typeToConvert">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read from.</param>
<param name="typeToConvert">The type to convert.</param>
<param name="options">The options to use when reading the value.</param>
<summary>Reads a dictionary key from a JSON property name.</summary>
<returns>The value that was converted.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This method should be overridden in custom converters of types used in deserialized dictionary keys.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Write">
Expand Down Expand Up @@ -254,11 +262,19 @@ For more information, see [How to write custom converters for JSON serialization
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" Index="2" FrameworkAlternate="net-6.0" />
</Parameters>
<Docs>
<param name="writer">To be added.</param>
<param name="value">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write to.</param>
<param name="value">The value to convert. The value of <see cref="P:System.Text.Json.Serialization.JsonConverter`1.HandleNull" /> determines if the converter handles <see langword="null" /> values.</param>
<param name="options">The options to use when writing the value.</param>
<summary>Writes a dictionary key as a JSON property name.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This method should be overridden in custom converters of types used in serialized dictionary keys.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading