Skip to content

Commit

Permalink
More JSON xml updates (#57022)
Browse files Browse the repository at this point in the history
  • Loading branch information
danmoseley authored Aug 9, 2021
1 parent fec5f22 commit 6b2f051
Show file tree
Hide file tree
Showing 19 changed files with 107 additions and 107 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace System.Text.Json.Serialization
{
/// <summary>
/// The <see cref="Json.JsonNamingPolicy"/> to be used at run-time.
/// The <see cref="Json.JsonNamingPolicy"/> to be used at run time.
/// </summary>
#if BUILDING_SOURCE_GENERATOR
internal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace System.Text.Json.Serialization
{
/// <summary>
/// Instructs the System.Text.Json source generator to assume the specified
/// options will be used at run-time via <see cref="JsonSerializerOptions"/>.
/// options will be used at run time via <see cref="JsonSerializerOptions"/>.
/// </summary>
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
#if BUILDING_SOURCE_GENERATOR
Expand All @@ -31,7 +31,7 @@ sealed class JsonSourceGenerationOptionsAttribute : JsonAttribute
public bool IgnoreReadOnlyProperties { get; set; }

/// <summary>
/// Specifies whether to ignore custom converters provided at run-time.
/// Specifies whether to ignore custom converters provided at run time.
/// </summary>
public bool IgnoreRuntimeCustomConverters { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ private static async Task<JsonDocument> ParseAsyncCore(
}

/// <summary>
/// Parse text representing a single JSON value into a JsonDocument.
/// Parses text representing a single JSON value into a JsonDocument.
/// </summary>
/// <remarks>
/// The <see cref="ReadOnlyMemory{T}"/> value may be used for the entire lifetime of the
Expand Down Expand Up @@ -298,7 +298,7 @@ internal static JsonDocument ParseValue(ReadOnlyMemory<char> json, JsonDocumentO
}

/// <summary>
/// Parse text representing a single JSON value into a JsonDocument.
/// Parses text representing a single JSON value into a JsonDocument.
/// </summary>
/// <param name="json">JSON text to parse.</param>
/// <param name="options">Options to control the reader behavior during parsing.</param>
Expand Down Expand Up @@ -340,7 +340,7 @@ public static JsonDocument Parse(string json, JsonDocumentOptions options = defa
/// </para>
///
/// <para>
/// Upon completion of this method <paramref name="reader"/> will be positioned at the
/// Upon completion of this method, <paramref name="reader"/> will be positioned at the
/// final token in the JSON value. If an exception is thrown, or <see langword="false"/>
/// is returned, the reader is reset to the state it was in when the method was called.
/// </para>
Expand Down Expand Up @@ -380,8 +380,8 @@ public static bool TryParseValue(ref Utf8JsonReader reader, [NotNullWhen(true)]
/// </para>
///
/// <para>
/// Upon completion of this method <paramref name="reader"/> will be positioned at the
/// final token in the JSON value. If an exception is thrown the reader is reset to
/// Upon completion of this method, <paramref name="reader"/> will be positioned at the
/// final token in the JSON value. If an exception is thrown, the reader is reset to
/// the state it was in when the method was called.
/// </para>
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ public readonly partial struct JsonElement
/// </para>
///
/// <para>
/// Upon completion of this method <paramref name="reader"/> will be positioned at the
/// final token in the JSON value. If an exception is thrown the reader is reset to
/// Upon completion of this method, <paramref name="reader"/> will be positioned at the
/// final token in the JSON value. If an exception is thrown, the reader is reset to
/// the state it was in when the method was called.
/// </para>
///
Expand Down Expand Up @@ -90,7 +90,7 @@ internal static JsonElement ParseValue(string json, JsonDocumentOptions options)
/// </para>
///
/// <para>
/// Upon completion of this method <paramref name="reader"/> will be positioned at the
/// Upon completion of this method, <paramref name="reader"/> will be positioned at the
/// final token in the JSON value. If an exception is thrown, or <see langword="false"/>
/// is returned, the reader is reset to the state it was in when the method was called.
/// </para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public abstract partial class JsonNode
/// the start of the value.
/// </para>
/// <para>
/// Upon completion of this method <paramref name="reader"/> will be positioned at the
/// Upon completion of this method, <paramref name="reader"/> will be positioned at the
/// final token in the JSON value. If an exception is thrown, the reader is reset to the state it was in when the method was called.
/// </para>
/// <para>
Expand All @@ -50,7 +50,7 @@ public abstract partial class JsonNode
}

/// <summary>
/// Parse text representing a single JSON value.
/// Parses text representing a single JSON value.
/// </summary>
/// <param name="json">JSON text to parse.</param>
/// <param name="nodeOptions">Options to control the node behavior after parsing.</param>
Expand Down Expand Up @@ -79,7 +79,7 @@ public abstract partial class JsonNode
}

/// <summary>
/// Parse text representing a single JSON value.
/// Parses text representing a single JSON value.
/// </summary>
/// <param name="utf8Json">JSON text to parse.</param>
/// <param name="nodeOptions">Options to control the node behavior after parsing.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public bool GetBoolean()
/// <seealso cref="TokenType" />
/// </exception>
/// <exception cref="FormatException">
/// Thrown when the JSON string contains data outside of the expected Base64 range, or if it contains invalid/more than two padding characters,
/// The JSON string contains data outside of the expected Base64 range, or if it contains invalid/more than two padding characters,
/// or is incomplete (i.e. the JSON string length is not a multiple of 4).
/// </exception>
public byte[] GetBytesFromBase64()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ namespace System.Text.Json
public static partial class JsonSerializer
{
/// <summary>
/// Parse the UTF-8 encoded text representing a single JSON value into a <typeparamref name="TValue"/>.
/// Parses the UTF-8 encoded text representing a single JSON value into a <typeparamref name="TValue"/>.
/// </summary>
/// <returns>A <typeparamref name="TValue"/> representation of the JSON value.</returns>
/// <param name="utf8Json">JSON text to parse.</param>
/// <param name="options">Options to control the behavior during parsing.</param>
/// <exception cref="JsonException">
/// Thrown when the JSON is invalid,
/// The JSON is invalid,
/// <typeparamref name="TValue"/> is not compatible with the JSON,
/// or when there is remaining data in the Stream.
/// </exception>
Expand All @@ -29,7 +29,7 @@ public static partial class JsonSerializer
=> ReadUsingOptions<TValue>(utf8Json, typeof(TValue), options);

/// <summary>
/// Parse the UTF-8 encoded text representing a single JSON value into a <paramref name="returnType"/>.
/// Parses the UTF-8 encoded text representing a single JSON value into a <paramref name="returnType"/>.
/// </summary>
/// <returns>A <paramref name="returnType"/> representation of the JSON value.</returns>
/// <param name="utf8Json">JSON text to parse.</param>
Expand All @@ -39,7 +39,7 @@ public static partial class JsonSerializer
/// <paramref name="returnType"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="JsonException">
/// Thrown when the JSON is invalid,
/// The JSON is invalid,
/// <paramref name="returnType"/> is not compatible with the JSON,
/// or when there is remaining data in the Stream.
/// </exception>
Expand All @@ -59,13 +59,13 @@ public static partial class JsonSerializer
}

/// <summary>
/// Parse the UTF-8 encoded text representing a single JSON value into a <typeparamref name="TValue"/>.
/// Parses the UTF-8 encoded text representing a single JSON value into a <typeparamref name="TValue"/>.
/// </summary>
/// <returns>A <typeparamref name="TValue"/> representation of the JSON value.</returns>
/// <param name="utf8Json">JSON text to parse.</param>
/// <param name="jsonTypeInfo">Metadata about the type to convert.</param>
/// <exception cref="JsonException">
/// Thrown when the JSON is invalid,
/// The JSON is invalid,
/// <typeparamref name="TValue"/> is not compatible with the JSON,
/// or when there is remaining data in the Stream.
/// </exception>
Expand All @@ -84,7 +84,7 @@ public static partial class JsonSerializer
}

/// <summary>
/// Parse the UTF-8 encoded text representing a single JSON value into a <paramref name="returnType"/>.
/// Parses the UTF-8 encoded text representing a single JSON value into a <paramref name="returnType"/>.
/// </summary>
/// <returns>A <paramref name="returnType"/> representation of the JSON value.</returns>
/// <param name="utf8Json">JSON text to parse.</param>
Expand All @@ -94,7 +94,7 @@ public static partial class JsonSerializer
/// <paramref name="returnType"/> is <see langword="null"/>.
/// </exception>
/// <exception cref="JsonException">
/// Thrown when the JSON is invalid,
/// The JSON is invalid,
/// <paramref name="returnType"/> is not compatible with the JSON,
/// or when there is remaining data in the Stream.
/// </exception>
Expand Down
Loading

0 comments on commit 6b2f051

Please sign in to comment.