Skip to content

Improve XML documentation #62994

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
Dec 20, 2021
Merged

Improve XML documentation #62994

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
16 changes: 8 additions & 8 deletions ...aries/System.Text.Json/src/System/Text/Json/Serialization/JsonSerializer.Write.Element.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ namespace System.Text.Json
public static partial class JsonSerializer
{
/// <summary>
/// Converts the provided value into a <see cref="JsonDocument"/>.
/// Converts the provided value into a <see cref="JsonElement"/>.
/// </summary>
/// <typeparam name="TValue">The type of the value to serialize.</typeparam>
/// <returns>A <see cref="JsonDocument"/> representation of the JSON value.</returns>
/// <returns>A <see cref="JsonElement"/> representation of the JSON value.</returns>
/// <param name="value">The value to convert.</param>
/// <param name="options">Options to control the conversion behavior.</param>
/// <exception cref="NotSupportedException">
Expand All @@ -30,9 +30,9 @@ public static JsonElement SerializeToElement<TValue>(TValue value, JsonSerialize
}

/// <summary>
/// Converts the provided value into a <see cref="JsonDocument"/>.
/// Converts the provided value into a <see cref="JsonElement"/>.
/// </summary>
/// <returns>A <see cref="JsonDocument"/> representation of the value.</returns>
/// <returns>A <see cref="JsonElement"/> representation of the value.</returns>
/// <param name="value">The value to convert.</param>
/// <param name="inputType">The type of the <paramref name="value"/> to convert.</param>
/// <param name="options">Options to control the conversion behavior.</param>
Expand All @@ -55,10 +55,10 @@ public static JsonElement SerializeToElement(object? value, Type inputType, Json
}

/// <summary>
/// Converts the provided value into a <see cref="JsonDocument"/>.
/// Converts the provided value into a <see cref="JsonElement"/>.
/// </summary>
/// <typeparam name="TValue">The type of the value to serialize.</typeparam>
/// <returns>A <see cref="JsonDocument"/> representation of the value.</returns>
/// <returns>A <see cref="JsonElement"/> representation of the value.</returns>
/// <param name="value">The value to convert.</param>
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
/// <exception cref="NotSupportedException">
Expand All @@ -79,9 +79,9 @@ public static JsonElement SerializeToElement<TValue>(TValue value, JsonTypeInfo<
}

/// <summary>
/// Converts the provided value into a <see cref="JsonDocument"/>.
/// Converts the provided value into a <see cref="JsonElement"/>.
/// </summary>
/// <returns>A <see cref="JsonDocument"/> representation of the value.</returns>
/// <returns>A <see cref="JsonElement"/> representation of the value.</returns>
/// <param name="value">The value to convert.</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