Replace "stream" in reader/writer classes' comments

XML documentation comments for JsonReader, JsonWriter and derived
classes often mention "underlying streams". In most cases however,
these types don't operate directly on Streams, but through other types
such as TextReader and TextWriter.

This commit changes these comments to reflect more accurately what
kind of objects the various JSON reader / writer classes operate on.

Additionally the effect of JsonReader.CloseInput and JsonWriter.Close-
Output is made more explicit in the comments for the Close methods.
This commit is contained in:
stakx
2016-12-24 02:26:16 +01:00
parent cf6a917a46
commit 1eb391c147
10 changed files with 62 additions and 57 deletions
+4 -4
View File
@@ -994,7 +994,7 @@ namespace Newtonsoft.Json
/// <summary>
/// Serializes the specified <see cref="Object"/> and writes the JSON structure
/// to a <see cref="Stream"/> using the specified <see cref="TextWriter"/>.
/// using the specified <see cref="TextWriter"/>.
/// </summary>
/// <param name="textWriter">The <see cref="TextWriter"/> used to write the JSON structure.</param>
/// <param name="value">The <see cref="Object"/> to serialize.</param>
@@ -1005,7 +1005,7 @@ namespace Newtonsoft.Json
/// <summary>
/// Serializes the specified <see cref="Object"/> and writes the JSON structure
/// to a <see cref="Stream"/> using the specified <see cref="TextWriter"/>.
/// using the specified <see cref="JsonWriter"/>.
/// </summary>
/// <param name="jsonWriter">The <see cref="JsonWriter"/> used to write the JSON structure.</param>
/// <param name="value">The <see cref="Object"/> to serialize.</param>
@@ -1021,7 +1021,7 @@ namespace Newtonsoft.Json
/// <summary>
/// Serializes the specified <see cref="Object"/> and writes the JSON structure
/// to a <c>Stream</c> using the specified <see cref="TextWriter"/>.
/// using the specified <see cref="TextWriter"/>.
/// </summary>
/// <param name="textWriter">The <see cref="TextWriter"/> used to write the JSON structure.</param>
/// <param name="value">The <see cref="Object"/> to serialize.</param>
@@ -1037,7 +1037,7 @@ namespace Newtonsoft.Json
/// <summary>
/// Serializes the specified <see cref="Object"/> and writes the JSON structure
/// to a <c>Stream</c> using the specified <see cref="JsonWriter"/>.
/// using the specified <see cref="JsonWriter"/>.
/// </summary>
/// <param name="jsonWriter">The <see cref="JsonWriter"/> used to write the JSON structure.</param>
/// <param name="value">The <see cref="Object"/> to serialize.</param>