Skip to content

Commit 358cdf9

Browse files
bjornen77Björn Sjögren
andauthored
Improve XML documentation (#62994)
Corrected return value type in XML documentation. Fix #62993 Co-authored-by: Björn Sjögren <bjs@hms.se>
1 parent 834b278 commit 358cdf9

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/libraries/System.Text.Json/src/System/Text/Json/Serialization/JsonSerializer.Write.Element.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ namespace System.Text.Json
1111
public static partial class JsonSerializer
1212
{
1313
/// <summary>
14-
/// Converts the provided value into a <see cref="JsonDocument"/>.
14+
/// Converts the provided value into a <see cref="JsonElement"/>.
1515
/// </summary>
1616
/// <typeparam name="TValue">The type of the value to serialize.</typeparam>
17-
/// <returns>A <see cref="JsonDocument"/> representation of the JSON value.</returns>
17+
/// <returns>A <see cref="JsonElement"/> representation of the JSON value.</returns>
1818
/// <param name="value">The value to convert.</param>
1919
/// <param name="options">Options to control the conversion behavior.</param>
2020
/// <exception cref="NotSupportedException">
@@ -30,9 +30,9 @@ public static JsonElement SerializeToElement<TValue>(TValue value, JsonSerialize
3030
}
3131

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

5757
/// <summary>
58-
/// Converts the provided value into a <see cref="JsonDocument"/>.
58+
/// Converts the provided value into a <see cref="JsonElement"/>.
5959
/// </summary>
6060
/// <typeparam name="TValue">The type of the value to serialize.</typeparam>
61-
/// <returns>A <see cref="JsonDocument"/> representation of the value.</returns>
61+
/// <returns>A <see cref="JsonElement"/> representation of the value.</returns>
6262
/// <param name="value">The value to convert.</param>
6363
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
6464
/// <exception cref="NotSupportedException">
@@ -79,9 +79,9 @@ public static JsonElement SerializeToElement<TValue>(TValue value, JsonTypeInfo<
7979
}
8080

8181
/// <summary>
82-
/// Converts the provided value into a <see cref="JsonDocument"/>.
82+
/// Converts the provided value into a <see cref="JsonElement"/>.
8383
/// </summary>
84-
/// <returns>A <see cref="JsonDocument"/> representation of the value.</returns>
84+
/// <returns>A <see cref="JsonElement"/> representation of the value.</returns>
8585
/// <param name="value">The value to convert.</param>
8686
/// <param name="inputType">The type of the <paramref name="value"/> to convert.</param>
8787
/// <param name="context">A metadata provider for serializable types.</param>

0 commit comments

Comments
 (0)