diff --git a/Src/Newtonsoft.Json/Bson/BsonReader.cs b/Src/Newtonsoft.Json/Bson/BsonReader.cs index 0c8559ed..20d6edb3 100644 --- a/Src/Newtonsoft.Json/Bson/BsonReader.cs +++ b/Src/Newtonsoft.Json/Bson/BsonReader.cs @@ -85,7 +85,7 @@ namespace Newtonsoft.Json.Bson } /// - /// Gets or sets a value indicating whether binary data reading should compatible with incorrect Json.NET 3.5 written binary. + /// Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. /// /// /// true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. diff --git a/Src/Newtonsoft.Json/Bson/BsonWriter.cs b/Src/Newtonsoft.Json/Bson/BsonWriter.cs index 690babe3..39667514 100644 --- a/Src/Newtonsoft.Json/Bson/BsonWriter.cs +++ b/Src/Newtonsoft.Json/Bson/BsonWriter.cs @@ -103,7 +103,7 @@ namespace Newtonsoft.Json.Bson } /// - /// Writes out a comment /*...*/ containing the specified text. + /// Writes a comment /*...*/ containing the specified text. /// /// Text to place inside the comment. public override void WriteComment(string text) diff --git a/Src/Newtonsoft.Json/ConstructorHandling.cs b/Src/Newtonsoft.Json/ConstructorHandling.cs index 2455d61d..e710744c 100644 --- a/Src/Newtonsoft.Json/ConstructorHandling.cs +++ b/Src/Newtonsoft.Json/ConstructorHandling.cs @@ -31,7 +31,7 @@ namespace Newtonsoft.Json public enum ConstructorHandling { /// - /// First attempt to use the public default constructor, then fall back to single parameterized constructor, then the non-public default constructor. + /// First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. /// Default = 0, diff --git a/Src/Newtonsoft.Json/Converters/CustomCreationConverter.cs b/Src/Newtonsoft.Json/Converters/CustomCreationConverter.cs index c373b0c3..dbef8f85 100644 --- a/Src/Newtonsoft.Json/Converters/CustomCreationConverter.cs +++ b/Src/Newtonsoft.Json/Converters/CustomCreationConverter.cs @@ -30,7 +30,7 @@ using Newtonsoft.Json.Utilities; namespace Newtonsoft.Json.Converters { /// - /// Create a custom object + /// Creates a custom object. /// /// The object type to convert. public abstract class CustomCreationConverter : JsonConverter diff --git a/Src/Newtonsoft.Json/Converters/EntityKeyMemberConverter.cs b/Src/Newtonsoft.Json/Converters/EntityKeyMemberConverter.cs index 87250d84..0211a92d 100644 --- a/Src/Newtonsoft.Json/Converters/EntityKeyMemberConverter.cs +++ b/Src/Newtonsoft.Json/Converters/EntityKeyMemberConverter.cs @@ -32,7 +32,7 @@ using Newtonsoft.Json.Utilities; namespace Newtonsoft.Json.Converters { /// - /// Converts an Entity Framework EntityKey to and from JSON. + /// Converts an Entity Framework EntityKey to and from JSON. /// public class EntityKeyMemberConverter : JsonConverter { diff --git a/Src/Newtonsoft.Json/Converters/ExpandoObjectConverter.cs b/Src/Newtonsoft.Json/Converters/ExpandoObjectConverter.cs index 4ca6a612..a20a9640 100644 --- a/Src/Newtonsoft.Json/Converters/ExpandoObjectConverter.cs +++ b/Src/Newtonsoft.Json/Converters/ExpandoObjectConverter.cs @@ -36,7 +36,7 @@ using Newtonsoft.Json.Utilities; namespace Newtonsoft.Json.Converters { /// - /// Converts an ExpandoObject to and from JSON. + /// Converts an to and from JSON. /// public class ExpandoObjectConverter : JsonConverter { diff --git a/Src/Newtonsoft.Json/Converters/XmlNodeConverter.cs b/Src/Newtonsoft.Json/Converters/XmlNodeConverter.cs index 61411cd1..d778ef85 100644 --- a/Src/Newtonsoft.Json/Converters/XmlNodeConverter.cs +++ b/Src/Newtonsoft.Json/Converters/XmlNodeConverter.cs @@ -986,9 +986,9 @@ namespace Newtonsoft.Json.Converters private const string JsonNamespaceUri = "http://james.newtonking.com/projects/json"; /// - /// Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produces multiple root elements. + /// Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. /// - /// The name of the deserialize root element. + /// The name of the deserialized root element. public string DeserializeRootElementName { get; set; } /// @@ -2004,7 +2004,7 @@ namespace Newtonsoft.Json.Converters } /// - /// Checks if the attributeName is a namespace attribute. + /// Checks if the is a namespace attribute. /// /// Attribute name to test. /// The attribute name prefix if it has one, otherwise an empty string. diff --git a/Src/Newtonsoft.Json/DefaultValueHandling.cs b/Src/Newtonsoft.Json/DefaultValueHandling.cs index a63adf94..4b5312b8 100644 --- a/Src/Newtonsoft.Json/DefaultValueHandling.cs +++ b/Src/Newtonsoft.Json/DefaultValueHandling.cs @@ -46,7 +46,7 @@ namespace Newtonsoft.Json /// /// Ignore members where the member value is the same as the member's default value when serializing objects - /// so that is is not written to JSON. + /// so that it is not written to JSON. /// This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, /// decimals and floating point numbers; and false for booleans). The default value ignored can be changed by /// placing the on the property. @@ -60,7 +60,7 @@ namespace Newtonsoft.Json /// /// Ignore members where the member value is the same as the member's default value when serializing objects - /// and sets members to their default value when deserializing. + /// and set members to their default value when deserializing. /// IgnoreAndPopulate = Ignore | Populate } diff --git a/Src/Newtonsoft.Json/FloatFormatHandling.cs b/Src/Newtonsoft.Json/FloatFormatHandling.cs index 1c7f424b..51c4603e 100644 --- a/Src/Newtonsoft.Json/FloatFormatHandling.cs +++ b/Src/Newtonsoft.Json/FloatFormatHandling.cs @@ -37,7 +37,7 @@ namespace Newtonsoft.Json String = 0, /// - /// Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + /// Write special floating point values as symbols in JSON, e.g. "NaN", "Infinity", "-Infinity". /// Note that this will produce non-valid JSON. /// Symbol = 1, diff --git a/Src/Newtonsoft.Json/FormatterAssemblyStyle.cs b/Src/Newtonsoft.Json/FormatterAssemblyStyle.cs index d08cc337..a42645db 100644 --- a/Src/Newtonsoft.Json/FormatterAssemblyStyle.cs +++ b/Src/Newtonsoft.Json/FormatterAssemblyStyle.cs @@ -9,7 +9,7 @@ namespace System.Runtime.Serialization.Formatters public enum FormatterAssemblyStyle { /// - /// In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method is used to load the assembly. + /// In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method is used to load the assembly. /// Simple = 0, diff --git a/Src/Newtonsoft.Json/IArrayPool.cs b/Src/Newtonsoft.Json/IArrayPool.cs index 3d5037e5..15717f05 100644 --- a/Src/Newtonsoft.Json/IArrayPool.cs +++ b/Src/Newtonsoft.Json/IArrayPool.cs @@ -7,7 +7,7 @@ public interface IArrayPool { /// - /// Rent a array from the pool. This array must be returned when it is no longer needed. + /// Rent an array from the pool. This array must be returned when it is no longer needed. /// /// The minimum required length of the array. The returned array may be longer. /// The rented array from the pool. This array must be returned when it is no longer needed. diff --git a/Src/Newtonsoft.Json/IJsonLineInfo.cs b/Src/Newtonsoft.Json/IJsonLineInfo.cs index b71aedf7..e261c7d4 100644 --- a/Src/Newtonsoft.Json/IJsonLineInfo.cs +++ b/Src/Newtonsoft.Json/IJsonLineInfo.cs @@ -34,20 +34,20 @@ namespace Newtonsoft.Json /// Gets a value indicating whether the class can return line information. /// /// - /// true if LineNumber and LinePosition can be provided; otherwise, false. + /// true if and can be provided; otherwise, false. /// bool HasLineInfo(); /// /// Gets the current line number. /// - /// The current line number or 0 if no line information is available (for example, HasLineInfo returns false). + /// The current line number or 0 if no line information is available (for example, when returns false). int LineNumber { get; } /// /// Gets the current line position. /// - /// The current line position or 0 if no line information is available (for example, HasLineInfo returns false). + /// The current line position or 0 if no line information is available (for example, when returns false). int LinePosition { get; } } } \ No newline at end of file diff --git a/Src/Newtonsoft.Json/JsonArrayAttribute.cs b/Src/Newtonsoft.Json/JsonArrayAttribute.cs index bbfc90d9..ce4a77e6 100644 --- a/Src/Newtonsoft.Json/JsonArrayAttribute.cs +++ b/Src/Newtonsoft.Json/JsonArrayAttribute.cs @@ -53,7 +53,7 @@ namespace Newtonsoft.Json } /// - /// Initializes a new instance of the class with a flag indicating whether the array can contain null items + /// Initializes a new instance of the class with a flag indicating whether the array can contain null items. /// /// A flag indicating whether the array can contain null items. public JsonArrayAttribute(bool allowNullItems) diff --git a/Src/Newtonsoft.Json/JsonContainerAttribute.cs b/Src/Newtonsoft.Json/JsonContainerAttribute.cs index 32bd975e..7977d8e3 100644 --- a/Src/Newtonsoft.Json/JsonContainerAttribute.cs +++ b/Src/Newtonsoft.Json/JsonContainerAttribute.cs @@ -59,13 +59,15 @@ namespace Newtonsoft.Json public Type ItemConverterType { get; set; } /// - /// The parameter list to use when constructing the described by ItemConverterType. + /// The parameter list to use when constructing the described by . /// If null, the default constructor is used. /// When non-null, there must be a constructor defined in the that exactly matches the number, /// order, and type of these parameters. /// /// + /// /// [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + /// /// public object[] ItemConverterParameters { get; set; } @@ -84,13 +86,15 @@ namespace Newtonsoft.Json } /// - /// The parameter list to use when constructing the described by NamingStrategyType. + /// The parameter list to use when constructing the described by . /// If null, the default constructor is used. /// When non-null, there must be a constructor defined in the that exactly matches the number, /// order, and type of these parameters. /// /// + /// /// [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + /// /// public object[] NamingStrategyParameters { diff --git a/Src/Newtonsoft.Json/JsonConvert.cs b/Src/Newtonsoft.Json/JsonConvert.cs index aebc8cd6..98ed77de 100644 --- a/Src/Newtonsoft.Json/JsonConvert.cs +++ b/Src/Newtonsoft.Json/JsonConvert.cs @@ -46,7 +46,7 @@ using System.Xml.Linq; namespace Newtonsoft.Json { /// - /// Provides methods for converting between common language runtime types and JSON types. + /// Provides methods for converting between .NET types and JSON types. /// /// /// @@ -63,22 +63,22 @@ namespace Newtonsoft.Json public static Func DefaultSettings { get; set; } /// - /// Represents JavaScript's boolean value true as a string. This field is read-only. + /// Represents JavaScript's boolean value true as a string. This field is read-only. /// public static readonly string True = "true"; /// - /// Represents JavaScript's boolean value false as a string. This field is read-only. + /// Represents JavaScript's boolean value false as a string. This field is read-only. /// public static readonly string False = "false"; /// - /// Represents JavaScript's null as a string. This field is read-only. + /// Represents JavaScript's null as a string. This field is read-only. /// public static readonly string Null = "null"; /// - /// Represents JavaScript's undefined as a string. This field is read-only. + /// Represents JavaScript's undefined as a string. This field is read-only. /// public static readonly string Undefined = "undefined"; @@ -93,7 +93,7 @@ namespace Newtonsoft.Json public static readonly string NegativeInfinity = "-Infinity"; /// - /// Represents JavaScript's NaN as a string. This field is read-only. + /// Represents JavaScript's NaN as a string. This field is read-only. /// public static readonly string NaN = "NaN"; @@ -762,7 +762,7 @@ namespace Newtonsoft.Json /// /// /// The anonymous type to deserialize to. This can't be specified - /// traditionally and must be infered from the anonymous type passed + /// traditionally and must be inferred from the anonymous type passed /// as a parameter. /// /// The JSON to deserialize. @@ -778,7 +778,7 @@ namespace Newtonsoft.Json /// /// /// The anonymous type to deserialize to. This can't be specified - /// traditionally and must be infered from the anonymous type passed + /// traditionally and must be inferred from the anonymous type passed /// as a parameter. /// /// The JSON to deserialize. @@ -872,7 +872,7 @@ namespace Newtonsoft.Json /// The type of the object to deserialize to. /// The JSON to deserialize. /// - /// A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. + /// A task that represents the asynchronous deserialization operation. The value of the TResult parameter contains the deserialized object from the JSON string. /// [ObsoleteAttribute("DeserializeObjectAsync is obsolete. Use the Task.Factory.StartNew method to deserialize JSON asynchronously: Task.Factory.StartNew(() => JsonConvert.DeserializeObject(value))")] public static Task DeserializeObjectAsync(string value) @@ -891,7 +891,7 @@ namespace Newtonsoft.Json /// If this is null, default serialization settings will be used. /// /// - /// A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. + /// A task that represents the asynchronous deserialization operation. The value of the TResult parameter contains the deserialized object from the JSON string. /// [ObsoleteAttribute("DeserializeObjectAsync is obsolete. Use the Task.Factory.StartNew method to deserialize JSON asynchronously: Task.Factory.StartNew(() => JsonConvert.DeserializeObject(value, settings))")] public static Task DeserializeObjectAsync(string value, JsonSerializerSettings settings) @@ -905,7 +905,7 @@ namespace Newtonsoft.Json /// /// The JSON to deserialize. /// - /// A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. + /// A task that represents the asynchronous deserialization operation. The value of the TResult parameter contains the deserialized object from the JSON string. /// [ObsoleteAttribute("DeserializeObjectAsync is obsolete. Use the Task.Factory.StartNew method to deserialize JSON asynchronously: Task.Factory.StartNew(() => JsonConvert.DeserializeObject(value))")] public static Task DeserializeObjectAsync(string value) @@ -924,7 +924,7 @@ namespace Newtonsoft.Json /// If this is null, default serialization settings will be used. /// /// - /// A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. + /// A task that represents the asynchronous deserialization operation. The value of the TResult parameter contains the deserialized object from the JSON string. /// [ObsoleteAttribute("DeserializeObjectAsync is obsolete. Use the Task.Factory.StartNew method to deserialize JSON asynchronously: Task.Factory.StartNew(() => JsonConvert.DeserializeObject(value, type, settings))")] public static Task DeserializeObjectAsync(string value, Type type, JsonSerializerSettings settings) @@ -993,7 +993,7 @@ namespace Newtonsoft.Json #region Xml #if !(PORTABLE40 || PORTABLE || DOTNET) /// - /// Serializes the XML node to a JSON string. + /// Serializes the to a JSON string. /// /// The node to serialize. /// A JSON string of the XmlNode. @@ -1003,10 +1003,10 @@ namespace Newtonsoft.Json } /// - /// Serializes the XML node to a JSON string using formatting. + /// Serializes the to a JSON string using formatting. /// /// The node to serialize. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// A JSON string of the XmlNode. public static string SerializeXmlNode(XmlNode node, Formatting formatting) { @@ -1016,10 +1016,10 @@ namespace Newtonsoft.Json } /// - /// Serializes the XML node to a JSON string using formatting and omits the root object if is true. + /// Serializes the to a JSON string using formatting and omits the root object if is true. /// /// The node to serialize. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// Omits writing the root object. /// A JSON string of the XmlNode. public static string SerializeXmlNode(XmlNode node, Formatting formatting, bool omitRootObject) @@ -1030,7 +1030,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the XmlNode from a JSON string. + /// Deserializes the from a JSON string. /// /// The JSON string. /// The deserialized XmlNode @@ -1040,7 +1040,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the XmlNode from a JSON string nested in a root elment specified by . + /// Deserializes the from a JSON string nested in a root element specified by . /// /// The JSON string. /// The name of the root element to append when deserializing. @@ -1051,8 +1051,8 @@ namespace Newtonsoft.Json } /// - /// Deserializes the XmlNode from a JSON string nested in a root elment specified by - /// and writes a .NET array attribute for collections. + /// Deserializes the from a JSON string nested in a root element specified by + /// and writes a Json.NET array attribute for collections. /// /// The JSON string. /// The name of the root element to append when deserializing. @@ -1086,7 +1086,7 @@ namespace Newtonsoft.Json /// Serializes the to a JSON string using formatting. /// /// The node to convert to JSON. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// A JSON string of the XNode. public static string SerializeXNode(XObject node, Formatting formatting) { @@ -1097,7 +1097,7 @@ namespace Newtonsoft.Json /// Serializes the to a JSON string using formatting and omits the root object if is true. /// /// The node to serialize. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// Omits writing the root object. /// A JSON string of the XNode. public static string SerializeXNode(XObject node, Formatting formatting, bool omitRootObject) @@ -1118,7 +1118,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the from a JSON string nested in a root elment specified by . + /// Deserializes the from a JSON string nested in a root element specified by . /// /// The JSON string. /// The name of the root element to append when deserializing. @@ -1129,8 +1129,8 @@ namespace Newtonsoft.Json } /// - /// Deserializes the from a JSON string nested in a root elment specified by - /// and writes a .NET array attribute for collections. + /// Deserializes the from a JSON string nested in a root element specified by + /// and writes a Json.NET array attribute for collections. /// /// The JSON string. /// The name of the root element to append when deserializing. diff --git a/Src/Newtonsoft.Json/JsonConverter.cs b/Src/Newtonsoft.Json/JsonConverter.cs index a973d38b..d78785b2 100644 --- a/Src/Newtonsoft.Json/JsonConverter.cs +++ b/Src/Newtonsoft.Json/JsonConverter.cs @@ -65,7 +65,7 @@ namespace Newtonsoft.Json /// /// - /// Gets the of the JSON produced by the JsonConverter. + /// Gets the of the JSON produced by the . /// /// /// JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. diff --git a/Src/Newtonsoft.Json/JsonConverterAttribute.cs b/Src/Newtonsoft.Json/JsonConverterAttribute.cs index aea831f6..6f112b4c 100644 --- a/Src/Newtonsoft.Json/JsonConverterAttribute.cs +++ b/Src/Newtonsoft.Json/JsonConverterAttribute.cs @@ -47,7 +47,7 @@ namespace Newtonsoft.Json } /// - /// The parameter list to use when constructing the described by ConverterType. + /// The parameter list to use when constructing the described by . /// If null, the default constructor is used. /// public object[] ConverterParameters { get; private set; } diff --git a/Src/Newtonsoft.Json/JsonPropertyAttribute.cs b/Src/Newtonsoft.Json/JsonPropertyAttribute.cs index 0252ee44..a3de89ae 100644 --- a/Src/Newtonsoft.Json/JsonPropertyAttribute.cs +++ b/Src/Newtonsoft.Json/JsonPropertyAttribute.cs @@ -55,13 +55,15 @@ namespace Newtonsoft.Json public Type ItemConverterType { get; set; } /// - /// The parameter list to use when constructing the described by ItemConverterType. + /// The parameter list to use when constructing the described by . /// If null, the default constructor is used. /// When non-null, there must be a constructor defined in the that exactly matches the number, /// order, and type of these parameters. /// /// + /// /// [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + /// /// public object[] ItemConverterParameters { get; set; } @@ -78,7 +80,9 @@ namespace Newtonsoft.Json /// order, and type of these parameters. /// /// + /// /// [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + /// /// public object[] NamingStrategyParameters { get; set; } diff --git a/Src/Newtonsoft.Json/JsonReader.cs b/Src/Newtonsoft.Json/JsonReader.cs index f761b746..13ffcd57 100644 --- a/Src/Newtonsoft.Json/JsonReader.cs +++ b/Src/Newtonsoft.Json/JsonReader.cs @@ -51,7 +51,7 @@ namespace Newtonsoft.Json protected internal enum State { /// - /// The Read method has not been called. + /// The method has not been called. /// Start, @@ -86,7 +86,7 @@ namespace Newtonsoft.Json Array, /// - /// The Close method has been called. + /// The method has been called. /// Closed, @@ -101,7 +101,7 @@ namespace Newtonsoft.Json ConstructorStart, /// - /// Reader in a constructor. + /// Reader is in a constructor. /// Constructor, @@ -145,8 +145,8 @@ namespace Newtonsoft.Json /// should be closed when the reader is closed. /// /// - /// true to close the underlying stream or when - /// the reader is closed; otherwise false. The default is true. + /// true to close the underlying stream or when + /// the reader is closed; otherwise false. The default is true. /// public bool CloseInput { get; set; } @@ -155,7 +155,8 @@ namespace Newtonsoft.Json /// be read from a continuous stream without erroring. /// /// - /// true to support reading multiple pieces of JSON content; otherwise false. The default is false. + /// true to support reading multiple pieces of JSON content; otherwise false. + /// The default is false. /// public bool SupportMultipleContent { get; set; } @@ -169,7 +170,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how time zones are handling when reading JSON. + /// Gets or sets how time zones are handled when reading JSON. /// public DateTimeZoneHandling DateTimeZoneHandling { @@ -186,7 +187,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + /// Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. /// public DateParseHandling DateParseHandling { @@ -209,7 +210,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + /// Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. /// public FloatParseHandling FloatParseHandling { @@ -226,7 +227,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how custom date formatted strings are parsed when reading JSON. + /// Gets or sets how custom date formatted strings are parsed when reading JSON. /// public string DateFormatString { @@ -268,7 +269,7 @@ namespace Newtonsoft.Json } /// - /// Gets The Common Language Runtime (CLR) type for the current JSON token. + /// Gets the .NET type for the current JSON token. /// public virtual Type ValueType { @@ -337,7 +338,7 @@ namespace Newtonsoft.Json } /// - /// Initializes a new instance of the class with the specified . + /// Initializes a new instance of the class. /// protected JsonReader() { @@ -1113,7 +1114,7 @@ namespace Newtonsoft.Json } /// - /// Releases unmanaged and - optionally - managed resources + /// Releases unmanaged and - optionally - managed resources. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. protected virtual void Dispose(bool disposing) diff --git a/Src/Newtonsoft.Json/JsonRequiredAttribute.cs b/Src/Newtonsoft.Json/JsonRequiredAttribute.cs index 625a23a6..bc1b6b52 100644 --- a/Src/Newtonsoft.Json/JsonRequiredAttribute.cs +++ b/Src/Newtonsoft.Json/JsonRequiredAttribute.cs @@ -30,7 +30,7 @@ using System.Text; namespace Newtonsoft.Json { /// - /// Instructs the to always serialize the member, and require the member has a value. + /// Instructs the to always serialize the member, and to require that the member has a value. /// [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false)] public sealed class JsonRequiredAttribute : Attribute diff --git a/Src/Newtonsoft.Json/JsonSerializer.cs b/Src/Newtonsoft.Json/JsonSerializer.cs index fcef3897..796485f8 100644 --- a/Src/Newtonsoft.Json/JsonSerializer.cs +++ b/Src/Newtonsoft.Json/JsonSerializer.cs @@ -244,7 +244,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how reference loops (e.g. a class referencing itself) is handled. + /// Gets or sets how reference loops (e.g. a class referencing itself) is handled. /// public virtual ReferenceLoopHandling ReferenceLoopHandling { @@ -261,7 +261,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + /// Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. /// public virtual MissingMemberHandling MissingMemberHandling { @@ -278,7 +278,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how null values are handled during serialization and deserialization. + /// Gets or sets how null values are handled during serialization and deserialization. /// public virtual NullValueHandling NullValueHandling { @@ -295,7 +295,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how null default are handled during serialization and deserialization. + /// Gets or sets how default values are handled during serialization and deserialization. /// public virtual DefaultValueHandling DefaultValueHandling { @@ -412,7 +412,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how dates are written to JSON text. + /// Gets or sets how dates are written to JSON text. /// public virtual DateFormatHandling DateFormatHandling { @@ -421,7 +421,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how time zones are handling during serialization and deserialization. + /// Gets or sets how time zones are handled during serialization and deserialization. /// public virtual DateTimeZoneHandling DateTimeZoneHandling { @@ -430,7 +430,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + /// Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. /// public virtual DateParseHandling DateParseHandling { @@ -439,7 +439,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + /// Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. /// public virtual FloatParseHandling FloatParseHandling { @@ -448,7 +448,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how special floating point numbers, e.g. , + /// Gets or sets how special floating point numbers, e.g. , /// and , /// are written as JSON text. /// @@ -459,7 +459,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how strings are escaped when writing JSON text. + /// Gets or sets how strings are escaped when writing JSON text. /// public virtual StringEscapeHandling StringEscapeHandling { @@ -468,7 +468,8 @@ namespace Newtonsoft.Json } /// - /// Get or set how and values are formatted when writing JSON text, and the expected date format when reading JSON text. + /// Gets or sets how and values are formatted when writing JSON text, + /// and the expected date format when reading JSON text. /// public virtual string DateFormatString { diff --git a/Src/Newtonsoft.Json/JsonSerializerSettings.cs b/Src/Newtonsoft.Json/JsonSerializerSettings.cs index 62e9ab78..9de2e8de 100644 --- a/Src/Newtonsoft.Json/JsonSerializerSettings.cs +++ b/Src/Newtonsoft.Json/JsonSerializerSettings.cs @@ -128,7 +128,7 @@ namespace Newtonsoft.Json } /// - /// Gets or sets how null default are handled during serialization and deserialization. + /// Gets or sets how default values are handled during serialization and deserialization. /// /// The default value handling. public DefaultValueHandling DefaultValueHandling @@ -306,7 +306,8 @@ namespace Newtonsoft.Json } /// - /// Get or set how and values are formatted when writing JSON text, and the expected date format when reading JSON text. + /// Gets or sets how and values are formatted when writing JSON text, + /// and the expected date format when reading JSON text. /// public string DateFormatString { @@ -346,7 +347,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how dates are written to JSON text. + /// Gets or sets how dates are written to JSON text. /// public DateFormatHandling DateFormatHandling { @@ -355,7 +356,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how time zones are handling during serialization and deserialization. + /// Gets or sets how time zones are handled during serialization and deserialization. /// public DateTimeZoneHandling DateTimeZoneHandling { @@ -364,7 +365,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + /// Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. /// public DateParseHandling DateParseHandling { @@ -373,7 +374,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how special floating point numbers, e.g. , + /// Gets or sets how special floating point numbers, e.g. , /// and , /// are written as JSON. /// @@ -384,7 +385,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + /// Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. /// public FloatParseHandling FloatParseHandling { @@ -393,7 +394,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how strings are escaped when writing JSON text. + /// Gets or sets how strings are escaped when writing JSON text. /// public StringEscapeHandling StringEscapeHandling { diff --git a/Src/Newtonsoft.Json/JsonTextReader.cs b/Src/Newtonsoft.Json/JsonTextReader.cs index 6b6a6e56..f806884d 100644 --- a/Src/Newtonsoft.Json/JsonTextReader.cs +++ b/Src/Newtonsoft.Json/JsonTextReader.cs @@ -73,7 +73,7 @@ namespace Newtonsoft.Json internal PropertyNameTable NameTable; /// - /// Initializes a new instance of the class with the specified . + /// Initializes a new instance of the class with the specified . /// /// The TextReader containing the XML data to read. public JsonTextReader(TextReader reader) @@ -2401,7 +2401,7 @@ namespace Newtonsoft.Json } /// - /// Changes the state to closed. + /// Changes the state to Closed. /// public override void Close() { diff --git a/Src/Newtonsoft.Json/JsonTextWriter.cs b/Src/Newtonsoft.Json/JsonTextWriter.cs index f15ec748..71975ea7 100644 --- a/Src/Newtonsoft.Json/JsonTextWriter.cs +++ b/Src/Newtonsoft.Json/JsonTextWriter.cs @@ -143,7 +143,7 @@ namespace Newtonsoft.Json } /// - /// Creates an instance of the JsonWriter class using the specified . + /// Creates an instance of the JsonTextWriter class using the specified . /// /// The TextWriter to write to. public JsonTextWriter(TextWriter textWriter) @@ -730,7 +730,7 @@ namespace Newtonsoft.Json #endregion /// - /// Writes out a comment /*...*/ containing the specified text. + /// Writes a comment /*...*/ containing the specified text. /// /// Text to place inside the comment. public override void WriteComment(string text) @@ -743,7 +743,7 @@ namespace Newtonsoft.Json } /// - /// Writes out the given white space. + /// Writes the given white space. /// /// The string of white space characters. public override void WriteWhitespace(string ws) diff --git a/Src/Newtonsoft.Json/JsonValidatingReader.cs b/Src/Newtonsoft.Json/JsonValidatingReader.cs index c8a88966..ecb1b3d4 100644 --- a/Src/Newtonsoft.Json/JsonValidatingReader.cs +++ b/Src/Newtonsoft.Json/JsonValidatingReader.cs @@ -163,7 +163,7 @@ namespace Newtonsoft.Json } /// - /// Gets the Common Language Runtime (CLR) type for the current JSON token. + /// Gets the .NET type for the current JSON token. /// /// public override Type ValueType diff --git a/Src/Newtonsoft.Json/JsonWriter.cs b/Src/Newtonsoft.Json/JsonWriter.cs index 58163d53..bbaa16c4 100644 --- a/Src/Newtonsoft.Json/JsonWriter.cs +++ b/Src/Newtonsoft.Json/JsonWriter.cs @@ -123,8 +123,8 @@ namespace Newtonsoft.Json /// should be closed when the writer is closed. /// /// - /// true to close the underlying stream or when - /// the writer is closed; otherwise false. The default is true. + /// true to close the underlying stream or when + /// the writer is closed; otherwise false. The default is true. /// public bool CloseOutput { get; set; } @@ -221,7 +221,7 @@ namespace Newtonsoft.Json private CultureInfo _culture; /// - /// Indicates how JSON text output is formatted. + /// Gets or sets a value indicating how JSON text output should be formatted. /// public Formatting Formatting { @@ -238,7 +238,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how dates are written to JSON text. + /// Gets or sets how dates are written to JSON text. /// public DateFormatHandling DateFormatHandling { @@ -255,7 +255,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how time zones are handling when writing JSON text. + /// Gets or sets how time zones are handled when writing JSON text. /// public DateTimeZoneHandling DateTimeZoneHandling { @@ -272,7 +272,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how strings are escaped when writing JSON text. + /// Gets or sets how strings are escaped when writing JSON text. /// public StringEscapeHandling StringEscapeHandling { @@ -295,7 +295,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how special floating point numbers, e.g. , + /// Gets or sets how special floating point numbers, e.g. , /// and , /// are written to JSON text. /// @@ -314,7 +314,7 @@ namespace Newtonsoft.Json } /// - /// Get or set how and values are formatting when writing JSON text. + /// Gets or sets how and values are formatted when writing JSON text. /// public string DateFormatString { @@ -332,7 +332,7 @@ namespace Newtonsoft.Json } /// - /// Creates an instance of the JsonWriter class. + /// Initializes a new instance of the class. /// protected JsonWriter() { @@ -451,7 +451,7 @@ namespace Newtonsoft.Json } /// - /// Writes the property name of a name/value pair on a JSON object. + /// Writes the property name of a name/value pair of a JSON object. /// /// The name of the property. public virtual void WritePropertyName(string name) @@ -460,7 +460,7 @@ namespace Newtonsoft.Json } /// - /// Writes the property name of a name/value pair on a JSON object. + /// Writes the property name of a name/value pair of a JSON object. /// /// The name of the property. /// A flag to indicate whether the text should be escaped when it is written as a JSON property name. @@ -1407,7 +1407,7 @@ namespace Newtonsoft.Json #endregion /// - /// Writes out a comment /*...*/ containing the specified text. + /// Writes a comment /*...*/ containing the specified text. /// /// Text to place inside the comment. public virtual void WriteComment(string text) @@ -1416,7 +1416,7 @@ namespace Newtonsoft.Json } /// - /// Writes out the given white space. + /// Writes the given white space. /// /// The string of white space characters. public virtual void WriteWhitespace(string ws) @@ -1431,7 +1431,7 @@ namespace Newtonsoft.Json } /// - /// Releases unmanaged and - optionally - managed resources + /// Releases unmanaged and - optionally - managed resources. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. protected virtual void Dispose(bool disposing) @@ -1607,7 +1607,7 @@ namespace Newtonsoft.Json } /// - /// Sets the state of the JsonWriter, + /// Sets the state of the JsonWriter. /// /// The JsonToken being written. /// The value being written. diff --git a/Src/Newtonsoft.Json/JsonWriterException.cs b/Src/Newtonsoft.Json/JsonWriterException.cs index 2bfa78db..475c2dba 100644 --- a/Src/Newtonsoft.Json/JsonWriterException.cs +++ b/Src/Newtonsoft.Json/JsonWriterException.cs @@ -31,7 +31,7 @@ using System.Text; namespace Newtonsoft.Json { /// - /// The exception thrown when an error occurs while reading JSON text. + /// The exception thrown when an error occurs while writing JSON text. /// #if !(DOTNET || PORTABLE40 || PORTABLE) [Serializable] diff --git a/Src/Newtonsoft.Json/Linq/JTokenWriter.cs b/Src/Newtonsoft.Json/Linq/JTokenWriter.cs index e9551b07..0d92e480 100644 --- a/Src/Newtonsoft.Json/Linq/JTokenWriter.cs +++ b/Src/Newtonsoft.Json/Linq/JTokenWriter.cs @@ -263,7 +263,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Writes out a comment /*...*/ containing the specified text. + /// Writes a comment /*...*/ containing the specified text. /// /// Text to place inside the comment. public override void WriteComment(string text) diff --git a/Src/Newtonsoft.Json/PreserveReferencesHandling.cs b/Src/Newtonsoft.Json/PreserveReferencesHandling.cs index 61fcbd47..1c9dd387 100644 --- a/Src/Newtonsoft.Json/PreserveReferencesHandling.cs +++ b/Src/Newtonsoft.Json/PreserveReferencesHandling.cs @@ -31,7 +31,7 @@ namespace Newtonsoft.Json { /// /// Specifies reference handling options for the . - /// Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement ISerializable. + /// Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement ISerializable. /// /// /// diff --git a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs index b061d09b..d3263d75 100644 --- a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs +++ b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs @@ -92,7 +92,7 @@ namespace Newtonsoft.Json.Serialization } /// - /// Used by to resolves a for a given . + /// Used by to resolve a for a given . /// public class DefaultContractResolver : IContractResolver { diff --git a/Src/Newtonsoft.Json/TypeNameAssemblyFormatHandling.cs b/Src/Newtonsoft.Json/TypeNameAssemblyFormatHandling.cs index 19324a88..572c1ffc 100644 --- a/Src/Newtonsoft.Json/TypeNameAssemblyFormatHandling.cs +++ b/Src/Newtonsoft.Json/TypeNameAssemblyFormatHandling.cs @@ -31,7 +31,7 @@ namespace Newtonsoft.Json public enum TypeNameAssemblyFormatHandling { /// - /// In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method is used to load the assembly. + /// In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method is used to load the assembly. /// Simple = 0, diff --git a/Src/Newtonsoft.Json/WriteState.cs b/Src/Newtonsoft.Json/WriteState.cs index b28b542d..09ab8b4e 100644 --- a/Src/Newtonsoft.Json/WriteState.cs +++ b/Src/Newtonsoft.Json/WriteState.cs @@ -35,7 +35,7 @@ namespace Newtonsoft.Json /// /// An exception has been thrown, which has left the in an invalid state. /// You may call the method to put the in the Closed state. - /// Any other method calls results in an being thrown. + /// Any other method calls result in an being thrown. /// Error = 0,