Skip to content

Add missing System.Text.Json API docs #7180

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
eiriktsarpalis merged 1 commit into from
Sep 14, 2021
Merged

Add missing System.Text.Json API docs #7180

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
7 changes: 4 additions & 3 deletions xml/System.Text.Json.Nodes/JsonArray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,10 +541,11 @@ This member is an explicit interface member implementation. It can be used only
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" />
</Parameters>
<Docs>
<param name="writer">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" />.</param>
<param name="options">Options to control the serialization behavior.</param>
<summary>Write the <see cref="T:System.Text.Json.Nodes.JsonNode" /> into the provided <see cref="T:System.Text.Json.Utf8JsonWriter" /> as JSON.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
</Docs>
</Member>
</Members>
Expand Down
4 changes: 1 addition & 3 deletions xml/System.Text.Json.Nodes/JsonNode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,12 +125,10 @@
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TValue" />

@carlossanlop carlossanlop Sep 14, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this removal is fine since it didn't change between versions. Otherwise, we would be seeing a moniker attribute here.

@carlossanlop carlossanlop Sep 14, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should open a bug so the Docs build system is capable of removing these extra typeparameters that got renamed in the same version.

<TypeParameter Name="T" />
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<typeparam name="T">The type of the value to obtain from the <see cref="T:System.Text.Json.Nodes.JsonValue" />.</typeparam>
<summary>Gets the value for the current <see cref="T:System.Text.Json.Nodes.JsonValue" />.</summary>
<returns>A value converted from the <see cref="T:System.Text.Json.Nodes.JsonValue" /> instance.</returns>
Expand Down Expand Up @@ -2236,8 +2234,8 @@
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" />.</param>
<param name="options">Options to control the serialization behavior.</param>
<summary>Write the <see cref="T:System.Text.Json.Nodes.JsonNode" /> into the provided <see cref="T:System.Text.Json.Utf8JsonWriter" /> as JSON.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
<remarks>To be added.</remarks>

@carlossanlop carlossanlop Sep 14, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remarks go before exceptions. I suspect the build will revert this automatically.

</Docs>
</Member>
</Members>
Expand Down
7 changes: 4 additions & 3 deletions xml/System.Text.Json.Nodes/JsonObject.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,9 +587,10 @@ This member is an explicit interface member implementation. It can be used only
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" />
</Parameters>
<Docs>
<param name="writer">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" />.</param>
<param name="options">Options to control the serialization behavior.</param>
<summary>Write the <see cref="T:System.Text.Json.Nodes.JsonNode" /> into the provided <see cref="T:System.Text.Json.Utf8JsonWriter" /> as JSON.</summary>
<exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Instructs the System.Text.Json source generator to assume the specified options will be used at run time via <see cref="T:System.Text.Json.JsonSerializerOptions" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Text.Json/JsonSerializer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2116,7 +2116,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa
<Parameter Name="context" Type="System.Text.Json.Serialization.JsonSerializerContext" Index="3" FrameworkAlternate="net-6.0" />
</Parameters>
<Docs>
<param name="writer">To be added.</param>
<param name="writer">A JSON writer to write to.</param>
<param name="value">The value to convert and write.</param>
<param name="inputType">The type of the <paramref name="value" /> to convert.</param>
<param name="context">A metadata provider for serializable types.</param>
Expand Down Expand Up @@ -3182,7 +3182,7 @@ For more information, see [How to serialize and deserialize JSON](/dotnet/standa
<Parameter Name="jsonTypeInfo" Type="System.Text.Json.Serialization.Metadata.JsonTypeInfo&lt;TValue&gt;" Index="1" FrameworkAlternate="net-6.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<typeparam name="TValue">The type of the value to serialize.</typeparam>
<param name="value">The value to convert.</param>
<param name="jsonTypeInfo">Metadata about the type to convert.</param>
<summary>Converts the provided value into a <see cref="T:System.Byte" /> array.</summary>
Expand Down
2 changes: 1 addition & 1 deletion xml/ns-System.Text.Json.Nodes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Namespace Name="System.Text.Json.Nodes">
<Docs>
<summary>To be added.</summary>
<summary>Provides types for handling an in-memory writeable document object model (DOM) for random access of the JSON elements within a structured view of the data.</summary>
<remarks>To be added.</remarks>
</Docs>
</Namespace>