From 2e6d2ecd4c2aadd7b9379edadd6e6ebe6cf2e780 Mon Sep 17 00:00:00 2001 From: stakx Date: Sat, 17 Dec 2016 19:05:42 +0100 Subject: [PATCH 1/4] Fix typos, punctuation, etc. in XML doc comments * Simple stuff: typos and missing punctuation and line breaks. * Sometimes, two method overloads have quite different documentation. Rephrase these to make them more similar. * Minor rephrasings like in a previous commit (e.g. "...how output should be formatted", "initializes a new instance of..."). * Obvious incorrect type references in comments. These appear mostly in `Utilities/LinqBridge.cs` (nullable vs non-nullable). * Remove factually incorrect statement about exceptions thrown. * Remove comments for explicitly implemented interface methods. --- Src/Newtonsoft.Json/Bson/BsonReader.cs | 2 +- Src/Newtonsoft.Json/Bson/BsonWriter.cs | 2 +- Src/Newtonsoft.Json/JsonConvert.cs | 36 ++++---- Src/Newtonsoft.Json/JsonException.cs | 4 +- Src/Newtonsoft.Json/JsonReader.cs | 4 +- Src/Newtonsoft.Json/JsonReaderException.cs | 4 +- .../JsonSerializationException.cs | 4 +- Src/Newtonsoft.Json/JsonSerializerSettings.cs | 2 +- Src/Newtonsoft.Json/JsonTextReader.cs | 2 +- Src/Newtonsoft.Json/JsonTextWriter.cs | 2 +- Src/Newtonsoft.Json/JsonWriterException.cs | 4 +- Src/Newtonsoft.Json/Linq/JArray.cs | 4 +- Src/Newtonsoft.Json/Linq/JContainer.cs | 6 +- Src/Newtonsoft.Json/Linq/JObject.cs | 92 ++----------------- Src/Newtonsoft.Json/Linq/JProperty.cs | 2 +- .../Linq/JPropertyDescriptor.cs | 16 ++-- Src/Newtonsoft.Json/Linq/JToken.cs | 32 +++---- Src/Newtonsoft.Json/Linq/JValue.cs | 5 +- Src/Newtonsoft.Json/Schema/JsonSchema.cs | 18 ++-- .../Schema/JsonSchemaException.cs | 4 +- .../Serialization/JsonContract.cs | 2 +- .../Serialization/JsonProperty.cs | 4 +- Src/Newtonsoft.Json/Utilities/LinqBridge.cs | 82 ++++++++--------- Src/Newtonsoft.Json/Utilities/MethodBinder.cs | 22 ++--- 24 files changed, 138 insertions(+), 217 deletions(-) diff --git a/Src/Newtonsoft.Json/Bson/BsonReader.cs b/Src/Newtonsoft.Json/Bson/BsonReader.cs index 20d6edb3..00ecc7f3 100644 --- a/Src/Newtonsoft.Json/Bson/BsonReader.cs +++ b/Src/Newtonsoft.Json/Bson/BsonReader.cs @@ -35,7 +35,7 @@ using Newtonsoft.Json.Linq; namespace Newtonsoft.Json.Bson { /// - /// Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + /// Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. /// public class BsonReader : JsonReader { diff --git a/Src/Newtonsoft.Json/Bson/BsonWriter.cs b/Src/Newtonsoft.Json/Bson/BsonWriter.cs index 39667514..f46b67c3 100644 --- a/Src/Newtonsoft.Json/Bson/BsonWriter.cs +++ b/Src/Newtonsoft.Json/Bson/BsonWriter.cs @@ -38,7 +38,7 @@ using System.Globalization; namespace Newtonsoft.Json.Bson { /// - /// Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + /// Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. /// public class BsonWriter : JsonWriter { diff --git a/Src/Newtonsoft.Json/JsonConvert.cs b/Src/Newtonsoft.Json/JsonConvert.cs index 98ed77de..965a1cc2 100644 --- a/Src/Newtonsoft.Json/JsonConvert.cs +++ b/Src/Newtonsoft.Json/JsonConvert.cs @@ -534,7 +534,7 @@ namespace Newtonsoft.Json /// Serializes the specified object to a JSON string using formatting. /// /// The object to serialize. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// /// A JSON string representation of the object. /// @@ -547,7 +547,7 @@ namespace Newtonsoft.Json /// Serializes the specified object to a JSON string using a collection of . /// /// The object to serialize. - /// A collection converters used while serializing. + /// A collection of converters used while serializing. /// A JSON string representation of the object. public static string SerializeObject(object value, params JsonConverter[] converters) { @@ -562,8 +562,8 @@ namespace Newtonsoft.Json /// Serializes the specified object to a JSON string using formatting and a collection of . /// /// The object to serialize. - /// Indicates how the output is formatted. - /// A collection converters used while serializing. + /// Indicates how the output should be formatted. + /// A collection of converters used while serializing. /// A JSON string representation of the object. public static string SerializeObject(object value, Formatting formatting, params JsonConverter[] converters) { @@ -613,7 +613,7 @@ namespace Newtonsoft.Json /// Serializes the specified object to a JSON string using formatting and . /// /// The object to serialize. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// The used to serialize the object. /// If this is null, default serialization settings will be used. /// @@ -628,7 +628,7 @@ namespace Newtonsoft.Json /// Serializes the specified object to a JSON string using a type, formatting and . /// /// The object to serialize. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// The used to serialize the object. /// If this is null, default serialization settings will be used. /// @@ -668,7 +668,7 @@ namespace Newtonsoft.Json /// /// The object to serialize. /// - /// A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. + /// A task that represents the asynchronous serialization operation. The value of the TResult parameter contains a JSON string representation of the object. /// [ObsoleteAttribute("SerializeObjectAsync is obsolete. Use the Task.Factory.StartNew method to serialize JSON asynchronously: Task.Factory.StartNew(() => JsonConvert.SerializeObject(value))")] public static Task SerializeObjectAsync(object value) @@ -681,9 +681,9 @@ namespace Newtonsoft.Json /// Serialization will happen on a new thread. /// /// The object to serialize. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// - /// A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. + /// A task that represents the asynchronous serialization operation. The value of the TResult parameter contains a JSON string representation of the object. /// [ObsoleteAttribute("SerializeObjectAsync is obsolete. Use the Task.Factory.StartNew method to serialize JSON asynchronously: Task.Factory.StartNew(() => JsonConvert.SerializeObject(value, formatting))")] public static Task SerializeObjectAsync(object value, Formatting formatting) @@ -696,11 +696,11 @@ namespace Newtonsoft.Json /// Serialization will happen on a new thread. /// /// The object to serialize. - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// The used to serialize the object. /// If this is null, default serialization settings will be used. /// - /// A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. + /// A task that represents the asynchronous serialization operation. The value of the TResult parameter contains a JSON string representation of the object. /// [ObsoleteAttribute("SerializeObjectAsync is obsolete. Use the Task.Factory.StartNew method to serialize JSON asynchronously: Task.Factory.StartNew(() => JsonConvert.SerializeObject(value, formatting, settings))")] public static Task SerializeObjectAsync(object value, Formatting formatting, JsonSerializerSettings settings) @@ -980,7 +980,7 @@ namespace Newtonsoft.Json /// If this is null, default serialization settings will be used. /// /// - /// A task that represents the asynchronous populate operation. + /// A task that represents the asynchronous population operation. /// [ObsoleteAttribute("PopulateObjectAsync is obsolete. Use the Task.Factory.StartNew method to populate an object with JSON values asynchronously: Task.Factory.StartNew(() => JsonConvert.PopulateObject(value, target, settings))")] public static Task PopulateObjectAsync(string value, object target, JsonSerializerSettings settings) @@ -1033,7 +1033,7 @@ namespace Newtonsoft.Json /// Deserializes the from a JSON string. /// /// The JSON string. - /// The deserialized XmlNode + /// The deserialized XmlNode. public static XmlDocument DeserializeXmlNode(string value) { return DeserializeXmlNode(value, null); @@ -1044,7 +1044,7 @@ namespace Newtonsoft.Json /// /// The JSON string. /// The name of the root element to append when deserializing. - /// The deserialized XmlNode + /// The deserialized XmlNode. public static XmlDocument DeserializeXmlNode(string value, string deserializeRootElementName) { return DeserializeXmlNode(value, deserializeRootElementName, false); @@ -1060,7 +1060,7 @@ namespace Newtonsoft.Json /// A flag to indicate whether to write the Json.NET array attribute. /// This attribute helps preserve arrays when converting the written XML back to JSON. /// - /// The deserialized XmlNode + /// The deserialized XmlNode. public static XmlDocument DeserializeXmlNode(string value, string deserializeRootElementName, bool writeArrayAttribute) { XmlNodeConverter converter = new XmlNodeConverter(); @@ -1111,7 +1111,7 @@ namespace Newtonsoft.Json /// Deserializes the from a JSON string. /// /// The JSON string. - /// The deserialized XNode + /// The deserialized XNode. public static XDocument DeserializeXNode(string value) { return DeserializeXNode(value, null); @@ -1122,7 +1122,7 @@ namespace Newtonsoft.Json /// /// The JSON string. /// The name of the root element to append when deserializing. - /// The deserialized XNode + /// The deserialized XNode. public static XDocument DeserializeXNode(string value, string deserializeRootElementName) { return DeserializeXNode(value, deserializeRootElementName, false); @@ -1138,7 +1138,7 @@ namespace Newtonsoft.Json /// A flag to indicate whether to write the Json.NET array attribute. /// This attribute helps preserve arrays when converting the written XML back to JSON. /// - /// The deserialized XNode + /// The deserialized XNode. public static XDocument DeserializeXNode(string value, string deserializeRootElementName, bool writeArrayAttribute) { XmlNodeConverter converter = new XmlNodeConverter(); diff --git a/Src/Newtonsoft.Json/JsonException.cs b/Src/Newtonsoft.Json/JsonException.cs index 97ea7242..306916ac 100644 --- a/Src/Newtonsoft.Json/JsonException.cs +++ b/Src/Newtonsoft.Json/JsonException.cs @@ -74,8 +74,8 @@ namespace Newtonsoft.Json /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonReader.cs b/Src/Newtonsoft.Json/JsonReader.cs index 13ffcd57..0ac78138 100644 --- a/Src/Newtonsoft.Json/JsonReader.cs +++ b/Src/Newtonsoft.Json/JsonReader.cs @@ -606,9 +606,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a . /// - /// A . This method will return null at the end of an array. + /// A . This method will return null at the end of an array. public virtual double? ReadAsDouble() { JsonToken t = GetContentToken(); diff --git a/Src/Newtonsoft.Json/JsonReaderException.cs b/Src/Newtonsoft.Json/JsonReaderException.cs index 9f448c4b..e74b29dc 100644 --- a/Src/Newtonsoft.Json/JsonReaderException.cs +++ b/Src/Newtonsoft.Json/JsonReaderException.cs @@ -90,8 +90,8 @@ namespace Newtonsoft.Json /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonReaderException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonSerializationException.cs b/Src/Newtonsoft.Json/JsonSerializationException.cs index 1c872c78..5ba3ede4 100644 --- a/Src/Newtonsoft.Json/JsonSerializationException.cs +++ b/Src/Newtonsoft.Json/JsonSerializationException.cs @@ -72,8 +72,8 @@ namespace Newtonsoft.Json /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonSerializationException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonSerializerSettings.cs b/Src/Newtonsoft.Json/JsonSerializerSettings.cs index 9de2e8de..9b3f61d8 100644 --- a/Src/Newtonsoft.Json/JsonSerializerSettings.cs +++ b/Src/Newtonsoft.Json/JsonSerializerSettings.cs @@ -88,7 +88,7 @@ namespace Newtonsoft.Json internal MetadataPropertyHandling? _metadataPropertyHandling; /// - /// Gets or sets how reference loops (e.g. a class referencing itself) is handled. + /// Gets or sets how reference loops (e.g. a class referencing itself) are handled. /// /// Reference loop handling. public ReferenceLoopHandling ReferenceLoopHandling diff --git a/Src/Newtonsoft.Json/JsonTextReader.cs b/Src/Newtonsoft.Json/JsonTextReader.cs index f806884d..ff1f8a95 100644 --- a/Src/Newtonsoft.Json/JsonTextReader.cs +++ b/Src/Newtonsoft.Json/JsonTextReader.cs @@ -75,7 +75,7 @@ namespace Newtonsoft.Json /// /// Initializes a new instance of the class with the specified . /// - /// The TextReader containing the XML data to read. + /// The TextReader containing the JSON data to read. public JsonTextReader(TextReader reader) { if (reader == null) diff --git a/Src/Newtonsoft.Json/JsonTextWriter.cs b/Src/Newtonsoft.Json/JsonTextWriter.cs index 71975ea7..82ada632 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 JsonTextWriter class using the specified . + /// Initializes a new instance of the JsonTextWriter class using the specified . /// /// The TextWriter to write to. public JsonTextWriter(TextWriter textWriter) diff --git a/Src/Newtonsoft.Json/JsonWriterException.cs b/Src/Newtonsoft.Json/JsonWriterException.cs index 475c2dba..7c0f1b8c 100644 --- a/Src/Newtonsoft.Json/JsonWriterException.cs +++ b/Src/Newtonsoft.Json/JsonWriterException.cs @@ -78,8 +78,8 @@ namespace Newtonsoft.Json /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonWriterException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/Linq/JArray.cs b/Src/Newtonsoft.Json/Linq/JArray.cs index ad73e028..eb6fc7a6 100644 --- a/Src/Newtonsoft.Json/Linq/JArray.cs +++ b/Src/Newtonsoft.Json/Linq/JArray.cs @@ -189,7 +189,7 @@ namespace Newtonsoft.Json.Linq /// Creates a from an object. /// /// The object that will be used to create . - /// A with the values of the specified object + /// A with the values of the specified object. public new static JArray FromObject(object o) { return FromObject(o, JsonSerializer.CreateDefault()); @@ -200,7 +200,7 @@ namespace Newtonsoft.Json.Linq /// /// The object that will be used to create . /// The that will be used to read the object. - /// A with the values of the specified object + /// A with the values of the specified object. public new static JArray FromObject(object o, JsonSerializer jsonSerializer) { JToken token = FromObjectInternal(o, jsonSerializer); diff --git a/Src/Newtonsoft.Json/Linq/JContainer.cs b/Src/Newtonsoft.Json/Linq/JContainer.cs index 0ad8a5ce..76b0c04a 100644 --- a/Src/Newtonsoft.Json/Linq/JContainer.cs +++ b/Src/Newtonsoft.Json/Linq/JContainer.cs @@ -685,16 +685,16 @@ namespace Newtonsoft.Json.Linq } /// - /// Creates an that can be used to add tokens to the . + /// Creates a that can be used to add tokens to the . /// - /// An that is ready to have content written to it. + /// A that is ready to have content written to it. public JsonWriter CreateWriter() { return new JTokenWriter(this); } /// - /// Replaces the children nodes of this token with the specified content. + /// Replaces the child nodes of this token with the specified content. /// /// The content. public void ReplaceAll(object content) diff --git a/Src/Newtonsoft.Json/Linq/JObject.cs b/Src/Newtonsoft.Json/Linq/JObject.cs index b9098ab1..96f1ed83 100644 --- a/Src/Newtonsoft.Json/Linq/JObject.cs +++ b/Src/Newtonsoft.Json/Linq/JObject.cs @@ -270,9 +270,9 @@ namespace Newtonsoft.Json.Linq } /// - /// Gets an of this object's property values. + /// Gets a of this object's property values. /// - /// An of this object's property values. + /// A of this object's property values. public JEnumerable PropertyValues() { return new JEnumerable(Properties().Select(p => p.Value)); @@ -343,7 +343,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Loads an from a . + /// Loads a from a . /// /// A that will be read for the content of the . /// A that contains the JSON that was read from the specified . @@ -356,7 +356,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Loads an from a . + /// Loads a from a . /// /// A that will be read for the content of the . /// The used to load the JSON. @@ -440,7 +440,7 @@ namespace Newtonsoft.Json.Linq /// Creates a from an object. /// /// The object that will be used to create . - /// A with the values of the specified object + /// A with the values of the specified object. public new static JObject FromObject(object o) { return FromObject(o, JsonSerializer.CreateDefault()); @@ -451,7 +451,7 @@ namespace Newtonsoft.Json.Linq /// /// The object that will be used to create . /// The that will be used to read the object. - /// A with the values of the specified object + /// A with the values of the specified object. public new static JObject FromObject(object o, JsonSerializer jsonSerializer) { JToken token = FromObjectInternal(o, jsonSerializer); @@ -583,7 +583,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Tries the get value. + /// Tries to get the with the specified property name. /// /// Name of the property. /// The value. @@ -683,7 +683,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Returns an enumerator that iterates through the collection. + /// Returns an enumerator that can be used to iterate through the collection. /// /// /// A that can be used to iterate through the collection. @@ -720,24 +720,11 @@ namespace Newtonsoft.Json.Linq // include custom type descriptor on JObject rather than use a provider because the properties are specific to a type #region ICustomTypeDescriptor - /// - /// Returns the properties for this instance of a component. - /// - /// - /// A that represents the properties for this component instance. - /// PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties() { return ((ICustomTypeDescriptor)this).GetProperties(null); } - /// - /// Returns the properties for this instance of a component using the attribute array as a filter. - /// - /// An array of type that is used as a filter. - /// - /// A that represents the filtered properties for this component instance. - /// PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties(Attribute[] attributes) { PropertyDescriptorCollection descriptors = new PropertyDescriptorCollection(null); @@ -750,114 +737,51 @@ namespace Newtonsoft.Json.Linq return descriptors; } - /// - /// Returns a collection of custom attributes for this instance of a component. - /// - /// - /// An containing the attributes for this object. - /// AttributeCollection ICustomTypeDescriptor.GetAttributes() { return AttributeCollection.Empty; } - /// - /// Returns the class name of this instance of a component. - /// - /// - /// The class name of the object, or null if the class does not have a name. - /// string ICustomTypeDescriptor.GetClassName() { return null; } - /// - /// Returns the name of this instance of a component. - /// - /// - /// The name of the object, or null if the object does not have a name. - /// string ICustomTypeDescriptor.GetComponentName() { return null; } - /// - /// Returns a type converter for this instance of a component. - /// - /// - /// A that is the converter for this object, or null if there is no for this object. - /// TypeConverter ICustomTypeDescriptor.GetConverter() { return new TypeConverter(); } - /// - /// Returns the default event for this instance of a component. - /// - /// - /// An that represents the default event for this object, or null if this object does not have events. - /// EventDescriptor ICustomTypeDescriptor.GetDefaultEvent() { return null; } - /// - /// Returns the default property for this instance of a component. - /// - /// - /// A that represents the default property for this object, or null if this object does not have properties. - /// PropertyDescriptor ICustomTypeDescriptor.GetDefaultProperty() { return null; } - /// - /// Returns an editor of the specified type for this instance of a component. - /// - /// A that represents the editor for this object. - /// - /// An of the specified type that is the editor for this object, or null if the editor cannot be found. - /// object ICustomTypeDescriptor.GetEditor(Type editorBaseType) { return null; } - /// - /// Returns the events for this instance of a component using the specified attribute array as a filter. - /// - /// An array of type that is used as a filter. - /// - /// An that represents the filtered events for this component instance. - /// EventDescriptorCollection ICustomTypeDescriptor.GetEvents(Attribute[] attributes) { return EventDescriptorCollection.Empty; } - /// - /// Returns the events for this instance of a component. - /// - /// - /// An that represents the events for this component instance. - /// EventDescriptorCollection ICustomTypeDescriptor.GetEvents() { return EventDescriptorCollection.Empty; } - /// - /// Returns an object that contains the property described by the specified property descriptor. - /// - /// A that represents the property whose owner is to be found. - /// - /// An that represents the owner of the specified property. - /// object ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor pd) { return null; diff --git a/Src/Newtonsoft.Json/Linq/JProperty.cs b/Src/Newtonsoft.Json/Linq/JProperty.cs index c68502a0..3b15175b 100644 --- a/Src/Newtonsoft.Json/Linq/JProperty.cs +++ b/Src/Newtonsoft.Json/Linq/JProperty.cs @@ -361,7 +361,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Loads an from a . + /// Loads a from a . /// /// A that will be read for the content of the . /// A that contains the JSON that was read from the specified . diff --git a/Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs b/Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs index 0b7b34eb..07aed646 100644 --- a/Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs +++ b/Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs @@ -66,8 +66,7 @@ namespace Newtonsoft.Json.Linq /// /// The value of a property for a given component. /// - /// The component with the property for which to retrieve the value. - /// + /// The component with the property for which to retrieve the value. public override object GetValue(object component) { JToken token = CastInstance(component)[Name]; @@ -78,8 +77,7 @@ namespace Newtonsoft.Json.Linq /// /// When overridden in a derived class, resets the value for this property of the component to the default value. /// - /// The component with the property value that is to be reset to the default value. - /// + /// The component with the property value that is to be reset to the default value. public override void ResetValue(object component) { } @@ -87,9 +85,8 @@ namespace Newtonsoft.Json.Linq /// /// When overridden in a derived class, sets the value of the component to a different value. /// - /// The component with the property value that is to be set. - /// The new value. - /// + /// The component with the property value that is to be set. + /// The new value. public override void SetValue(object component, object value) { JToken token = (value is JToken) ? (JToken)value : new JValue(value); @@ -113,7 +110,10 @@ namespace Newtonsoft.Json.Linq /// When overridden in a derived class, gets the type of the component this property is bound to. /// /// - /// A that represents the type of component this property is bound to. When the or methods are invoked, the object specified might be an instance of this type. + /// A that represents the type of component this property is bound to. + /// When the or + /// + /// methods are invoked, the object specified might be an instance of this type. /// public override Type ComponentType { diff --git a/Src/Newtonsoft.Json/Linq/JToken.cs b/Src/Newtonsoft.Json/Linq/JToken.cs index 2a2818a5..4e71bed4 100644 --- a/Src/Newtonsoft.Json/Linq/JToken.cs +++ b/Src/Newtonsoft.Json/Linq/JToken.cs @@ -428,7 +428,7 @@ namespace Newtonsoft.Json.Linq /// /// Returns the JSON for this token using the given formatting and converters. /// - /// Indicates how the output is formatted. + /// Indicates how the output should be formatted. /// A collection of which will be used when writing the token. /// The JSON for this token using the given formatting and converters. public string ToString(Formatting formatting, params JsonConverter[] converters) @@ -1358,7 +1358,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1405,7 +1405,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1870,9 +1870,9 @@ namespace Newtonsoft.Json.Linq } /// - /// Creates an for this token. + /// Creates a for this token. /// - /// An that can be used to read this token and its descendants. + /// A that can be used to read this token and its descendants. public JsonReader CreateReader() { return new JTokenReader(this); @@ -1915,7 +1915,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Creates the specified .NET type from the . + /// Creates an instance of the specified .NET type from the . /// /// The object type that the token will be deserialized to. /// The new object created from the JSON value. @@ -1925,7 +1925,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Creates the specified .NET type from the . + /// Creates an instance of the specified .NET type from the . /// /// The object type that the token will be deserialized to. /// The new object created from the JSON value. @@ -2048,7 +2048,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Creates the specified .NET type from the using the specified . + /// Creates an instance of the specified .NET type from the using the specified . /// /// The object type that the token will be deserialized to. /// The that will be used when creating the object. @@ -2059,7 +2059,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Creates the specified .NET type from the using the specified . + /// Creates an instance of the specified .NET type from the using the specified . /// /// The object type that the token will be deserialized to. /// The that will be used when creating the object. @@ -2077,9 +2077,9 @@ namespace Newtonsoft.Json.Linq /// /// Creates a from a . /// - /// An positioned at the token to read into this . + /// A positioned at the token to read into this . /// - /// An that contains the token and its descendant tokens + /// A that contains the token and its descendant tokens /// that were read from the reader. The runtime type of the token is determined /// by the token type of the first token encountered in the reader. /// @@ -2188,11 +2188,11 @@ namespace Newtonsoft.Json.Linq /// /// Creates a from a . /// - /// An positioned at the token to read into this . + /// A positioned at the token to read into this . /// The used to load the JSON. /// If this is null, default load settings will be used. /// - /// An that contains the token and its descendant tokens + /// A that contains the token and its descendant tokens /// that were read from the reader. The runtime type of the token is determined /// by the token type of the first token encountered in the reader. /// @@ -2204,9 +2204,9 @@ namespace Newtonsoft.Json.Linq /// /// Creates a from a . /// - /// An positioned at the token to read into this . + /// A positioned at the token to read into this . /// - /// An that contains the token and its descendant tokens + /// A that contains the token and its descendant tokens /// that were read from the reader. The runtime type of the token is determined /// by the token type of the first token encountered in the reader. /// @@ -2505,7 +2505,7 @@ namespace Newtonsoft.Json.Linq /// Gets a collection of annotations of the specified type for this . /// /// The type of the annotations to retrieve. - /// An that contains the annotations for this . + /// An that contains the annotations for this . public IEnumerable Annotations() where T : class { if (_annotations == null) diff --git a/Src/Newtonsoft.Json/Linq/JValue.cs b/Src/Newtonsoft.Json/Linq/JValue.cs index 4ed0ad7a..43ea4519 100644 --- a/Src/Newtonsoft.Json/Linq/JValue.cs +++ b/Src/Newtonsoft.Json/Linq/JValue.cs @@ -869,9 +869,6 @@ namespace Newtonsoft.Json.Linq /// /// true if the specified is equal to the current ; otherwise, false. /// - /// - /// The parameter is null. - /// public override bool Equals(object obj) { if (obj == null) @@ -1079,7 +1076,7 @@ namespace Newtonsoft.Json.Linq /// This instance is greater than . /// /// - /// is not the same type as this instance. + /// is not of the same type as this instance. /// public int CompareTo(JValue obj) { diff --git a/Src/Newtonsoft.Json/Schema/JsonSchema.cs b/Src/Newtonsoft.Json/Schema/JsonSchema.cs index 7b322252..68b45dd1 100644 --- a/Src/Newtonsoft.Json/Schema/JsonSchema.cs +++ b/Src/Newtonsoft.Json/Schema/JsonSchema.cs @@ -59,7 +59,7 @@ namespace Newtonsoft.Json.Schema public bool? Required { get; set; } /// - /// Gets or sets whether the object is read only. + /// Gets or sets whether the object is read-only. /// public bool? ReadOnly { get; set; } @@ -103,9 +103,9 @@ namespace Newtonsoft.Json.Schema public int? MaximumLength { get; set; } /// - /// Gets or sets a number that the value should be divisble by. + /// Gets or sets a number that the value should be divisible by. /// - /// A number that the value should be divisble by. + /// A number that the value should be divisible by. public double? DivisibleBy { get; set; } /// @@ -288,21 +288,21 @@ namespace Newtonsoft.Json.Schema } /// - /// Load a from a string that contains schema JSON. + /// Load a from a string that contains JSON Schema. /// - /// A that contains JSON. - /// A populated from the string that contains JSON. + /// A that contains JSON Schema. + /// A populated from the string that contains JSON Schema. public static JsonSchema Parse(string json) { return Parse(json, new JsonSchemaResolver()); } /// - /// Parses the specified json. + /// Load a from a string that contains JSON Schema using the specified . /// - /// The json. + /// A that contains JSON Schema. /// The resolver. - /// A populated from the string that contains JSON. + /// A populated from the string that contains JSON Schema. public static JsonSchema Parse(string json, JsonSchemaResolver resolver) { ValidationUtils.ArgumentNotNull(json, nameof(json)); diff --git a/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs b/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs index f9503dbd..66e4748d 100644 --- a/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs +++ b/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs @@ -94,8 +94,8 @@ namespace Newtonsoft.Json.Schema /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonSchemaException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/Serialization/JsonContract.cs b/Src/Newtonsoft.Json/Serialization/JsonContract.cs index 6d0b2c37..4614f369 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonContract.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonContract.cs @@ -302,7 +302,7 @@ namespace Newtonsoft.Json.Serialization public Func DefaultCreator { get; set; } /// - /// Gets or sets a value indicating whether the default creator is non public. + /// Gets or sets a value indicating whether the default creator is non-public. /// /// true if the default object creator is non-public; otherwise, false. public bool DefaultCreatorNonPublic { get; set; } diff --git a/Src/Newtonsoft.Json/Serialization/JsonProperty.cs b/Src/Newtonsoft.Json/Serialization/JsonProperty.cs index 9b0ab584..720830a4 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonProperty.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonProperty.cs @@ -235,9 +235,9 @@ namespace Newtonsoft.Json.Serialization public TypeNameHandling? TypeNameHandling { get; set; } /// - /// Gets or sets a predicate used to determine whether the property should be serialize. + /// Gets or sets a predicate used to determine whether the property should be serialized. /// - /// A predicate used to determine whether the property should be serialize. + /// A predicate used to determine whether the property should be serialized. public Predicate ShouldSerialize { get; set; } /// diff --git a/Src/Newtonsoft.Json/Utilities/LinqBridge.cs b/Src/Newtonsoft.Json/Utilities/LinqBridge.cs index f1a08073..f24636f8 100644 --- a/Src/Newtonsoft.Json/Utilities/LinqBridge.cs +++ b/Src/Newtonsoft.Json/Utilities/LinqBridge.cs @@ -724,7 +724,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Returns an that represents the total number + /// Returns a that represents the total number /// of elements in a sequence. /// @@ -740,7 +740,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Returns an that represents how many elements + /// Returns a that represents how many elements /// in a sequence satisfy a condition. /// @@ -1777,7 +1777,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge internal partial class Enumerable { /// - /// Computes the sum of a sequence of nullable values. + /// Computes the sum of a sequence of values. /// public static int Sum( @@ -1793,7 +1793,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of nullable + /// Computes the sum of a sequence of /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -1806,7 +1806,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values. + /// Computes the average of a sequence of values. /// public static double Average( @@ -1831,7 +1831,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values + /// Computes the average of a sequence of values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -1845,7 +1845,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge /// - /// Computes the sum of a sequence of values. + /// Computes the sum of a sequence of nullable values. /// public static int? Sum( @@ -1861,7 +1861,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of + /// Computes the sum of a sequence of nullable /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -1874,7 +1874,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values. + /// Computes the average of a sequence of nullable values. /// public static double? Average( @@ -1899,7 +1899,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values + /// Computes the average of a sequence of nullable values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -1963,7 +1963,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of nullable values. + /// Computes the sum of a sequence of values. /// public static long Sum( @@ -1979,7 +1979,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of nullable + /// Computes the sum of a sequence of /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -1992,7 +1992,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values. + /// Computes the average of a sequence of values. /// public static double Average( @@ -2017,7 +2017,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values + /// Computes the average of a sequence of values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -2031,7 +2031,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge /// - /// Computes the sum of a sequence of values. + /// Computes the sum of a sequence of nullable values. /// public static long? Sum( @@ -2047,7 +2047,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of + /// Computes the sum of a sequence of nullable /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -2060,7 +2060,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values. + /// Computes the average of a sequence of nullable values. /// public static double? Average( @@ -2085,7 +2085,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values + /// Computes the average of a sequence of nullable values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -2165,7 +2165,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of nullable + /// Computes the sum of a sequence of /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -2178,7 +2178,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values. + /// Computes the average of a sequence of values. /// public static float Average( @@ -2203,7 +2203,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values + /// Computes the average of a sequence of values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -2217,7 +2217,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge /// - /// Computes the sum of a sequence of values. + /// Computes the sum of a sequence of nullable values. /// public static float? Sum( @@ -2233,7 +2233,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of + /// Computes the sum of a sequence of nullable /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -2246,7 +2246,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values. + /// Computes the average of a sequence of nullable values. /// public static float? Average( @@ -2271,7 +2271,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values + /// Computes the average of a sequence of nullable values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -2335,7 +2335,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of nullable values. + /// Computes the sum of a sequence of values. /// public static double Sum( @@ -2351,7 +2351,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of nullable + /// Computes the sum of a sequence of /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -2364,7 +2364,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values. + /// Computes the average of a sequence of values. /// public static double Average( @@ -2389,7 +2389,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values + /// Computes the average of a sequence of values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -2403,7 +2403,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge /// - /// Computes the sum of a sequence of values. + /// Computes the sum of a sequence of nullable values. /// public static double? Sum( @@ -2419,7 +2419,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of + /// Computes the sum of a sequence of nullable /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -2432,7 +2432,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values. + /// Computes the average of a sequence of nullable values. /// public static double? Average( @@ -2457,7 +2457,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values + /// Computes the average of a sequence of nullable values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -2521,7 +2521,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of nullable values. + /// Computes the sum of a sequence of values. /// public static decimal Sum( @@ -2537,7 +2537,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of nullable + /// Computes the sum of a sequence of /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -2550,7 +2550,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values. + /// Computes the average of a sequence of values. /// public static decimal Average( @@ -2575,7 +2575,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of nullable values + /// Computes the average of a sequence of values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// @@ -2589,7 +2589,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge /// - /// Computes the sum of a sequence of values. + /// Computes the sum of a sequence of nullable values. /// public static decimal? Sum( @@ -2605,7 +2605,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the sum of a sequence of + /// Computes the sum of a sequence of nullable /// values that are obtained by invoking a transform function on /// each element of the input sequence. /// @@ -2618,7 +2618,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values. + /// Computes the average of a sequence of nullable values. /// public static decimal? Average( @@ -2643,7 +2643,7 @@ namespace Newtonsoft.Json.Utilities.LinqBridge } /// - /// Computes the average of a sequence of values + /// Computes the average of a sequence of nullable values /// that are obtained by invoking a transform function on each /// element of the input sequence. /// diff --git a/Src/Newtonsoft.Json/Utilities/MethodBinder.cs b/Src/Newtonsoft.Json/Utilities/MethodBinder.cs index 396f5af4..ee9af05e 100644 --- a/Src/Newtonsoft.Json/Utilities/MethodBinder.cs +++ b/Src/Newtonsoft.Json/Utilities/MethodBinder.cs @@ -39,9 +39,9 @@ /// Checks if value of primitive type can be /// assigned to parameter of primitive type . /// - /// Source primitive type - /// Target primitive type - /// True if source type can be widened to target type, false otherwise + /// Source primitive type. + /// Target primitive type. + /// True if source type can be widened to target type, false otherwise. private static bool CanConvertPrimitive(Type from, Type to) { if (from == to) @@ -77,10 +77,10 @@ /// Checks if a set of values with given can be used /// to invoke a method with specified . /// - /// Method parameters - /// Argument types - /// Try to pack extra arguments into ParamArray - /// True if method can be called with given arguments, false otherwise + /// Method parameters. + /// Argument types. + /// Try to pack extra arguments into ParamArray. + /// True if method can be called with given arguments, false otherwise. private static bool FilterParameters(ParameterInfo[] parameters, IList types, bool enableParamArray) { ValidationUtils.ArgumentNotNull(parameters, nameof(parameters)); @@ -293,11 +293,11 @@ } /// - /// Retunrs a best method overload for given argument . + /// Returns a best method overload for given argument . /// - /// List of method candidates - /// Argument types - /// Best method overload, or null if none matched + /// List of method candidates. + /// Argument types. + /// Best method overload, or null if none matched. public static TMethod SelectMethod(IEnumerable candidates, IList types) where TMethod : MethodBase { ValidationUtils.ArgumentNotNull(candidates, nameof(candidates)); From 937d5a53bbd1b218a90bf67f095c49f05cbeee24 Mon Sep 17 00:00:00 2001 From: stakx Date: Mon, 19 Dec 2016 09:27:59 +0100 Subject: [PATCH 2/4] XML comments: consistent formatting of C# keywords --- Src/Newtonsoft.Json/FloatFormatHandling.cs | 2 +- Src/Newtonsoft.Json/JsonContainerAttribute.cs | 8 +++--- Src/Newtonsoft.Json/JsonConvert.cs | 26 +++++++++---------- Src/Newtonsoft.Json/JsonConverterAttribute.cs | 4 +-- Src/Newtonsoft.Json/JsonException.cs | 6 ++--- Src/Newtonsoft.Json/JsonPropertyAttribute.cs | 8 +++--- Src/Newtonsoft.Json/JsonReader.cs | 2 +- Src/Newtonsoft.Json/JsonReaderException.cs | 6 ++--- .../JsonSerializationException.cs | 6 ++--- Src/Newtonsoft.Json/JsonTextReader.cs | 6 ++--- Src/Newtonsoft.Json/JsonValidatingReader.cs | 2 +- Src/Newtonsoft.Json/JsonWriter.cs | 3 ++- Src/Newtonsoft.Json/JsonWriterException.cs | 6 ++--- Src/Newtonsoft.Json/Linq/JArray.cs | 10 +++---- Src/Newtonsoft.Json/Linq/JConstructor.cs | 2 +- Src/Newtonsoft.Json/Linq/JObject.cs | 6 ++--- Src/Newtonsoft.Json/Linq/JProperty.cs | 2 +- Src/Newtonsoft.Json/Linq/JToken.cs | 8 +++--- .../Linq/JTokenEqualityComparer.cs | 2 +- Src/Newtonsoft.Json/MemberSerialization.cs | 2 +- .../Schema/JsonSchemaException.cs | 6 ++--- .../Serialization/DefaultContractResolver.cs | 2 +- .../Serialization/IAttributeProvider.cs | 4 +-- .../Serialization/JsonTypeReflector.cs | 2 +- .../ReflectionAttributeProvider.cs | 4 +-- .../Utilities/CollectionUtils.cs | 4 +-- Src/Newtonsoft.Json/Utilities/MethodBinder.cs | 4 +-- Src/Newtonsoft.Json/Utilities/StringUtils.cs | 2 +- 28 files changed, 73 insertions(+), 72 deletions(-) diff --git a/Src/Newtonsoft.Json/FloatFormatHandling.cs b/Src/Newtonsoft.Json/FloatFormatHandling.cs index 51c4603e..6a9ba6af 100644 --- a/Src/Newtonsoft.Json/FloatFormatHandling.cs +++ b/Src/Newtonsoft.Json/FloatFormatHandling.cs @@ -43,7 +43,7 @@ namespace Newtonsoft.Json Symbol = 1, /// - /// Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a property. + /// Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a property. /// DefaultValue = 2 } diff --git a/Src/Newtonsoft.Json/JsonContainerAttribute.cs b/Src/Newtonsoft.Json/JsonContainerAttribute.cs index 7977d8e3..266d2b47 100644 --- a/Src/Newtonsoft.Json/JsonContainerAttribute.cs +++ b/Src/Newtonsoft.Json/JsonContainerAttribute.cs @@ -60,8 +60,8 @@ namespace Newtonsoft.Json /// /// 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, + /// 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. /// /// @@ -87,8 +87,8 @@ namespace Newtonsoft.Json /// /// 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, + /// 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. /// /// diff --git a/Src/Newtonsoft.Json/JsonConvert.cs b/Src/Newtonsoft.Json/JsonConvert.cs index 965a1cc2..ccff0aff 100644 --- a/Src/Newtonsoft.Json/JsonConvert.cs +++ b/Src/Newtonsoft.Json/JsonConvert.cs @@ -579,7 +579,7 @@ namespace Newtonsoft.Json /// /// The object to serialize. /// The used to serialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// A JSON string representation of the object. /// @@ -593,7 +593,7 @@ namespace Newtonsoft.Json /// /// The object to serialize. /// The used to serialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// The type of the value being serialized. /// This parameter is used when is Auto to write out the type name if the type of the value does not match. @@ -615,7 +615,7 @@ namespace Newtonsoft.Json /// The object to serialize. /// Indicates how the output should be formatted. /// The used to serialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// A JSON string representation of the object. /// @@ -630,7 +630,7 @@ namespace Newtonsoft.Json /// The object to serialize. /// Indicates how the output should be formatted. /// The used to serialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// The type of the value being serialized. /// This parameter is used when is Auto to write out the type name if the type of the value does not match. @@ -698,7 +698,7 @@ namespace Newtonsoft.Json /// The object to serialize. /// Indicates how the output should be formatted. /// The used to serialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// A task that represents the asynchronous serialization operation. The value of the TResult parameter contains a JSON string representation of the object. /// @@ -727,7 +727,7 @@ namespace Newtonsoft.Json /// The JSON to deserialize. /// /// The used to deserialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// The deserialized object from the JSON string. public static object DeserializeObject(string value, JsonSerializerSettings settings) @@ -785,7 +785,7 @@ namespace Newtonsoft.Json /// The anonymous type object. /// /// The used to deserialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// The deserialized anonymous type from the JSON string. public static T DeserializeAnonymousType(string value, T anonymousTypeObject, JsonSerializerSettings settings) @@ -812,7 +812,7 @@ namespace Newtonsoft.Json /// The object to deserialize. /// /// The used to deserialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// The deserialized object from the JSON string. public static T DeserializeObject(string value, JsonSerializerSettings settings) @@ -843,7 +843,7 @@ namespace Newtonsoft.Json /// The type of the object to deserialize to. /// /// The used to deserialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// The deserialized object from the JSON string. public static object DeserializeObject(string value, Type type, JsonSerializerSettings settings) @@ -888,7 +888,7 @@ namespace Newtonsoft.Json /// The JSON to deserialize. /// /// The used to deserialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// /// A task that represents the asynchronous deserialization operation. The value of the TResult parameter contains the deserialized object from the JSON string. @@ -921,7 +921,7 @@ namespace Newtonsoft.Json /// The type of the object to deserialize to. /// /// The used to deserialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// /// A task that represents the asynchronous deserialization operation. The value of the TResult parameter contains the deserialized object from the JSON string. @@ -952,7 +952,7 @@ namespace Newtonsoft.Json /// The target object to populate values onto. /// /// The used to deserialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// public static void PopulateObject(string value, object target, JsonSerializerSettings settings) { @@ -977,7 +977,7 @@ namespace Newtonsoft.Json /// The target object to populate values onto. /// /// The used to deserialize the object. - /// If this is null, default serialization settings will be used. + /// If this is null, default serialization settings will be used. /// /// /// A task that represents the asynchronous population operation. diff --git a/Src/Newtonsoft.Json/JsonConverterAttribute.cs b/Src/Newtonsoft.Json/JsonConverterAttribute.cs index 6f112b4c..ef9d2c11 100644 --- a/Src/Newtonsoft.Json/JsonConverterAttribute.cs +++ b/Src/Newtonsoft.Json/JsonConverterAttribute.cs @@ -48,7 +48,7 @@ namespace Newtonsoft.Json /// /// The parameter list to use when constructing the described by . - /// If null, the default constructor is used. + /// If null, the default constructor is used. /// public object[] ConverterParameters { get; private set; } @@ -70,7 +70,7 @@ namespace Newtonsoft.Json /// Initializes a new instance of the class. /// /// Type of the . - /// Parameter list to use when constructing the . Can be null. + /// Parameter list to use when constructing the . Can be null. public JsonConverterAttribute(Type converterType, params object[] converterParameters) : this(converterType) { diff --git a/Src/Newtonsoft.Json/JsonException.cs b/Src/Newtonsoft.Json/JsonException.cs index 306916ac..e1460324 100644 --- a/Src/Newtonsoft.Json/JsonException.cs +++ b/Src/Newtonsoft.Json/JsonException.cs @@ -62,7 +62,7 @@ namespace Newtonsoft.Json /// with a specified error message and a reference to the inner exception that is the cause of this exception. /// /// The error message that explains the reason for the exception. - /// The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + /// The exception that is the cause of the current exception, or null if no inner exception is specified. public JsonException(string message, Exception innerException) : base(message, innerException) { @@ -74,8 +74,8 @@ namespace Newtonsoft.Json /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonPropertyAttribute.cs b/Src/Newtonsoft.Json/JsonPropertyAttribute.cs index a3de89ae..46e582fd 100644 --- a/Src/Newtonsoft.Json/JsonPropertyAttribute.cs +++ b/Src/Newtonsoft.Json/JsonPropertyAttribute.cs @@ -56,8 +56,8 @@ namespace Newtonsoft.Json /// /// 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, + /// 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. /// /// @@ -75,8 +75,8 @@ namespace Newtonsoft.Json /// /// The parameter list to use when constructing the described by NamingStrategyType. - /// If null, the default constructor is used. - /// When non-null, there must be a constructor defined in the that exactly matches the number, + /// 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. /// /// diff --git a/Src/Newtonsoft.Json/JsonReader.cs b/Src/Newtonsoft.Json/JsonReader.cs index 0ac78138..a1e52dd9 100644 --- a/Src/Newtonsoft.Json/JsonReader.cs +++ b/Src/Newtonsoft.Json/JsonReader.cs @@ -509,7 +509,7 @@ namespace Newtonsoft.Json /// /// Reads the next JSON token from the stream as a []. /// - /// A [] or a null reference if the next JSON token is null. This method will return null at the end of an array. + /// A [] or null if the next JSON token is null. This method will return null at the end of an array. public virtual byte[] ReadAsBytes() { JsonToken t = GetContentToken(); diff --git a/Src/Newtonsoft.Json/JsonReaderException.cs b/Src/Newtonsoft.Json/JsonReaderException.cs index e74b29dc..6348df94 100644 --- a/Src/Newtonsoft.Json/JsonReaderException.cs +++ b/Src/Newtonsoft.Json/JsonReaderException.cs @@ -78,7 +78,7 @@ namespace Newtonsoft.Json /// with a specified error message and a reference to the inner exception that is the cause of this exception. /// /// The error message that explains the reason for the exception. - /// The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + /// The exception that is the cause of the current exception, or null if no inner exception is specified. public JsonReaderException(string message, Exception innerException) : base(message, innerException) { @@ -90,8 +90,8 @@ namespace Newtonsoft.Json /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonReaderException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonSerializationException.cs b/Src/Newtonsoft.Json/JsonSerializationException.cs index 5ba3ede4..13baa0bd 100644 --- a/Src/Newtonsoft.Json/JsonSerializationException.cs +++ b/Src/Newtonsoft.Json/JsonSerializationException.cs @@ -60,7 +60,7 @@ namespace Newtonsoft.Json /// with a specified error message and a reference to the inner exception that is the cause of this exception. /// /// The error message that explains the reason for the exception. - /// The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + /// The exception that is the cause of the current exception, or null if no inner exception is specified. public JsonSerializationException(string message, Exception innerException) : base(message, innerException) { @@ -72,8 +72,8 @@ namespace Newtonsoft.Json /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonSerializationException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonTextReader.cs b/Src/Newtonsoft.Json/JsonTextReader.cs index ff1f8a95..8a05f306 100644 --- a/Src/Newtonsoft.Json/JsonTextReader.cs +++ b/Src/Newtonsoft.Json/JsonTextReader.cs @@ -445,7 +445,7 @@ namespace Newtonsoft.Json /// /// Reads the next JSON token from the stream as a []. /// - /// A [] or a null reference if the next JSON token is null. This method will return null at the end of an array. + /// A [] or null if the next JSON token is null. This method will return null at the end of an array. public override byte[] ReadAsBytes() { EnsureBuffer(); @@ -2440,7 +2440,7 @@ namespace Newtonsoft.Json /// 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, HasLineInfo returns false). /// public int LineNumber { @@ -2459,7 +2459,7 @@ namespace Newtonsoft.Json /// 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, HasLineInfo returns false). /// public int LinePosition { diff --git a/Src/Newtonsoft.Json/JsonValidatingReader.cs b/Src/Newtonsoft.Json/JsonValidatingReader.cs index ecb1b3d4..26c0db7e 100644 --- a/Src/Newtonsoft.Json/JsonValidatingReader.cs +++ b/Src/Newtonsoft.Json/JsonValidatingReader.cs @@ -407,7 +407,7 @@ namespace Newtonsoft.Json /// Reads the next JSON token from the stream as a []. /// /// - /// A [] or a null reference if the next JSON token is null. + /// A [] or null if the next JSON token is null. /// public override byte[] ReadAsBytes() { diff --git a/Src/Newtonsoft.Json/JsonWriter.cs b/Src/Newtonsoft.Json/JsonWriter.cs index bbaa16c4..7555e293 100644 --- a/Src/Newtonsoft.Json/JsonWriter.cs +++ b/Src/Newtonsoft.Json/JsonWriter.cs @@ -505,7 +505,8 @@ namespace Newtonsoft.Json /// /// The value to write. /// A value is only required for tokens that have an associated value, e.g. the property name for . - /// A null value can be passed to the method for token's that don't have a value, e.g. . + /// null can be passed to the method for tokens that don't have a value, e.g. . + /// public void WriteToken(JsonToken token, object value) { switch (token) diff --git a/Src/Newtonsoft.Json/JsonWriterException.cs b/Src/Newtonsoft.Json/JsonWriterException.cs index 7c0f1b8c..c24169d5 100644 --- a/Src/Newtonsoft.Json/JsonWriterException.cs +++ b/Src/Newtonsoft.Json/JsonWriterException.cs @@ -66,7 +66,7 @@ namespace Newtonsoft.Json /// with a specified error message and a reference to the inner exception that is the cause of this exception. /// /// The error message that explains the reason for the exception. - /// The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + /// The exception that is the cause of the current exception, or null if no inner exception is specified. public JsonWriterException(string message, Exception innerException) : base(message, innerException) { @@ -78,8 +78,8 @@ namespace Newtonsoft.Json /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonWriterException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/Linq/JArray.cs b/Src/Newtonsoft.Json/Linq/JArray.cs index eb6fc7a6..e2b8aaea 100644 --- a/Src/Newtonsoft.Json/Linq/JArray.cs +++ b/Src/Newtonsoft.Json/Linq/JArray.cs @@ -120,7 +120,7 @@ namespace Newtonsoft.Json.Linq /// /// A that will be read for the content of the . /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// A that contains the JSON that was read from the specified . public new static JArray Load(JsonReader reader, JsonLoadSettings settings) { @@ -165,7 +165,7 @@ namespace Newtonsoft.Json.Linq /// /// A that contains JSON. /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// A populated from the string that contains JSON. /// /// @@ -363,7 +363,7 @@ namespace Newtonsoft.Json.Linq /// /// The object to locate in the . /// - /// true if is found in the ; otherwise, false. + /// true if is found in the ; otherwise, false. /// public bool Contains(JToken item) { @@ -383,7 +383,7 @@ namespace Newtonsoft.Json.Linq /// /// Gets a value indicating whether the is read-only. /// - /// true if the is read-only; otherwise, false. + /// true if the is read-only; otherwise, false. public bool IsReadOnly { get { return false; } @@ -394,7 +394,7 @@ namespace Newtonsoft.Json.Linq /// /// The object to remove from the . /// - /// true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + /// true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . /// /// The is read-only. public bool Remove(JToken item) diff --git a/Src/Newtonsoft.Json/Linq/JConstructor.cs b/Src/Newtonsoft.Json/Linq/JConstructor.cs index 1411caf6..83d57f9a 100644 --- a/Src/Newtonsoft.Json/Linq/JConstructor.cs +++ b/Src/Newtonsoft.Json/Linq/JConstructor.cs @@ -222,7 +222,7 @@ namespace Newtonsoft.Json.Linq /// /// A that will be read for the content of the . /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// A that contains the JSON that was read from the specified . public new static JConstructor Load(JsonReader reader, JsonLoadSettings settings) { diff --git a/Src/Newtonsoft.Json/Linq/JObject.cs b/Src/Newtonsoft.Json/Linq/JObject.cs index 96f1ed83..1993ed0f 100644 --- a/Src/Newtonsoft.Json/Linq/JObject.cs +++ b/Src/Newtonsoft.Json/Linq/JObject.cs @@ -256,7 +256,7 @@ namespace Newtonsoft.Json.Linq /// Gets a the specified name. /// /// The property name. - /// A with the specified name or null. + /// A with the specified name or null. public JProperty Property(string name) { if (name == null) @@ -360,7 +360,7 @@ namespace Newtonsoft.Json.Linq /// /// A that will be read for the content of the . /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// A that contains the JSON that was read from the specified . /// /// is not valid JSON. @@ -413,7 +413,7 @@ namespace Newtonsoft.Json.Linq /// /// A that contains JSON. /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// A populated from the string that contains JSON. /// /// is not valid JSON. diff --git a/Src/Newtonsoft.Json/Linq/JProperty.cs b/Src/Newtonsoft.Json/Linq/JProperty.cs index 3b15175b..bf1c1578 100644 --- a/Src/Newtonsoft.Json/Linq/JProperty.cs +++ b/Src/Newtonsoft.Json/Linq/JProperty.cs @@ -375,7 +375,7 @@ namespace Newtonsoft.Json.Linq /// /// A that will be read for the content of the . /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// A that contains the JSON that was read from the specified . public new static JProperty Load(JsonReader reader, JsonLoadSettings settings) { diff --git a/Src/Newtonsoft.Json/Linq/JToken.cs b/Src/Newtonsoft.Json/Linq/JToken.cs index 4e71bed4..22d07145 100644 --- a/Src/Newtonsoft.Json/Linq/JToken.cs +++ b/Src/Newtonsoft.Json/Linq/JToken.cs @@ -2093,7 +2093,7 @@ namespace Newtonsoft.Json.Linq /// /// An positioned at the token to read into this . /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// /// An that contains the token and its descendant tokens /// that were read from the reader. The runtime type of the token is determined @@ -2168,7 +2168,7 @@ namespace Newtonsoft.Json.Linq /// /// A that contains JSON. /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// A populated from the string that contains JSON. public static JToken Parse(string json, JsonLoadSettings settings) { @@ -2190,7 +2190,7 @@ namespace Newtonsoft.Json.Linq /// /// A positioned at the token to read into this . /// The used to load the JSON. - /// If this is null, default load settings will be used. + /// If this is null, default load settings will be used. /// /// A that contains the token and its descendant tokens /// that were read from the reader. The runtime type of the token is determined @@ -2286,7 +2286,7 @@ namespace Newtonsoft.Json.Linq /// /// A that contains a JPath expression. /// - /// A , or null. + /// A , or null. public JToken SelectToken(string path) { return SelectToken(path, false); diff --git a/Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs b/Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs index 33dd3f13..1c9dd536 100644 --- a/Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs +++ b/Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs @@ -50,7 +50,7 @@ namespace Newtonsoft.Json.Linq /// /// The for which a hash code is to be returned. /// A hash code for the specified object. - /// The type of is a reference type and is null. + /// The type of is a reference type and is null. public int GetHashCode(JToken obj) { if (obj == null) diff --git a/Src/Newtonsoft.Json/MemberSerialization.cs b/Src/Newtonsoft.Json/MemberSerialization.cs index 83099929..b3fd7d9e 100644 --- a/Src/Newtonsoft.Json/MemberSerialization.cs +++ b/Src/Newtonsoft.Json/MemberSerialization.cs @@ -50,7 +50,7 @@ namespace Newtonsoft.Json /// /// All public and private fields are serialized. Members can be excluded using or . /// This member serialization mode can also be set by marking the class with - /// and setting IgnoreSerializableAttribute on to false. + /// and setting IgnoreSerializableAttribute on to false. /// Fields = 2 #pragma warning restore 1584,1711,1572,1581,1580,1574 diff --git a/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs b/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs index 66e4748d..a674e704 100644 --- a/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs +++ b/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs @@ -82,7 +82,7 @@ namespace Newtonsoft.Json.Schema /// with a specified error message and a reference to the inner exception that is the cause of this exception. /// /// The error message that explains the reason for the exception. - /// The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + /// The exception that is the cause of the current exception, or null if no inner exception is specified. public JsonSchemaException(string message, Exception innerException) : base(message, innerException) { @@ -94,8 +94,8 @@ namespace Newtonsoft.Json.Schema /// /// The that holds the serialized object data about the exception being thrown. /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The parameter is null. + /// The class name is null or is zero (0). public JsonSchemaException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs index d3263d75..9ec84b23 100644 --- a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs +++ b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs @@ -211,7 +211,7 @@ namespace Newtonsoft.Json.Serialization /// If set to true the will use a cached shared with other resolvers of the same type. /// Sharing the cache will significantly improve performance with multiple resolver instances because expensive reflection will only /// happen once. This setting can cause unexpected behavior if different instances of the resolver are suppose to produce different - /// results. When set to false it is highly recommended to reuse instances with the . + /// results. When set to false it is highly recommended to reuse instances with the . /// [ObsoleteAttribute("DefaultContractResolver(bool) is obsolete. Use the parameterless constructor and cache instances of the contract resolver within your application for optimal performance.")] public DefaultContractResolver(bool shareCache) diff --git a/Src/Newtonsoft.Json/Serialization/IAttributeProvider.cs b/Src/Newtonsoft.Json/Serialization/IAttributeProvider.cs index 97a64693..b3517b74 100644 --- a/Src/Newtonsoft.Json/Serialization/IAttributeProvider.cs +++ b/Src/Newtonsoft.Json/Serialization/IAttributeProvider.cs @@ -36,7 +36,7 @@ namespace Newtonsoft.Json.Serialization /// /// Returns a collection of all of the attributes, or an empty collection if there are no attributes. /// - /// When true, look up the hierarchy chain for the inherited custom attribute. + /// When true, look up the hierarchy chain for the inherited custom attribute. /// A collection of s, or an empty collection. IList GetAttributes(bool inherit); @@ -44,7 +44,7 @@ namespace Newtonsoft.Json.Serialization /// Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. /// /// The type of the attributes. - /// When true, look up the hierarchy chain for the inherited custom attribute. + /// When true, look up the hierarchy chain for the inherited custom attribute. /// A collection of s, or an empty collection. IList GetAttributes(Type attributeType, bool inherit); } diff --git a/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs b/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs index ae1b5349..2d3f8b1b 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs @@ -177,7 +177,7 @@ namespace Newtonsoft.Json.Serialization /// /// The JsonConverter type to create. /// Optional arguments to pass to an initializing constructor of the JsonConverter. - /// If null, the default constructor is used. + /// If null, the default constructor is used. public static JsonConverter CreateJsonConverterInstance(Type converterType, object[] converterArgs) { Func converterCreator = CreatorCache.Get(converterType); diff --git a/Src/Newtonsoft.Json/Serialization/ReflectionAttributeProvider.cs b/Src/Newtonsoft.Json/Serialization/ReflectionAttributeProvider.cs index 5e9bc4ec..f98f9884 100644 --- a/Src/Newtonsoft.Json/Serialization/ReflectionAttributeProvider.cs +++ b/Src/Newtonsoft.Json/Serialization/ReflectionAttributeProvider.cs @@ -50,7 +50,7 @@ namespace Newtonsoft.Json.Serialization /// /// Returns a collection of all of the attributes, or an empty collection if there are no attributes. /// - /// When true, look up the hierarchy chain for the inherited custom attribute. + /// When true, look up the hierarchy chain for the inherited custom attribute. /// A collection of s, or an empty collection. public IList GetAttributes(bool inherit) { @@ -61,7 +61,7 @@ namespace Newtonsoft.Json.Serialization /// Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. /// /// The type of the attributes. - /// When true, look up the hierarchy chain for the inherited custom attribute. + /// When true, look up the hierarchy chain for the inherited custom attribute. /// A collection of s, or an empty collection. public IList GetAttributes(Type attributeType, bool inherit) { diff --git a/Src/Newtonsoft.Json/Utilities/CollectionUtils.cs b/Src/Newtonsoft.Json/Utilities/CollectionUtils.cs index bd504720..8aae3058 100644 --- a/Src/Newtonsoft.Json/Utilities/CollectionUtils.cs +++ b/Src/Newtonsoft.Json/Utilities/CollectionUtils.cs @@ -42,11 +42,11 @@ namespace Newtonsoft.Json.Utilities internal static class CollectionUtils { /// - /// Determines whether the collection is null or empty. + /// Determines whether the collection is null or empty. /// /// The collection. /// - /// true if the collection is null or empty; otherwise, false. + /// true if the collection is null or empty; otherwise, false. /// public static bool IsNullOrEmpty(ICollection collection) { diff --git a/Src/Newtonsoft.Json/Utilities/MethodBinder.cs b/Src/Newtonsoft.Json/Utilities/MethodBinder.cs index ee9af05e..cff02ad0 100644 --- a/Src/Newtonsoft.Json/Utilities/MethodBinder.cs +++ b/Src/Newtonsoft.Json/Utilities/MethodBinder.cs @@ -41,7 +41,7 @@ /// /// Source primitive type. /// Target primitive type. - /// True if source type can be widened to target type, false otherwise. + /// true if source type can be widened to target type, false otherwise. private static bool CanConvertPrimitive(Type from, Type to) { if (from == to) @@ -80,7 +80,7 @@ /// Method parameters. /// Argument types. /// Try to pack extra arguments into ParamArray. - /// True if method can be called with given arguments, false otherwise. + /// true if method can be called with given arguments, false otherwise. private static bool FilterParameters(ParameterInfo[] parameters, IList types, bool enableParamArray) { ValidationUtils.ArgumentNotNull(parameters, nameof(parameters)); diff --git a/Src/Newtonsoft.Json/Utilities/StringUtils.cs b/Src/Newtonsoft.Json/Utilities/StringUtils.cs index 938823e0..858e3040 100644 --- a/Src/Newtonsoft.Json/Utilities/StringUtils.cs +++ b/Src/Newtonsoft.Json/Utilities/StringUtils.cs @@ -75,7 +75,7 @@ namespace Newtonsoft.Json.Utilities } /// - /// Determines whether the string is all white space. Empty string will return false. + /// Determines whether the string is all white space. Empty string will return false. /// /// The string to test whether it is all white space. /// From e19ac3f28c5795f0fe3fb9bc17a134913438f2ff Mon Sep 17 00:00:00 2001 From: stakx Date: Thu, 22 Dec 2016 19:38:20 +0100 Subject: [PATCH 3/4] Add & fix crefs in XML document comments * Add references to types where they are missing. * Fix incorrect references to closed generic types. * Convert member ID strings to proper references where they can be converted without breaking the build. The remaining member ID strings usually mean that the comment would have to be rephrased for at least one build target / platform. * Drop namespaces from type names where they are unnecessary. * Fix the odd typo and add additional markup in a few places. --- Src/Newtonsoft.Json/Bson/BsonReader.cs | 2 +- .../Converters/EntityKeyMemberConverter.cs | 2 +- .../Converters/IsoDateTimeConverter.cs | 2 +- .../Converters/JavaScriptDateTimeConverter.cs | 2 +- .../Converters/VersionConverter.cs | 2 +- Src/Newtonsoft.Json/DateFormatHandling.cs | 4 +- Src/Newtonsoft.Json/DateParseHandling.cs | 6 +- Src/Newtonsoft.Json/FloatFormatHandling.cs | 12 +- Src/Newtonsoft.Json/FormatterAssemblyStyle.cs | 4 +- Src/Newtonsoft.Json/JsonConvert.cs | 28 ++-- Src/Newtonsoft.Json/JsonConverter.cs | 2 +- Src/Newtonsoft.Json/JsonException.cs | 8 +- Src/Newtonsoft.Json/JsonPropertyAttribute.cs | 2 +- Src/Newtonsoft.Json/JsonReader.cs | 33 ++--- Src/Newtonsoft.Json/JsonReaderException.cs | 8 +- .../JsonSerializationException.cs | 8 +- Src/Newtonsoft.Json/JsonSerializer.cs | 18 +-- Src/Newtonsoft.Json/JsonSerializerSettings.cs | 10 +- Src/Newtonsoft.Json/JsonTextReader.cs | 34 ++--- Src/Newtonsoft.Json/JsonTextWriter.cs | 16 +-- Src/Newtonsoft.Json/JsonToken.cs | 2 +- Src/Newtonsoft.Json/JsonValidatingReader.cs | 24 ++-- Src/Newtonsoft.Json/JsonWriter.cs | 76 +++++------ Src/Newtonsoft.Json/JsonWriterException.cs | 8 +- Src/Newtonsoft.Json/Linq/IJEnumerable.cs | 4 +- Src/Newtonsoft.Json/Linq/JArray.cs | 51 ++++--- Src/Newtonsoft.Json/Linq/JConstructor.cs | 4 +- Src/Newtonsoft.Json/Linq/JContainer.cs | 6 +- Src/Newtonsoft.Json/Linq/JEnumerable.cs | 20 +-- Src/Newtonsoft.Json/Linq/JObject.cs | 16 +-- Src/Newtonsoft.Json/Linq/JProperty.cs | 2 +- .../Linq/JPropertyDescriptor.cs | 8 +- Src/Newtonsoft.Json/Linq/JToken.cs | 128 +++++++++--------- .../Linq/JTokenEqualityComparer.cs | 4 +- Src/Newtonsoft.Json/Linq/JTokenWriter.cs | 2 +- Src/Newtonsoft.Json/Linq/JValue.cs | 32 ++--- .../PreserveReferencesHandling.cs | 2 +- Src/Newtonsoft.Json/Schema/JsonSchema.cs | 14 +- .../Schema/JsonSchemaException.cs | 8 +- .../Serialization/DefaultContractResolver.cs | 2 +- .../DefaultSerializationBinder.cs | 8 +- .../Serialization/DiagnosticsTraceWriter.cs | 4 +- .../Serialization/IContractResolver.cs | 2 +- .../Serialization/IReferenceResolver.cs | 2 +- .../Serialization/ITraceWriter.cs | 4 +- .../JsonISerializableContract.cs | 4 +- .../Serialization/JsonObjectContract.cs | 10 +- .../Serialization/JsonProperty.cs | 2 +- .../Serialization/JsonPropertyCollection.cs | 2 +- .../Serialization/JsonTypeReflector.cs | 4 +- .../Serialization/MemoryTraceWriter.cs | 4 +- .../Serialization/NamingStrategy.cs | 2 +- .../TypeNameAssemblyFormatHandling.cs | 4 +- Src/Newtonsoft.Json/TypeNameHandling.cs | 10 +- .../Utilities/CollectionUtils.cs | 2 +- Src/Newtonsoft.Json/Utilities/EnumUtils.cs | 2 +- Src/Newtonsoft.Json/Utilities/MethodBinder.cs | 2 +- Src/Newtonsoft.Json/Utilities/StringBuffer.cs | 2 +- Src/Newtonsoft.Json/WriteState.cs | 8 +- 59 files changed, 342 insertions(+), 352 deletions(-) diff --git a/Src/Newtonsoft.Json/Bson/BsonReader.cs b/Src/Newtonsoft.Json/Bson/BsonReader.cs index 00ecc7f3..69281fce 100644 --- a/Src/Newtonsoft.Json/Bson/BsonReader.cs +++ b/Src/Newtonsoft.Json/Bson/BsonReader.cs @@ -223,7 +223,7 @@ namespace Newtonsoft.Json.Bson } /// - /// Changes the to Closed. + /// Changes the reader's state to . /// public override void Close() { diff --git a/Src/Newtonsoft.Json/Converters/EntityKeyMemberConverter.cs b/Src/Newtonsoft.Json/Converters/EntityKeyMemberConverter.cs index 0211a92d..c0e9a6f4 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 to and from JSON. /// public class EntityKeyMemberConverter : JsonConverter { diff --git a/Src/Newtonsoft.Json/Converters/IsoDateTimeConverter.cs b/Src/Newtonsoft.Json/Converters/IsoDateTimeConverter.cs index ceb38797..3de10c75 100644 --- a/Src/Newtonsoft.Json/Converters/IsoDateTimeConverter.cs +++ b/Src/Newtonsoft.Json/Converters/IsoDateTimeConverter.cs @@ -30,7 +30,7 @@ using Newtonsoft.Json.Utilities; namespace Newtonsoft.Json.Converters { /// - /// Converts a to and from the ISO 8601 date format (e.g. 2008-04-12T12:53Z). + /// Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). /// public class IsoDateTimeConverter : DateTimeConverterBase { diff --git a/Src/Newtonsoft.Json/Converters/JavaScriptDateTimeConverter.cs b/Src/Newtonsoft.Json/Converters/JavaScriptDateTimeConverter.cs index 0f0e7ff4..c7508394 100644 --- a/Src/Newtonsoft.Json/Converters/JavaScriptDateTimeConverter.cs +++ b/Src/Newtonsoft.Json/Converters/JavaScriptDateTimeConverter.cs @@ -30,7 +30,7 @@ using Newtonsoft.Json.Utilities; namespace Newtonsoft.Json.Converters { /// - /// Converts a to and from a JavaScript date constructor (e.g. new Date(52231943)). + /// Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). /// public class JavaScriptDateTimeConverter : DateTimeConverterBase { diff --git a/Src/Newtonsoft.Json/Converters/VersionConverter.cs b/Src/Newtonsoft.Json/Converters/VersionConverter.cs index 3f512e44..df52718f 100644 --- a/Src/Newtonsoft.Json/Converters/VersionConverter.cs +++ b/Src/Newtonsoft.Json/Converters/VersionConverter.cs @@ -30,7 +30,7 @@ using Newtonsoft.Json.Utilities; namespace Newtonsoft.Json.Converters { /// - /// Converts a to and from a string (e.g. "1.2.3.4"). + /// Converts a to and from a string (e.g. "1.2.3.4"). /// public class VersionConverter : JsonConverter { diff --git a/Src/Newtonsoft.Json/DateFormatHandling.cs b/Src/Newtonsoft.Json/DateFormatHandling.cs index e26feec3..5c79ec90 100644 --- a/Src/Newtonsoft.Json/DateFormatHandling.cs +++ b/Src/Newtonsoft.Json/DateFormatHandling.cs @@ -31,12 +31,12 @@ namespace Newtonsoft.Json public enum DateFormatHandling { /// - /// Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + /// Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". /// IsoDateFormat, /// - /// Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + /// Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". /// MicrosoftDateFormat } diff --git a/Src/Newtonsoft.Json/DateParseHandling.cs b/Src/Newtonsoft.Json/DateParseHandling.cs index 359ac355..528b7c59 100644 --- a/Src/Newtonsoft.Json/DateParseHandling.cs +++ b/Src/Newtonsoft.Json/DateParseHandling.cs @@ -26,7 +26,7 @@ namespace Newtonsoft.Json { /// - /// Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + /// Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. /// public enum DateParseHandling { @@ -36,12 +36,12 @@ namespace Newtonsoft.Json None = 0, /// - /// Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + /// Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . /// DateTime = 1, #if !NET20 /// - /// Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + /// Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . /// DateTimeOffset = 2 #endif diff --git a/Src/Newtonsoft.Json/FloatFormatHandling.cs b/Src/Newtonsoft.Json/FloatFormatHandling.cs index 6a9ba6af..9b6bd4c1 100644 --- a/Src/Newtonsoft.Json/FloatFormatHandling.cs +++ b/Src/Newtonsoft.Json/FloatFormatHandling.cs @@ -23,27 +23,29 @@ // OTHER DEALINGS IN THE SOFTWARE. #endregion +using System; + namespace Newtonsoft.Json { /// - /// Specifies float format handling options when writing special floating point numbers, e.g. , - /// and with . + /// Specifies float format handling options when writing special floating point numbers, e.g. , + /// and with . /// public enum FloatFormatHandling { /// - /// Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + /// Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". /// 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, /// - /// Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a property. + /// Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. /// DefaultValue = 2 } diff --git a/Src/Newtonsoft.Json/FormatterAssemblyStyle.cs b/Src/Newtonsoft.Json/FormatterAssemblyStyle.cs index a42645db..e9eec6fd 100644 --- a/Src/Newtonsoft.Json/FormatterAssemblyStyle.cs +++ b/Src/Newtonsoft.Json/FormatterAssemblyStyle.cs @@ -9,12 +9,12 @@ 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 method is used to load the assembly. /// Simple = 0, /// - /// In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the Assembly class is used to load the assembly. + /// In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The is used to load the assembly. /// Full = 1 } diff --git a/Src/Newtonsoft.Json/JsonConvert.cs b/Src/Newtonsoft.Json/JsonConvert.cs index ccff0aff..b96eb19c 100644 --- a/Src/Newtonsoft.Json/JsonConvert.cs +++ b/Src/Newtonsoft.Json/JsonConvert.cs @@ -596,7 +596,7 @@ namespace Newtonsoft.Json /// If this is null, default serialization settings will be used. /// /// The type of the value being serialized. - /// This parameter is used when is Auto to write out the type name if the type of the value does not match. + /// This parameter is used when is to write out the type name if the type of the value does not match. /// Specifing the type is optional. /// /// @@ -633,7 +633,7 @@ namespace Newtonsoft.Json /// If this is null, default serialization settings will be used. /// /// The type of the value being serialized. - /// This parameter is used when is Auto to write out the type name if the type of the value does not match. + /// This parameter is used when is to write out the type name if the type of the value does not match. /// Specifing the type is optional. /// /// @@ -996,7 +996,7 @@ namespace Newtonsoft.Json /// Serializes the to a JSON string. /// /// The node to serialize. - /// A JSON string of the XmlNode. + /// A JSON string of the . public static string SerializeXmlNode(XmlNode node) { return SerializeXmlNode(node, Formatting.None); @@ -1007,7 +1007,7 @@ namespace Newtonsoft.Json /// /// The node to serialize. /// Indicates how the output should be formatted. - /// A JSON string of the XmlNode. + /// A JSON string of the . public static string SerializeXmlNode(XmlNode node, Formatting formatting) { XmlNodeConverter converter = new XmlNodeConverter(); @@ -1021,7 +1021,7 @@ namespace Newtonsoft.Json /// The node to serialize. /// Indicates how the output should be formatted. /// Omits writing the root object. - /// A JSON string of the XmlNode. + /// A JSON string of the . public static string SerializeXmlNode(XmlNode node, Formatting formatting, bool omitRootObject) { XmlNodeConverter converter = new XmlNodeConverter { OmitRootObject = omitRootObject }; @@ -1033,7 +1033,7 @@ namespace Newtonsoft.Json /// Deserializes the from a JSON string. /// /// The JSON string. - /// The deserialized XmlNode. + /// The deserialized . public static XmlDocument DeserializeXmlNode(string value) { return DeserializeXmlNode(value, null); @@ -1044,7 +1044,7 @@ namespace Newtonsoft.Json /// /// The JSON string. /// The name of the root element to append when deserializing. - /// The deserialized XmlNode. + /// The deserialized . public static XmlDocument DeserializeXmlNode(string value, string deserializeRootElementName) { return DeserializeXmlNode(value, deserializeRootElementName, false); @@ -1060,7 +1060,7 @@ namespace Newtonsoft.Json /// A flag to indicate whether to write the Json.NET array attribute. /// This attribute helps preserve arrays when converting the written XML back to JSON. /// - /// The deserialized XmlNode. + /// The deserialized . public static XmlDocument DeserializeXmlNode(string value, string deserializeRootElementName, bool writeArrayAttribute) { XmlNodeConverter converter = new XmlNodeConverter(); @@ -1076,7 +1076,7 @@ namespace Newtonsoft.Json /// Serializes the to a JSON string. /// /// The node to convert to JSON. - /// A JSON string of the XNode. + /// A JSON string of the . public static string SerializeXNode(XObject node) { return SerializeXNode(node, Formatting.None); @@ -1087,7 +1087,7 @@ namespace Newtonsoft.Json /// /// The node to convert to JSON. /// Indicates how the output should be formatted. - /// A JSON string of the XNode. + /// A JSON string of the . public static string SerializeXNode(XObject node, Formatting formatting) { return SerializeXNode(node, formatting, false); @@ -1099,7 +1099,7 @@ namespace Newtonsoft.Json /// The node to serialize. /// Indicates how the output should be formatted. /// Omits writing the root object. - /// A JSON string of the XNode. + /// A JSON string of the . public static string SerializeXNode(XObject node, Formatting formatting, bool omitRootObject) { XmlNodeConverter converter = new XmlNodeConverter { OmitRootObject = omitRootObject }; @@ -1111,7 +1111,7 @@ namespace Newtonsoft.Json /// Deserializes the from a JSON string. /// /// The JSON string. - /// The deserialized XNode. + /// The deserialized . public static XDocument DeserializeXNode(string value) { return DeserializeXNode(value, null); @@ -1122,7 +1122,7 @@ namespace Newtonsoft.Json /// /// The JSON string. /// The name of the root element to append when deserializing. - /// The deserialized XNode. + /// The deserialized . public static XDocument DeserializeXNode(string value, string deserializeRootElementName) { return DeserializeXNode(value, deserializeRootElementName, false); @@ -1138,7 +1138,7 @@ namespace Newtonsoft.Json /// A flag to indicate whether to write the Json.NET array attribute. /// This attribute helps preserve arrays when converting the written XML back to JSON. /// - /// The deserialized XNode. + /// The deserialized . public static XDocument DeserializeXNode(string value, string deserializeRootElementName, bool writeArrayAttribute) { XmlNodeConverter converter = new XmlNodeConverter(); diff --git a/Src/Newtonsoft.Json/JsonConverter.cs b/Src/Newtonsoft.Json/JsonConverter.cs index d78785b2..45895401 100644 --- a/Src/Newtonsoft.Json/JsonConverter.cs +++ b/Src/Newtonsoft.Json/JsonConverter.cs @@ -71,7 +71,7 @@ namespace Newtonsoft.Json /// JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. /// /// - /// The of the JSON produced by the JsonConverter. + /// The of the JSON produced by the . [Obsolete("JSON Schema validation has been moved to its own package. It is strongly recommended that you do not override GetSchema() in your own converter. It is not used by Json.NET and will be removed at some point in the future. Converter's that override GetSchema() will stop working when it is removed.")] public virtual JsonSchema GetSchema() { diff --git a/Src/Newtonsoft.Json/JsonException.cs b/Src/Newtonsoft.Json/JsonException.cs index e1460324..ab7835aa 100644 --- a/Src/Newtonsoft.Json/JsonException.cs +++ b/Src/Newtonsoft.Json/JsonException.cs @@ -72,10 +72,10 @@ namespace Newtonsoft.Json /// /// Initializes a new instance of the class. /// - /// The that holds the serialized object data about the exception being thrown. - /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The that holds the serialized object data about the exception being thrown. + /// The that contains contextual information about the source or destination. + /// The parameter is null. + /// The class name is null or is zero (0). public JsonException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonPropertyAttribute.cs b/Src/Newtonsoft.Json/JsonPropertyAttribute.cs index 46e582fd..0d437f86 100644 --- a/Src/Newtonsoft.Json/JsonPropertyAttribute.cs +++ b/Src/Newtonsoft.Json/JsonPropertyAttribute.cs @@ -74,7 +74,7 @@ namespace Newtonsoft.Json public Type NamingStrategyType { get; set; } /// - /// 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. diff --git a/Src/Newtonsoft.Json/JsonReader.cs b/Src/Newtonsoft.Json/JsonReader.cs index a1e52dd9..1c6e6b1b 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 method has not been called. + /// A read method has not been called. /// Start, @@ -86,7 +86,7 @@ namespace Newtonsoft.Json Array, /// - /// The method has been called. + /// The method has been called. /// Closed, @@ -412,9 +412,9 @@ namespace Newtonsoft.Json public abstract bool Read(); /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public virtual int? ReadAsInt32() { JsonToken t = GetContentToken(); @@ -606,9 +606,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public virtual double? ReadAsDouble() { JsonToken t = GetContentToken(); @@ -668,9 +668,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public virtual bool? ReadAsBoolean() { JsonToken t = GetContentToken(); @@ -729,9 +729,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public virtual decimal? ReadAsDecimal() { JsonToken t = GetContentToken(); @@ -779,9 +779,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public virtual DateTime? ReadAsDateTime() { switch (GetContentToken()) @@ -835,9 +835,9 @@ namespace Newtonsoft.Json #if !NET20 /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public virtual DateTimeOffset? ReadAsDateTimeOffset() { JsonToken t = GetContentToken(); @@ -1104,9 +1104,6 @@ namespace Newtonsoft.Json } } - /// - /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - /// void IDisposable.Dispose() { Dispose(true); @@ -1126,7 +1123,7 @@ namespace Newtonsoft.Json } /// - /// Changes the to Closed. + /// Changes the reader's state to . /// public virtual void Close() { diff --git a/Src/Newtonsoft.Json/JsonReaderException.cs b/Src/Newtonsoft.Json/JsonReaderException.cs index 6348df94..766bcc4a 100644 --- a/Src/Newtonsoft.Json/JsonReaderException.cs +++ b/Src/Newtonsoft.Json/JsonReaderException.cs @@ -88,10 +88,10 @@ namespace Newtonsoft.Json /// /// Initializes a new instance of the class. /// - /// The that holds the serialized object data about the exception being thrown. - /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The that holds the serialized object data about the exception being thrown. + /// The that contains contextual information about the source or destination. + /// The parameter is null. + /// The class name is null or is zero (0). public JsonReaderException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonSerializationException.cs b/Src/Newtonsoft.Json/JsonSerializationException.cs index 13baa0bd..e193b0fc 100644 --- a/Src/Newtonsoft.Json/JsonSerializationException.cs +++ b/Src/Newtonsoft.Json/JsonSerializationException.cs @@ -70,10 +70,10 @@ namespace Newtonsoft.Json /// /// Initializes a new instance of the class. /// - /// The that holds the serialized object data about the exception being thrown. - /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The that holds the serialized object data about the exception being thrown. + /// The that contains contextual information about the source or destination. + /// The parameter is null. + /// The class name is null or is zero (0). public JsonSerializationException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/JsonSerializer.cs b/Src/Newtonsoft.Json/JsonSerializer.cs index 796485f8..108a9f6c 100644 --- a/Src/Newtonsoft.Json/JsonSerializer.cs +++ b/Src/Newtonsoft.Json/JsonSerializer.cs @@ -171,9 +171,9 @@ namespace Newtonsoft.Json /// Gets or sets how type name writing and reading is handled by the serializer. /// /// - /// should be used with caution when your application deserializes JSON from an external source. - /// Incoming types should be validated with a custom - /// when deserializing with a value other than TypeNameHandling.None. + /// should be used with caution when your application deserializes JSON from an external source. + /// Incoming types should be validated with a custom + /// when deserializing with a value other than . /// public virtual TypeNameHandling TypeNameHandling { @@ -430,7 +430,7 @@ namespace Newtonsoft.Json } /// - /// Gets or sets 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 { @@ -448,8 +448,8 @@ namespace Newtonsoft.Json } /// - /// Gets or sets how special floating point numbers, e.g. , - /// and , + /// Gets or sets how special floating point numbers, e.g. , + /// and , /// are written as JSON text. /// public virtual FloatFormatHandling FloatFormatHandling @@ -994,7 +994,7 @@ namespace Newtonsoft.Json /// /// Serializes the specified and writes the JSON structure - /// to a Stream using the specified . + /// to a using the specified . /// /// The used to write the JSON structure. /// The to serialize. @@ -1005,13 +1005,13 @@ namespace Newtonsoft.Json /// /// Serializes the specified and writes the JSON structure - /// to a Stream using the specified . + /// to a using the specified . /// /// The used to write the JSON structure. /// The to serialize. /// /// The type of the value being serialized. - /// This parameter is used when is Auto to write out the type name if the type of the value does not match. + /// This parameter is used when is to write out the type name if the type of the value does not match. /// Specifing the type is optional. /// public void Serialize(JsonWriter jsonWriter, object value, Type objectType) diff --git a/Src/Newtonsoft.Json/JsonSerializerSettings.cs b/Src/Newtonsoft.Json/JsonSerializerSettings.cs index 9b3f61d8..1899aea1 100644 --- a/Src/Newtonsoft.Json/JsonSerializerSettings.cs +++ b/Src/Newtonsoft.Json/JsonSerializerSettings.cs @@ -157,9 +157,9 @@ namespace Newtonsoft.Json /// Gets or sets how type name writing and reading is handled by the serializer. /// /// - /// should be used with caution when your application deserializes JSON from an external source. - /// Incoming types should be validated with a custom - /// when deserializing with a value other than TypeNameHandling.None. + /// should be used with caution when your application deserializes JSON from an external source. + /// Incoming types should be validated with a custom + /// when deserializing with a value other than . /// /// The type name handling. public TypeNameHandling TypeNameHandling @@ -374,8 +374,8 @@ namespace Newtonsoft.Json } /// - /// Gets or sets how special floating point numbers, e.g. , - /// and , + /// Gets or sets how special floating point numbers, e.g. , + /// and , /// are written as JSON. /// public FloatFormatHandling FloatFormatHandling diff --git a/Src/Newtonsoft.Json/JsonTextReader.cs b/Src/Newtonsoft.Json/JsonTextReader.cs index 8a05f306..a3609d0d 100644 --- a/Src/Newtonsoft.Json/JsonTextReader.cs +++ b/Src/Newtonsoft.Json/JsonTextReader.cs @@ -75,7 +75,7 @@ namespace Newtonsoft.Json /// /// Initializes a new instance of the class with the specified . /// - /// The TextReader containing the JSON data to read. + /// The containing the JSON data to read. public JsonTextReader(TextReader reader) { if (reader == null) @@ -416,18 +416,18 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public override int? ReadAsInt32() { return (int?)ReadNumberValue(ReadType.ReadAsInt32); } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public override DateTime? ReadAsDateTime() { return (DateTime?)ReadStringValue(ReadType.ReadAsDateTime); @@ -697,9 +697,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public override bool? ReadAsBoolean() { EnsureBuffer(); @@ -945,9 +945,9 @@ namespace Newtonsoft.Json #if !NET20 /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public override DateTimeOffset? ReadAsDateTimeOffset() { return (DateTimeOffset?)ReadStringValue(ReadType.ReadAsDateTimeOffset); @@ -955,18 +955,18 @@ namespace Newtonsoft.Json #endif /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public override decimal? ReadAsDecimal() { return (decimal?)ReadNumberValue(ReadType.ReadAsDecimal); } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public override double? ReadAsDouble() { return (double?)ReadNumberValue(ReadType.ReadAsDouble); @@ -2401,7 +2401,7 @@ namespace Newtonsoft.Json } /// - /// Changes the state to Closed. + /// Changes the reader's state to . /// public override void Close() { @@ -2429,7 +2429,7 @@ 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. /// public bool HasLineInfo() { @@ -2440,7 +2440,7 @@ namespace Newtonsoft.Json /// 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, returns false). /// public int LineNumber { @@ -2459,7 +2459,7 @@ namespace Newtonsoft.Json /// 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, returns false). /// public int LinePosition { diff --git a/Src/Newtonsoft.Json/JsonTextWriter.cs b/Src/Newtonsoft.Json/JsonTextWriter.cs index 82ada632..2abd8186 100644 --- a/Src/Newtonsoft.Json/JsonTextWriter.cs +++ b/Src/Newtonsoft.Json/JsonTextWriter.cs @@ -83,7 +83,7 @@ namespace Newtonsoft.Json } /// - /// Gets or sets how many IndentChars to write for each level in the hierarchy when is set to Formatting.Indented. + /// Gets or sets how many s to write for each level in the hierarchy when is set to . /// public int Indentation { @@ -118,7 +118,7 @@ namespace Newtonsoft.Json } /// - /// Gets or sets which character to use for indenting when is set to Formatting.Indented. + /// Gets or sets which character to use for indenting when is set to . /// public char IndentChar { @@ -143,9 +143,9 @@ namespace Newtonsoft.Json } /// - /// Initializes a new instance of the JsonTextWriter class using the specified . + /// Initializes a new instance of the class using the specified . /// - /// The TextWriter to write to. + /// The to write to. public JsonTextWriter(TextWriter textWriter) { if (textWriter == null) @@ -478,9 +478,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public override void WriteValue(float? value) { if (value == null) @@ -505,9 +505,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public override void WriteValue(double? value) { if (value == null) diff --git a/Src/Newtonsoft.Json/JsonToken.cs b/Src/Newtonsoft.Json/JsonToken.cs index aa93ce28..92632e38 100644 --- a/Src/Newtonsoft.Json/JsonToken.cs +++ b/Src/Newtonsoft.Json/JsonToken.cs @@ -35,7 +35,7 @@ namespace Newtonsoft.Json public enum JsonToken { /// - /// This is returned by the if a method has not been called. + /// This is returned by the if a read method has not been called. /// None = 0, diff --git a/Src/Newtonsoft.Json/JsonValidatingReader.cs b/Src/Newtonsoft.Json/JsonValidatingReader.cs index 26c0db7e..21d54c69 100644 --- a/Src/Newtonsoft.Json/JsonValidatingReader.cs +++ b/Src/Newtonsoft.Json/JsonValidatingReader.cs @@ -392,9 +392,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . + /// A of . public override int? ReadAsInt32() { int? i = _reader.ReadAsInt32(); @@ -418,9 +418,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . + /// A of . public override decimal? ReadAsDecimal() { decimal? d = _reader.ReadAsDecimal(); @@ -430,9 +430,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . + /// A of . public override double? ReadAsDouble() { double? d = _reader.ReadAsDouble(); @@ -442,9 +442,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . + /// A of . public override bool? ReadAsBoolean() { bool? b = _reader.ReadAsBoolean(); @@ -466,9 +466,9 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . This method will return null at the end of an array. + /// A of . This method will return null at the end of an array. public override DateTime? ReadAsDateTime() { DateTime? dateTime = _reader.ReadAsDateTime(); @@ -479,9 +479,9 @@ namespace Newtonsoft.Json #if !NET20 /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the stream as a of . /// - /// A . + /// A of . public override DateTimeOffset? ReadAsDateTimeOffset() { DateTimeOffset? dateTimeOffset = _reader.ReadAsDateTimeOffset(); diff --git a/Src/Newtonsoft.Json/JsonWriter.cs b/Src/Newtonsoft.Json/JsonWriter.cs index 7555e293..c1fda614 100644 --- a/Src/Newtonsoft.Json/JsonWriter.cs +++ b/Src/Newtonsoft.Json/JsonWriter.cs @@ -295,8 +295,8 @@ namespace Newtonsoft.Json } /// - /// Gets or sets how special floating point numbers, e.g. , - /// and , + /// Gets or sets how special floating point numbers, e.g. , + /// and , /// are written to JSON text. /// public FloatFormatHandling FloatFormatHandling @@ -1071,9 +1071,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(int? value) { if (value == null) @@ -1087,9 +1087,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. [CLSCompliant(false)] public virtual void WriteValue(uint? value) { @@ -1104,9 +1104,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(long? value) { if (value == null) @@ -1120,9 +1120,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. [CLSCompliant(false)] public virtual void WriteValue(ulong? value) { @@ -1137,9 +1137,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(float? value) { if (value == null) @@ -1153,9 +1153,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(double? value) { if (value == null) @@ -1169,9 +1169,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(bool? value) { if (value == null) @@ -1185,9 +1185,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(short? value) { if (value == null) @@ -1201,9 +1201,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. [CLSCompliant(false)] public virtual void WriteValue(ushort? value) { @@ -1218,9 +1218,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(char? value) { if (value == null) @@ -1234,9 +1234,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(byte? value) { if (value == null) @@ -1250,9 +1250,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. [CLSCompliant(false)] public virtual void WriteValue(sbyte? value) { @@ -1267,9 +1267,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(decimal? value) { if (value == null) @@ -1283,9 +1283,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(DateTime? value) { if (value == null) @@ -1300,9 +1300,9 @@ namespace Newtonsoft.Json #if !NET20 /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(DateTimeOffset? value) { if (value == null) @@ -1317,9 +1317,9 @@ namespace Newtonsoft.Json #endif /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(Guid? value) { if (value == null) @@ -1333,9 +1333,9 @@ namespace Newtonsoft.Json } /// - /// Writes a value. + /// Writes a of value. /// - /// The value to write. + /// The of value to write. public virtual void WriteValue(TimeSpan? value) { if (value == null) @@ -1608,9 +1608,9 @@ namespace Newtonsoft.Json } /// - /// Sets the state of the JsonWriter. + /// Sets the state of the . /// - /// The JsonToken being written. + /// The being written. /// The value being written. protected void SetWriteState(JsonToken token, object value) { diff --git a/Src/Newtonsoft.Json/JsonWriterException.cs b/Src/Newtonsoft.Json/JsonWriterException.cs index c24169d5..616a3288 100644 --- a/Src/Newtonsoft.Json/JsonWriterException.cs +++ b/Src/Newtonsoft.Json/JsonWriterException.cs @@ -76,10 +76,10 @@ namespace Newtonsoft.Json /// /// Initializes a new instance of the class. /// - /// The that holds the serialized object data about the exception being thrown. - /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The that holds the serialized object data about the exception being thrown. + /// The that contains contextual information about the source or destination. + /// The parameter is null. + /// The class name is null or is zero (0). public JsonWriterException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/Linq/IJEnumerable.cs b/Src/Newtonsoft.Json/Linq/IJEnumerable.cs index fff8c2e6..3f2981c5 100644 --- a/Src/Newtonsoft.Json/Linq/IJEnumerable.cs +++ b/Src/Newtonsoft.Json/Linq/IJEnumerable.cs @@ -30,7 +30,7 @@ namespace Newtonsoft.Json.Linq /// /// Represents a collection of objects. /// - /// The type of token + /// The type of token. public interface IJEnumerable< #if !(NET20 || NET35) out @@ -38,7 +38,7 @@ namespace Newtonsoft.Json.Linq T> : IEnumerable where T : JToken { /// - /// Gets the with the specified key. + /// Gets the of with the specified key. /// /// IJEnumerable this[object key] { get; } diff --git a/Src/Newtonsoft.Json/Linq/JArray.cs b/Src/Newtonsoft.Json/Linq/JArray.cs index e2b8aaea..cdb8b5c1 100644 --- a/Src/Newtonsoft.Json/Linq/JArray.cs +++ b/Src/Newtonsoft.Json/Linq/JArray.cs @@ -290,9 +290,9 @@ namespace Newtonsoft.Json.Linq #region IList Members /// - /// Determines the index of a specific item in the . + /// Determines the index of a specific item in the . /// - /// The object to locate in the . + /// The object to locate in the . /// /// The index of if found in the list; otherwise, -1. /// @@ -302,25 +302,25 @@ namespace Newtonsoft.Json.Linq } /// - /// Inserts an item to the at the specified index. + /// Inserts an item to the at the specified index. /// /// The zero-based index at which should be inserted. - /// The object to insert into the . - /// - /// is not a valid index in the . - /// The is read-only. + /// The object to insert into the . + /// + /// is not a valid index in the . + /// public void Insert(int index, JToken item) { InsertItem(index, item, false); } /// - /// Removes the item at the specified index. + /// Removes the item at the specified index. /// /// The zero-based index of the item to remove. - /// - /// is not a valid index in the . - /// The is read-only. + /// + /// is not a valid index in the . + /// public void RemoveAt(int index) { RemoveItemAt(index); @@ -330,7 +330,7 @@ namespace Newtonsoft.Json.Linq /// Returns an enumerator that iterates through the collection. /// /// - /// A that can be used to iterate through the collection. + /// A of that can be used to iterate through the collection. /// public IEnumerator GetEnumerator() { @@ -340,30 +340,28 @@ namespace Newtonsoft.Json.Linq #region ICollection Members /// - /// Adds an item to the . + /// Adds an item to the . /// - /// The object to add to the . - /// The is read-only. + /// The object to add to the . public void Add(JToken item) { Add((object)item); } /// - /// Removes all items from the . + /// Removes all items from the . /// - /// The is read-only. public void Clear() { ClearItems(); } /// - /// Determines whether the contains a specific value. + /// Determines whether the contains a specific value. /// - /// The object to locate in the . + /// The object to locate in the . /// - /// true if is found in the ; otherwise, false. + /// true if is found in the ; otherwise, false. /// public bool Contains(JToken item) { @@ -371,7 +369,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Copies to. + /// Copies the elements of the to an array, starting at a particular array index. /// /// The array. /// Index of the array. @@ -381,22 +379,21 @@ namespace Newtonsoft.Json.Linq } /// - /// Gets a value indicating whether the is read-only. + /// Gets a value indicating whether the is read-only. /// - /// true if the is read-only; otherwise, false. + /// true if the is read-only; otherwise, false. public bool IsReadOnly { get { return false; } } /// - /// Removes the first occurrence of a specific object from the . + /// Removes the first occurrence of a specific object from the . /// - /// The object to remove from the . + /// The object to remove from the . /// - /// true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + /// true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . /// - /// The is read-only. public bool Remove(JToken item) { return RemoveItem(item); diff --git a/Src/Newtonsoft.Json/Linq/JConstructor.cs b/Src/Newtonsoft.Json/Linq/JConstructor.cs index 83d57f9a..b66004ae 100644 --- a/Src/Newtonsoft.Json/Linq/JConstructor.cs +++ b/Src/Newtonsoft.Json/Linq/JConstructor.cs @@ -208,7 +208,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Loads an from a . + /// Loads a from a . /// /// A that will be read for the content of the . /// A that contains the JSON that was read from the specified . @@ -218,7 +218,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Loads an from a . + /// Loads a from a . /// /// A that will be read for the content of the . /// The used to load the JSON. diff --git a/Src/Newtonsoft.Json/Linq/JContainer.cs b/Src/Newtonsoft.Json/Linq/JContainer.cs index 76b0c04a..fd5d771e 100644 --- a/Src/Newtonsoft.Json/Linq/JContainer.cs +++ b/Src/Newtonsoft.Json/Linq/JContainer.cs @@ -286,7 +286,7 @@ namespace Newtonsoft.Json.Linq /// /// Returns a collection of the descendant tokens for this token in document order. /// - /// An containing the descendant tokens of the . + /// An of containing the descendant tokens of the . public IEnumerable Descendants() { return GetDescendants(false); @@ -295,7 +295,7 @@ namespace Newtonsoft.Json.Linq /// /// Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. /// - /// An containing this token, and all the descendant tokens of the . + /// An of containing this token, and all the descendant tokens of the . public IEnumerable DescendantsAndSelf() { return GetDescendants(true); @@ -1026,7 +1026,7 @@ namespace Newtonsoft.Json.Linq /// /// Gets the count of child JSON tokens. /// - /// The count of child JSON tokens + /// The count of child JSON tokens. public int Count { get { return ChildrenTokens.Count; } diff --git a/Src/Newtonsoft.Json/Linq/JEnumerable.cs b/Src/Newtonsoft.Json/Linq/JEnumerable.cs index 612d4280..a1cb1f7e 100644 --- a/Src/Newtonsoft.Json/Linq/JEnumerable.cs +++ b/Src/Newtonsoft.Json/Linq/JEnumerable.cs @@ -38,7 +38,7 @@ namespace Newtonsoft.Json.Linq /// /// Represents a collection of objects. /// - /// The type of token + /// The type of token. public struct JEnumerable : IJEnumerable, IEquatable> where T : JToken { /// @@ -60,10 +60,10 @@ namespace Newtonsoft.Json.Linq } /// - /// Returns an enumerator that iterates through the collection. + /// Returns an enumerator that can be used to iterate through the collection. /// /// - /// A that can be used to iterate through the collection. + /// A that can be used to iterate through the collection. /// public IEnumerator GetEnumerator() { @@ -75,19 +75,13 @@ namespace Newtonsoft.Json.Linq return _enumerable.GetEnumerator(); } - /// - /// Returns an enumerator that iterates through a collection. - /// - /// - /// An object that can be used to iterate through the collection. - /// IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); } /// - /// Gets the with the specified key. + /// Gets the of with the specified key. /// /// public IJEnumerable this[object key] @@ -116,11 +110,11 @@ namespace Newtonsoft.Json.Linq } /// - /// Determines whether the specified is equal to this instance. + /// Determines whether the specified is equal to this instance. /// - /// The to compare with this instance. + /// The to compare with this instance. /// - /// true if the specified is equal to this instance; otherwise, false. + /// true if the specified is equal to this instance; otherwise, false. /// public override bool Equals(object obj) { diff --git a/Src/Newtonsoft.Json/Linq/JObject.cs b/Src/Newtonsoft.Json/Linq/JObject.cs index 1993ed0f..671f947d 100644 --- a/Src/Newtonsoft.Json/Linq/JObject.cs +++ b/Src/Newtonsoft.Json/Linq/JObject.cs @@ -244,9 +244,9 @@ namespace Newtonsoft.Json.Linq } /// - /// Gets an of this object's properties. + /// Gets an of of this object's properties. /// - /// An of this object's properties. + /// An of of this object's properties. public IEnumerable Properties() { return _properties.Cast(); @@ -270,9 +270,9 @@ namespace Newtonsoft.Json.Linq } /// - /// Gets a of this object's property values. + /// Gets a of of this object's property values. /// - /// A of this object's property values. + /// A of of this object's property values. public JEnumerable PropertyValues() { return new JEnumerable(Properties().Select(p => p.Value)); @@ -311,7 +311,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Gets or sets the with the specified property name. + /// Gets or sets the with the specified property name. /// /// public JToken this[string propertyName] @@ -686,7 +686,7 @@ namespace Newtonsoft.Json.Linq /// Returns an enumerator that can be used to iterate through the collection. /// /// - /// A that can be used to iterate through the collection. + /// A that can be used to iterate through the collection. /// public IEnumerator> GetEnumerator() { @@ -792,11 +792,11 @@ namespace Newtonsoft.Json.Linq #if !(NET35 || NET20 || PORTABLE40) /// - /// Returns the responsible for binding operations performed on this object. + /// Returns the responsible for binding operations performed on this object. /// /// The expression tree representation of the runtime value. /// - /// The to bind this object. + /// The to bind this object. /// protected override DynamicMetaObject GetMetaObject(Expression parameter) { diff --git a/Src/Newtonsoft.Json/Linq/JProperty.cs b/Src/Newtonsoft.Json/Linq/JProperty.cs index bf1c1578..ba4422fc 100644 --- a/Src/Newtonsoft.Json/Linq/JProperty.cs +++ b/Src/Newtonsoft.Json/Linq/JProperty.cs @@ -371,7 +371,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Loads an from a . + /// Loads a from a . /// /// A that will be read for the content of the . /// The used to load the JSON. diff --git a/Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs b/Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs index 07aed646..fa1ebedb 100644 --- a/Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs +++ b/Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs @@ -110,9 +110,9 @@ namespace Newtonsoft.Json.Linq /// When overridden in a derived class, gets the type of the component this property is bound to. /// /// - /// A that represents the type of component this property is bound to. - /// When the or - /// + /// A that represents the type of component this property is bound to. + /// When the or + /// /// methods are invoked, the object specified might be an instance of this type. /// public override Type ComponentType @@ -135,7 +135,7 @@ namespace Newtonsoft.Json.Linq /// When overridden in a derived class, gets the type of the property. /// /// - /// A that represents the type of the property. + /// A that represents the type of the property. /// public override Type PropertyType { diff --git a/Src/Newtonsoft.Json/Linq/JToken.cs b/Src/Newtonsoft.Json/Linq/JToken.cs index 22d07145..54bb8939 100644 --- a/Src/Newtonsoft.Json/Linq/JToken.cs +++ b/Src/Newtonsoft.Json/Linq/JToken.cs @@ -429,7 +429,7 @@ namespace Newtonsoft.Json.Linq /// Returns the JSON for this token using the given formatting and converters. /// /// Indicates how the output should be formatted. - /// A collection of which will be used when writing the token. + /// A collection of s which will be used when writing the token. /// The JSON for this token using the given formatting and converters. public string ToString(Formatting formatting, params JsonConverter[] converters) { @@ -529,7 +529,7 @@ namespace Newtonsoft.Json.Linq #endif /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -557,7 +557,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -580,7 +580,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -609,7 +609,7 @@ namespace Newtonsoft.Json.Linq #if !NET20 /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -643,7 +643,7 @@ namespace Newtonsoft.Json.Linq #endif /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -671,7 +671,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -699,7 +699,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -727,7 +727,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -750,7 +750,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -773,7 +773,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -797,7 +797,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -821,7 +821,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -868,7 +868,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -896,7 +896,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -924,7 +924,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -953,7 +953,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -981,7 +981,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -1010,7 +1010,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -1033,7 +1033,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -1061,7 +1061,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -1089,7 +1089,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1112,7 +1112,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -1141,7 +1141,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -1170,7 +1170,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1193,7 +1193,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1216,7 +1216,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1252,7 +1252,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1300,7 +1300,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to []. + /// Performs an explicit conversion from to []. /// /// The value. /// The result of the conversion. @@ -1337,7 +1337,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1358,7 +1358,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -1389,7 +1389,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1405,7 +1405,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to of . /// /// The value. /// The result of the conversion. @@ -1431,7 +1431,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value. /// The result of the conversion. @@ -1520,7 +1520,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1541,7 +1541,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1552,7 +1552,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1562,7 +1562,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1572,7 +1572,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1583,7 +1583,7 @@ namespace Newtonsoft.Json.Linq #if !NET20 /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1594,7 +1594,7 @@ namespace Newtonsoft.Json.Linq #endif /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1604,7 +1604,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1646,7 +1646,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1666,7 +1666,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1676,7 +1676,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1696,7 +1696,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1707,7 +1707,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1718,7 +1718,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1729,7 +1729,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1792,7 +1792,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from [] to . + /// Performs an implicit conversion from [] to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1802,7 +1802,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1812,7 +1812,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1822,7 +1822,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1832,7 +1832,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1842,7 +1842,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from of to . /// /// The value to create a from. /// The initialized with the specified value. @@ -1897,7 +1897,7 @@ namespace Newtonsoft.Json.Linq /// Creates a from an object. /// /// The object that will be used to create . - /// A with the value of the specified object + /// A with the value of the specified object. public static JToken FromObject(object o) { return FromObjectInternal(o, JsonSerializer.CreateDefault()); @@ -1908,7 +1908,7 @@ namespace Newtonsoft.Json.Linq /// /// The object that will be used to create . /// The that will be used when reading the object. - /// A with the value of the specified object + /// A with the value of the specified object. public static JToken FromObject(object o, JsonSerializer jsonSerializer) { return FromObjectInternal(o, jsonSerializer); @@ -2095,7 +2095,7 @@ namespace Newtonsoft.Json.Linq /// The used to load the JSON. /// If this is null, default load settings will be used. /// - /// An that contains the token and its descendant tokens + /// A that contains the token and its descendant tokens /// that were read from the reader. The runtime type of the token is determined /// by the token type of the first token encountered in the reader. /// @@ -2324,7 +2324,7 @@ namespace Newtonsoft.Json.Linq /// /// A that contains a JPath expression. /// - /// An that contains the selected elements. + /// An of that contains the selected elements. public IEnumerable SelectTokens(string path) { return SelectTokens(path, false); @@ -2337,7 +2337,7 @@ namespace Newtonsoft.Json.Linq /// A that contains a JPath expression. /// /// A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - /// An that contains the selected elements. + /// An of that contains the selected elements. public IEnumerable SelectTokens(string path, bool errorWhenNoMatch) { JPath p = new JPath(path); @@ -2346,11 +2346,11 @@ namespace Newtonsoft.Json.Linq #if !(NET35 || NET20 || PORTABLE40) /// - /// Returns the responsible for binding operations performed on this object. + /// Returns the responsible for binding operations performed on this object. /// /// The expression tree representation of the runtime value. /// - /// The to bind this object. + /// The to bind this object. /// protected virtual DynamicMetaObject GetMetaObject(Expression parameter) { @@ -2358,11 +2358,11 @@ namespace Newtonsoft.Json.Linq } /// - /// Returns the responsible for binding operations performed on this object. + /// Returns the responsible for binding operations performed on this object. /// /// The expression tree representation of the runtime value. /// - /// The to bind this object. + /// The to bind this object. /// DynamicMetaObject IDynamicMetaObjectProvider.GetMetaObject(Expression parameter) { diff --git a/Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs b/Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs index 1c9dd536..2930896d 100644 --- a/Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs +++ b/Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs @@ -48,9 +48,9 @@ namespace Newtonsoft.Json.Linq /// /// Returns a hash code for the specified object. /// - /// The for which a hash code is to be returned. + /// The for which a hash code is to be returned. /// A hash code for the specified object. - /// The type of is a reference type and is null. + /// The type of is a reference type and is null. public int GetHashCode(JToken obj) { if (obj == null) diff --git a/Src/Newtonsoft.Json/Linq/JTokenWriter.cs b/Src/Newtonsoft.Json/Linq/JTokenWriter.cs index 0d92e480..3c76cbfc 100644 --- a/Src/Newtonsoft.Json/Linq/JTokenWriter.cs +++ b/Src/Newtonsoft.Json/Linq/JTokenWriter.cs @@ -216,7 +216,7 @@ namespace Newtonsoft.Json.Linq #region WriteValue methods /// /// Writes a value. - /// An error will raised if the value cannot be written as a single JSON token. + /// An error will be raised if the value cannot be written as a single JSON token. /// /// The value to write. public override void WriteValue(object value) diff --git a/Src/Newtonsoft.Json/Linq/JValue.cs b/Src/Newtonsoft.Json/Linq/JValue.cs index 43ea4519..b41a1abc 100644 --- a/Src/Newtonsoft.Json/Linq/JValue.cs +++ b/Src/Newtonsoft.Json/Linq/JValue.cs @@ -728,7 +728,7 @@ namespace Newtonsoft.Json.Linq /// Writes this token to a . /// /// A into which this method will write. - /// A collection of which will be used when writing the token. + /// A collection of s which will be used when writing the token. public override void WriteTo(JsonWriter writer, params JsonConverter[] converters) { if (converters != null && converters.Length > 0 && _value != null) @@ -863,11 +863,11 @@ namespace Newtonsoft.Json.Linq } /// - /// Determines whether the specified is equal to the current . + /// Determines whether the specified is equal to the current . /// - /// The to compare with the current . + /// The to compare with the current . /// - /// true if the specified is equal to the current ; otherwise, false. + /// true if the specified is equal to the current ; otherwise, false. /// public override bool Equals(object obj) { @@ -889,7 +889,7 @@ namespace Newtonsoft.Json.Linq /// Serves as a hash function for a particular type. /// /// - /// A hash code for the current . + /// A hash code for the current . /// public override int GetHashCode() { @@ -902,10 +902,10 @@ namespace Newtonsoft.Json.Linq } /// - /// Returns a that represents this instance. + /// Returns a that represents this instance. /// /// - /// A that represents this instance. + /// A that represents this instance. /// public override string ToString() { @@ -918,11 +918,11 @@ namespace Newtonsoft.Json.Linq } /// - /// Returns a that represents this instance. + /// Returns a that represents this instance. /// /// The format. /// - /// A that represents this instance. + /// A that represents this instance. /// public string ToString(string format) { @@ -930,11 +930,11 @@ namespace Newtonsoft.Json.Linq } /// - /// Returns a that represents this instance. + /// Returns a that represents this instance. /// /// The format provider. /// - /// A that represents this instance. + /// A that represents this instance. /// public string ToString(IFormatProvider formatProvider) { @@ -942,12 +942,12 @@ namespace Newtonsoft.Json.Linq } /// - /// Returns a that represents this instance. + /// Returns a that represents this instance. /// /// The format. /// The format provider. /// - /// A that represents this instance. + /// A that represents this instance. /// public string ToString(string format, IFormatProvider formatProvider) { @@ -969,11 +969,11 @@ namespace Newtonsoft.Json.Linq #if !(NET35 || NET20 || PORTABLE40) /// - /// Returns the responsible for binding operations performed on this object. + /// Returns the responsible for binding operations performed on this object. /// /// The expression tree representation of the runtime value. /// - /// The to bind this object. + /// The to bind this object. /// protected override DynamicMetaObject GetMetaObject(Expression parameter) { @@ -1075,7 +1075,7 @@ namespace Newtonsoft.Json.Linq /// Greater than zero /// This instance is greater than . /// - /// + /// /// is not of the same type as this instance. /// public int CompareTo(JValue obj) diff --git a/Src/Newtonsoft.Json/PreserveReferencesHandling.cs b/Src/Newtonsoft.Json/PreserveReferencesHandling.cs index 1c9dd387..bb6f7ae8 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 . /// /// /// diff --git a/Src/Newtonsoft.Json/Schema/JsonSchema.cs b/Src/Newtonsoft.Json/Schema/JsonSchema.cs index 68b45dd1..db2dbfa5 100644 --- a/Src/Newtonsoft.Json/Schema/JsonSchema.cs +++ b/Src/Newtonsoft.Json/Schema/JsonSchema.cs @@ -121,15 +121,15 @@ namespace Newtonsoft.Json.Schema public double? Maximum { get; set; } /// - /// Gets or sets a flag indicating whether the value can not equal the number defined by the "minimum" attribute. + /// Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). /// - /// A flag indicating whether the value can not equal the number defined by the "minimum" attribute. + /// A flag indicating whether the value can not equal the number defined by the minimum attribute (). public bool? ExclusiveMinimum { get; set; } /// - /// Gets or sets a flag indicating whether the value can not equal the number defined by the "maximum" attribute. + /// Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). /// - /// A flag indicating whether the value can not equal the number defined by the "maximum" attribute. + /// A flag indicating whether the value can not equal the number defined by the maximum attribute (). public bool? ExclusiveMaximum { get; set; } /// @@ -218,7 +218,7 @@ namespace Newtonsoft.Json.Schema /// /// Gets or sets disallowed types. /// - /// The disallow types. + /// The disallowed types. public JsonSchemaType? Disallow { get; set; } /// @@ -337,10 +337,10 @@ namespace Newtonsoft.Json.Schema } /// - /// Returns a that represents the current . + /// Returns a that represents the current . /// /// - /// A that represents the current . + /// A that represents the current . /// public override string ToString() { diff --git a/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs b/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs index a674e704..195edec7 100644 --- a/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs +++ b/Src/Newtonsoft.Json/Schema/JsonSchemaException.cs @@ -92,10 +92,10 @@ namespace Newtonsoft.Json.Schema /// /// Initializes a new instance of the class. /// - /// The that holds the serialized object data about the exception being thrown. - /// The that contains contextual information about the source or destination. - /// The parameter is null. - /// The class name is null or is zero (0). + /// The that holds the serialized object data about the exception being thrown. + /// The that contains contextual information about the source or destination. + /// The parameter is null. + /// The class name is null or is zero (0). public JsonSchemaException(SerializationInfo info, StreamingContext context) : base(info, context) { diff --git a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs index 9ec84b23..11719554 100644 --- a/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs +++ b/Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs @@ -1510,7 +1510,7 @@ namespace Newtonsoft.Json.Serialization } // resolve converter for property - // the class type might have a converter but the property converter takes presidence + // the class type might have a converter but the property converter takes precedence property.Converter = JsonTypeReflector.GetJsonConverter(attributeProvider); property.MemberConverter = JsonTypeReflector.GetJsonConverter(attributeProvider); diff --git a/Src/Newtonsoft.Json/Serialization/DefaultSerializationBinder.cs b/Src/Newtonsoft.Json/Serialization/DefaultSerializationBinder.cs index 6d84e7d5..66f10807 100644 --- a/Src/Newtonsoft.Json/Serialization/DefaultSerializationBinder.cs +++ b/Src/Newtonsoft.Json/Serialization/DefaultSerializationBinder.cs @@ -177,8 +177,8 @@ namespace Newtonsoft.Json.Serialization /// /// When overridden in a derived class, controls the binding of a serialized object to a type. /// - /// Specifies the name of the serialized object. - /// Specifies the name of the serialized object. + /// Specifies the name of the serialized object. + /// Specifies the name of the serialized object. /// /// The type of the object the formatter creates a new instance of. /// @@ -191,8 +191,8 @@ namespace Newtonsoft.Json.Serialization /// When overridden in a derived class, controls the binding of a serialized object to a type. /// /// The type of the object the formatter creates a new instance of. - /// Specifies the name of the serialized object. - /// Specifies the name of the serialized object. + /// Specifies the name of the serialized object. + /// Specifies the name of the serialized object. public #if !(NET35 || NET20) override diff --git a/Src/Newtonsoft.Json/Serialization/DiagnosticsTraceWriter.cs b/Src/Newtonsoft.Json/Serialization/DiagnosticsTraceWriter.cs index b0293387..d3e0c15a 100644 --- a/Src/Newtonsoft.Json/Serialization/DiagnosticsTraceWriter.cs +++ b/Src/Newtonsoft.Json/Serialization/DiagnosticsTraceWriter.cs @@ -12,8 +12,8 @@ namespace Newtonsoft.Json.Serialization { /// /// Gets the that will be used to filter the trace messages passed to the writer. - /// For example a filter level of Info will exclude Verbose messages and include Info, - /// Warning and Error messages. + /// For example a filter level of will exclude messages and include , + /// and messages. /// /// /// The that will be used to filter the trace messages passed to the writer. diff --git a/Src/Newtonsoft.Json/Serialization/IContractResolver.cs b/Src/Newtonsoft.Json/Serialization/IContractResolver.cs index 10f44bad..49a8ee8f 100644 --- a/Src/Newtonsoft.Json/Serialization/IContractResolver.cs +++ b/Src/Newtonsoft.Json/Serialization/IContractResolver.cs @@ -28,7 +28,7 @@ using System; namespace Newtonsoft.Json.Serialization { /// - /// Used by to resolves a for a given . + /// Used by to resolve a for a given . /// /// /// diff --git a/Src/Newtonsoft.Json/Serialization/IReferenceResolver.cs b/Src/Newtonsoft.Json/Serialization/IReferenceResolver.cs index 271e3072..89d3446b 100644 --- a/Src/Newtonsoft.Json/Serialization/IReferenceResolver.cs +++ b/Src/Newtonsoft.Json/Serialization/IReferenceResolver.cs @@ -35,7 +35,7 @@ namespace Newtonsoft.Json.Serialization /// /// The serialization context. /// The reference to resolve. - /// The object that + /// The object that was resolved from the reference. object ResolveReference(object context, string reference); /// diff --git a/Src/Newtonsoft.Json/Serialization/ITraceWriter.cs b/Src/Newtonsoft.Json/Serialization/ITraceWriter.cs index 46ed7845..ac0b166e 100644 --- a/Src/Newtonsoft.Json/Serialization/ITraceWriter.cs +++ b/Src/Newtonsoft.Json/Serialization/ITraceWriter.cs @@ -11,8 +11,8 @@ namespace Newtonsoft.Json.Serialization { /// /// Gets the that will be used to filter the trace messages passed to the writer. - /// For example a filter level of Info will exclude Verbose messages and include Info, - /// Warning and Error messages. + /// For example a filter level of will exclude messages and include , + /// and messages. /// /// The that will be used to filter the trace messages passed to the writer. TraceLevel LevelFilter { get; } diff --git a/Src/Newtonsoft.Json/Serialization/JsonISerializableContract.cs b/Src/Newtonsoft.Json/Serialization/JsonISerializableContract.cs index 0e8dc09c..b213b9d9 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonISerializableContract.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonISerializableContract.cs @@ -35,9 +35,9 @@ namespace Newtonsoft.Json.Serialization public class JsonISerializableContract : JsonContainerContract { /// - /// Gets or sets the ISerializable object constructor. + /// Gets or sets the object constructor. /// - /// The ISerializable object constructor. + /// The object constructor. public ObjectConstructor ISerializableCreator { get; set; } /// diff --git a/Src/Newtonsoft.Json/Serialization/JsonObjectContract.cs b/Src/Newtonsoft.Json/Serialization/JsonObjectContract.cs index ff81d12d..ce03b2bd 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonObjectContract.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonObjectContract.cs @@ -59,7 +59,7 @@ namespace Newtonsoft.Json.Serialization public JsonPropertyCollection Properties { get; private set; } /// - /// Gets the constructor parameters required for any non-default constructor + /// Gets the constructor parameters required for any non-default constructor. /// [Obsolete("ConstructorParameters is obsolete. Use CreatorParameters instead.")] public JsonPropertyCollection ConstructorParameters @@ -68,7 +68,7 @@ namespace Newtonsoft.Json.Serialization } /// - /// Gets a collection of instances that define the parameters used with . + /// Gets a collection of instances that define the parameters used with . /// public JsonPropertyCollection CreatorParameters { @@ -85,8 +85,8 @@ namespace Newtonsoft.Json.Serialization /// /// Gets or sets the override constructor used to create the object. - /// This is set when a constructor is marked up using the - /// JsonConstructor attribute. + /// This is set when a constructor is marked up using + /// . /// /// The override constructor. [Obsolete("OverrideConstructor is obsolete. Use OverrideCreator instead.")] @@ -117,7 +117,7 @@ namespace Newtonsoft.Json.Serialization /// /// Gets or sets the function used to create the object. When set this function will override . - /// This function is called with a collection of arguments which are defined by the collection. + /// This function is called with a collection of arguments which are defined by the collection. /// /// The function used to create the object. public ObjectConstructor OverrideCreator diff --git a/Src/Newtonsoft.Json/Serialization/JsonProperty.cs b/Src/Newtonsoft.Json/Serialization/JsonProperty.cs index 720830a4..a03c10e4 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonProperty.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonProperty.cs @@ -113,7 +113,7 @@ namespace Newtonsoft.Json.Serialization /// /// Gets or sets the for the property. - /// If set this converter takes presidence over the contract converter for the property type. + /// If set this converter takes precedence over the contract converter for the property type. /// /// The converter. public JsonConverter Converter { get; set; } diff --git a/Src/Newtonsoft.Json/Serialization/JsonPropertyCollection.cs b/Src/Newtonsoft.Json/Serialization/JsonPropertyCollection.cs index 3da25180..996bf64d 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonPropertyCollection.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonPropertyCollection.cs @@ -118,7 +118,7 @@ namespace Newtonsoft.Json.Serialization /// /// Gets the closest matching object. - /// First attempts to get an exact case match of propertyName and then + /// First attempts to get an exact case match of and then /// a case insensitive match. /// /// Name of the property. diff --git a/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs b/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs index 2d3f8b1b..3474f17b 100644 --- a/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs +++ b/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs @@ -173,9 +173,9 @@ namespace Newtonsoft.Json.Serialization } /// - /// Lookup and create an instance of the JsonConverter type described by the argument. + /// Lookup and create an instance of the type described by the argument. /// - /// The JsonConverter type to create. + /// The type to create. /// Optional arguments to pass to an initializing constructor of the JsonConverter. /// If null, the default constructor is used. public static JsonConverter CreateJsonConverterInstance(Type converterType, object[] converterArgs) diff --git a/Src/Newtonsoft.Json/Serialization/MemoryTraceWriter.cs b/Src/Newtonsoft.Json/Serialization/MemoryTraceWriter.cs index 7581216b..511befed 100644 --- a/Src/Newtonsoft.Json/Serialization/MemoryTraceWriter.cs +++ b/Src/Newtonsoft.Json/Serialization/MemoryTraceWriter.cs @@ -16,8 +16,8 @@ namespace Newtonsoft.Json.Serialization /// /// Gets the that will be used to filter the trace messages passed to the writer. - /// For example a filter level of Info will exclude Verbose messages and include Info, - /// Warning and Error messages. + /// For example a filter level of will exclude messages and include , + /// and messages. /// /// /// The that will be used to filter the trace messages passed to the writer. diff --git a/Src/Newtonsoft.Json/Serialization/NamingStrategy.cs b/Src/Newtonsoft.Json/Serialization/NamingStrategy.cs index cf957af3..a9e51e7b 100644 --- a/Src/Newtonsoft.Json/Serialization/NamingStrategy.cs +++ b/Src/Newtonsoft.Json/Serialization/NamingStrategy.cs @@ -22,7 +22,7 @@ /// Gets the serialized name for a given property name. /// /// The initial property name. - /// A flag indicating whether the property has had a name explicitly specfied. + /// A flag indicating whether the property has had a name explicitly specified. /// The serialized property name. public virtual string GetPropertyName(string name, bool hasSpecifiedName) { diff --git a/Src/Newtonsoft.Json/TypeNameAssemblyFormatHandling.cs b/Src/Newtonsoft.Json/TypeNameAssemblyFormatHandling.cs index 572c1ffc..7e24b145 100644 --- a/Src/Newtonsoft.Json/TypeNameAssemblyFormatHandling.cs +++ b/Src/Newtonsoft.Json/TypeNameAssemblyFormatHandling.cs @@ -31,12 +31,12 @@ 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 method is used to load the assembly. /// Simple = 0, /// - /// In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the Assembly class is used to load the assembly. + /// In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. /// Full = 1 } diff --git a/Src/Newtonsoft.Json/TypeNameHandling.cs b/Src/Newtonsoft.Json/TypeNameHandling.cs index 93f1daa0..2357299e 100644 --- a/Src/Newtonsoft.Json/TypeNameHandling.cs +++ b/Src/Newtonsoft.Json/TypeNameHandling.cs @@ -32,9 +32,9 @@ namespace Newtonsoft.Json /// Specifies type name handling options for the . /// /// - /// should be used with caution when your application deserializes JSON from an external source. - /// Incoming types should be validated with a custom - /// when deserializing with a value other than TypeNameHandling.None. + /// should be used with caution when your application deserializes JSON from an external source. + /// Incoming types should be validated with a custom + /// when deserializing with a value other than . /// [Flags] public enum TypeNameHandling @@ -62,8 +62,8 @@ namespace Newtonsoft.Json /// /// Include the .NET type name when the type of the object being serialized is not the same as its declared type. /// Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - /// you must specify a root type object with - /// or . + /// you must specify a root type object with + /// or . /// Auto = 4 } diff --git a/Src/Newtonsoft.Json/Utilities/CollectionUtils.cs b/Src/Newtonsoft.Json/Utilities/CollectionUtils.cs index 8aae3058..9381251c 100644 --- a/Src/Newtonsoft.Json/Utilities/CollectionUtils.cs +++ b/Src/Newtonsoft.Json/Utilities/CollectionUtils.cs @@ -58,7 +58,7 @@ namespace Newtonsoft.Json.Utilities } /// - /// Adds the elements of the specified collection to the specified generic IList. + /// Adds the elements of the specified collection to the specified generic . /// /// The list to add to. /// The collection of elements to add. diff --git a/Src/Newtonsoft.Json/Utilities/EnumUtils.cs b/Src/Newtonsoft.Json/Utilities/EnumUtils.cs index 250f6ab4..5f24b3df 100644 --- a/Src/Newtonsoft.Json/Utilities/EnumUtils.cs +++ b/Src/Newtonsoft.Json/Utilities/EnumUtils.cs @@ -104,7 +104,7 @@ namespace Newtonsoft.Json.Utilities } /// - /// Gets a dictionary of the names and values of an Enum type. + /// Gets a dictionary of the names and values of an type. /// /// public static IList> GetNamesAndValues() where T : struct diff --git a/Src/Newtonsoft.Json/Utilities/MethodBinder.cs b/Src/Newtonsoft.Json/Utilities/MethodBinder.cs index cff02ad0..673ab179 100644 --- a/Src/Newtonsoft.Json/Utilities/MethodBinder.cs +++ b/Src/Newtonsoft.Json/Utilities/MethodBinder.cs @@ -79,7 +79,7 @@ /// /// Method parameters. /// Argument types. - /// Try to pack extra arguments into ParamArray. + /// Try to pack extra arguments into the last parameter when it is marked up with . /// true if method can be called with given arguments, false otherwise. private static bool FilterParameters(ParameterInfo[] parameters, IList types, bool enableParamArray) { diff --git a/Src/Newtonsoft.Json/Utilities/StringBuffer.cs b/Src/Newtonsoft.Json/Utilities/StringBuffer.cs index ec6818e8..520da4f1 100644 --- a/Src/Newtonsoft.Json/Utilities/StringBuffer.cs +++ b/Src/Newtonsoft.Json/Utilities/StringBuffer.cs @@ -28,7 +28,7 @@ using System; namespace Newtonsoft.Json.Utilities { /// - /// Builds a string. Unlike StringBuilder this class lets you reuse it's internal buffer. + /// Builds a string. Unlike this class lets you reuse its internal buffer. /// internal struct StringBuffer { diff --git a/Src/Newtonsoft.Json/WriteState.cs b/Src/Newtonsoft.Json/WriteState.cs index 09ab8b4e..99fd7f42 100644 --- a/Src/Newtonsoft.Json/WriteState.cs +++ b/Src/Newtonsoft.Json/WriteState.cs @@ -34,13 +34,13 @@ 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. + /// You may call the method to put the in the state. /// Any other method calls result in an being thrown. /// Error = 0, /// - /// The method has been called. + /// The method has been called. /// Closed = 1, @@ -50,7 +50,7 @@ namespace Newtonsoft.Json Object = 2, /// - /// A array is being written. + /// An array is being written. /// Array = 3, @@ -65,7 +65,7 @@ namespace Newtonsoft.Json Property = 5, /// - /// A write method has not been called. + /// A write method has not been called. /// Start = 6 } From 1eb391c14700fa0b485818a6f26278b1041b192f Mon Sep 17 00:00:00 2001 From: stakx Date: Sat, 24 Dec 2016 01:01:15 +0100 Subject: [PATCH 4/4] 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. --- Src/Newtonsoft.Json/Bson/BsonReader.cs | 11 ++++----- Src/Newtonsoft.Json/Bson/BsonWriter.cs | 9 ++++---- Src/Newtonsoft.Json/JsonReader.cs | 25 ++++++++++----------- Src/Newtonsoft.Json/JsonSerializer.cs | 8 +++---- Src/Newtonsoft.Json/JsonTextReader.cs | 19 ++++++++-------- Src/Newtonsoft.Json/JsonTextWriter.cs | 5 +++-- Src/Newtonsoft.Json/JsonValidatingReader.cs | 18 +++++++-------- Src/Newtonsoft.Json/JsonWriter.cs | 11 +++++---- Src/Newtonsoft.Json/Linq/JTokenReader.cs | 2 +- Src/Newtonsoft.Json/Linq/JTokenWriter.cs | 11 +++++---- 10 files changed, 62 insertions(+), 57 deletions(-) diff --git a/Src/Newtonsoft.Json/Bson/BsonReader.cs b/Src/Newtonsoft.Json/Bson/BsonReader.cs index 69281fce..bb36ff8b 100644 --- a/Src/Newtonsoft.Json/Bson/BsonReader.cs +++ b/Src/Newtonsoft.Json/Bson/BsonReader.cs @@ -122,7 +122,7 @@ namespace Newtonsoft.Json.Bson /// /// Initializes a new instance of the class. /// - /// The stream. + /// The containing the BSON data to read. public BsonReader(Stream stream) : this(stream, false, DateTimeKind.Local) { @@ -131,7 +131,7 @@ namespace Newtonsoft.Json.Bson /// /// Initializes a new instance of the class. /// - /// The reader. + /// The containing the BSON data to read. public BsonReader(BinaryReader reader) : this(reader, false, DateTimeKind.Local) { @@ -140,7 +140,7 @@ namespace Newtonsoft.Json.Bson /// /// Initializes a new instance of the class. /// - /// The stream. + /// The containing the BSON data to read. /// if set to true the root object will be read as a JSON array. /// The used when reading values from BSON. public BsonReader(Stream stream, bool readRootValueAsArray, DateTimeKind dateTimeKindHandling) @@ -155,7 +155,7 @@ namespace Newtonsoft.Json.Bson /// /// Initializes a new instance of the class. /// - /// The reader. + /// The containing the BSON data to read. /// if set to true the root object will be read as a JSON array. /// The used when reading values from BSON. public BsonReader(BinaryReader reader, bool readRootValueAsArray, DateTimeKind dateTimeKindHandling) @@ -175,7 +175,7 @@ namespace Newtonsoft.Json.Bson } /// - /// Reads the next JSON token from the stream. + /// Reads the next JSON token from the underlying . /// /// /// true if the next token was read successfully; false if there are no more tokens to read. @@ -224,6 +224,7 @@ namespace Newtonsoft.Json.Bson /// /// Changes the reader's state to . + /// If is set to true, the underlying is also closed. /// public override void Close() { diff --git a/Src/Newtonsoft.Json/Bson/BsonWriter.cs b/Src/Newtonsoft.Json/Bson/BsonWriter.cs index f46b67c3..71bd038a 100644 --- a/Src/Newtonsoft.Json/Bson/BsonWriter.cs +++ b/Src/Newtonsoft.Json/Bson/BsonWriter.cs @@ -62,7 +62,7 @@ namespace Newtonsoft.Json.Bson /// /// Initializes a new instance of the class. /// - /// The stream. + /// The to write to. public BsonWriter(Stream stream) { ValidationUtils.ArgumentNotNull(stream, nameof(stream)); @@ -72,7 +72,7 @@ namespace Newtonsoft.Json.Bson /// /// Initializes a new instance of the class. /// - /// The writer. + /// The to write to. public BsonWriter(BinaryWriter writer) { ValidationUtils.ArgumentNotNull(writer, nameof(writer)); @@ -80,7 +80,7 @@ namespace Newtonsoft.Json.Bson } /// - /// Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + /// Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. /// public override void Flush() { @@ -170,7 +170,8 @@ namespace Newtonsoft.Json.Bson } /// - /// Closes this stream and the underlying stream. + /// Closes this writer. + /// If is set to true, the underlying is also closed. /// public override void Close() { diff --git a/Src/Newtonsoft.Json/JsonReader.cs b/Src/Newtonsoft.Json/JsonReader.cs index 1c6e6b1b..b3244b3d 100644 --- a/Src/Newtonsoft.Json/JsonReader.cs +++ b/Src/Newtonsoft.Json/JsonReader.cs @@ -141,12 +141,10 @@ namespace Newtonsoft.Json } /// - /// Gets or sets a value indicating whether the underlying stream or - /// should be closed when the reader is closed. + /// Gets or sets a value indicating whether the source should be closed when this 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 source when this reader is closed; otherwise false. The default is true. /// public bool CloseInput { get; set; } @@ -406,13 +404,13 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream. + /// Reads the next JSON token from the source. /// /// true if the next token was read successfully; false if there are no more tokens to read. public abstract bool Read(); /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the source as a of . /// /// A of . This method will return null at the end of an array. public virtual int? ReadAsInt32() @@ -463,7 +461,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the source as a . /// /// A . This method will return null at the end of an array. public virtual string ReadAsString() @@ -507,7 +505,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a []. + /// Reads the next JSON token from the source as a []. /// /// A [] or null if the next JSON token is null. This method will return null at the end of an array. public virtual byte[] ReadAsBytes() @@ -606,7 +604,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the source as a of . /// /// A of . This method will return null at the end of an array. public virtual double? ReadAsDouble() @@ -668,7 +666,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the source as a of . /// /// A of . This method will return null at the end of an array. public virtual bool? ReadAsBoolean() @@ -729,7 +727,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the source as a of . /// /// A of . This method will return null at the end of an array. public virtual decimal? ReadAsDecimal() @@ -779,7 +777,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the source as a of . /// /// A of . This method will return null at the end of an array. public virtual DateTime? ReadAsDateTime() @@ -835,7 +833,7 @@ namespace Newtonsoft.Json #if !NET20 /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the source as a of . /// /// A of . This method will return null at the end of an array. public virtual DateTimeOffset? ReadAsDateTimeOffset() @@ -1124,6 +1122,7 @@ namespace Newtonsoft.Json /// /// Changes the reader's state to . + /// If is set to true, the source is also closed. /// public virtual void Close() { diff --git a/Src/Newtonsoft.Json/JsonSerializer.cs b/Src/Newtonsoft.Json/JsonSerializer.cs index 108a9f6c..fae8697a 100644 --- a/Src/Newtonsoft.Json/JsonSerializer.cs +++ b/Src/Newtonsoft.Json/JsonSerializer.cs @@ -994,7 +994,7 @@ namespace Newtonsoft.Json /// /// Serializes the specified and writes the JSON structure - /// to a using the specified . + /// using the specified . /// /// The used to write the JSON structure. /// The to serialize. @@ -1005,7 +1005,7 @@ namespace Newtonsoft.Json /// /// Serializes the specified and writes the JSON structure - /// to a using the specified . + /// using the specified . /// /// The used to write the JSON structure. /// The to serialize. @@ -1021,7 +1021,7 @@ namespace Newtonsoft.Json /// /// Serializes the specified and writes the JSON structure - /// to a Stream using the specified . + /// using the specified . /// /// The used to write the JSON structure. /// The to serialize. @@ -1037,7 +1037,7 @@ namespace Newtonsoft.Json /// /// Serializes the specified and writes the JSON structure - /// to a Stream using the specified . + /// using the specified . /// /// The used to write the JSON structure. /// The to serialize. diff --git a/Src/Newtonsoft.Json/JsonTextReader.cs b/Src/Newtonsoft.Json/JsonTextReader.cs index a3609d0d..b2bcbdc9 100644 --- a/Src/Newtonsoft.Json/JsonTextReader.cs +++ b/Src/Newtonsoft.Json/JsonTextReader.cs @@ -359,7 +359,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream. + /// Reads the next JSON token from the underlying . /// /// /// true if the next token was read successfully; false if there are no more tokens to read. @@ -416,7 +416,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . This method will return null at the end of an array. public override int? ReadAsInt32() @@ -425,7 +425,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . This method will return null at the end of an array. public override DateTime? ReadAsDateTime() @@ -434,7 +434,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the underlying as a . /// /// A . This method will return null at the end of an array. public override string ReadAsString() @@ -443,7 +443,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a []. + /// Reads the next JSON token from the underlying as a []. /// /// A [] or null if the next JSON token is null. This method will return null at the end of an array. public override byte[] ReadAsBytes() @@ -697,7 +697,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . This method will return null at the end of an array. public override bool? ReadAsBoolean() @@ -945,7 +945,7 @@ namespace Newtonsoft.Json #if !NET20 /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . This method will return null at the end of an array. public override DateTimeOffset? ReadAsDateTimeOffset() @@ -955,7 +955,7 @@ namespace Newtonsoft.Json #endif /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . This method will return null at the end of an array. public override decimal? ReadAsDecimal() @@ -964,7 +964,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . This method will return null at the end of an array. public override double? ReadAsDouble() @@ -2402,6 +2402,7 @@ namespace Newtonsoft.Json /// /// Changes the reader's state to . + /// If is set to true, the underlying is also closed. /// public override void Close() { diff --git a/Src/Newtonsoft.Json/JsonTextWriter.cs b/Src/Newtonsoft.Json/JsonTextWriter.cs index 2abd8186..304609d1 100644 --- a/Src/Newtonsoft.Json/JsonTextWriter.cs +++ b/Src/Newtonsoft.Json/JsonTextWriter.cs @@ -163,7 +163,7 @@ namespace Newtonsoft.Json } /// - /// Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + /// Flushes whatever is in the buffer to the underlying and also flushes the underlying . /// public override void Flush() { @@ -171,7 +171,8 @@ namespace Newtonsoft.Json } /// - /// Closes this stream and the underlying stream. + /// Closes this writer. + /// If is set to true, the underlying is also closed. /// public override void Close() { diff --git a/Src/Newtonsoft.Json/JsonValidatingReader.cs b/Src/Newtonsoft.Json/JsonValidatingReader.cs index 21d54c69..d2e5b862 100644 --- a/Src/Newtonsoft.Json/JsonValidatingReader.cs +++ b/Src/Newtonsoft.Json/JsonValidatingReader.cs @@ -392,7 +392,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . public override int? ReadAsInt32() @@ -404,7 +404,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a []. + /// Reads the next JSON token from the underlying as a []. /// /// /// A [] or null if the next JSON token is null. @@ -418,7 +418,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . public override decimal? ReadAsDecimal() @@ -430,7 +430,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . public override double? ReadAsDouble() @@ -442,7 +442,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . public override bool? ReadAsBoolean() @@ -454,7 +454,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a . + /// Reads the next JSON token from the underlying as a . /// /// A . This method will return null at the end of an array. public override string ReadAsString() @@ -466,7 +466,7 @@ namespace Newtonsoft.Json } /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . This method will return null at the end of an array. public override DateTime? ReadAsDateTime() @@ -479,7 +479,7 @@ namespace Newtonsoft.Json #if !NET20 /// - /// Reads the next JSON token from the stream as a of . + /// Reads the next JSON token from the underlying as a of . /// /// A of . public override DateTimeOffset? ReadAsDateTimeOffset() @@ -492,7 +492,7 @@ namespace Newtonsoft.Json #endif /// - /// Reads the next JSON token from the stream. + /// Reads the next JSON token from the underlying . /// /// /// true if the next token was read successfully; false if there are no more tokens to read. diff --git a/Src/Newtonsoft.Json/JsonWriter.cs b/Src/Newtonsoft.Json/JsonWriter.cs index c1fda614..e0c16fa9 100644 --- a/Src/Newtonsoft.Json/JsonWriter.cs +++ b/Src/Newtonsoft.Json/JsonWriter.cs @@ -119,12 +119,10 @@ namespace Newtonsoft.Json private Formatting _formatting; /// - /// Gets or sets a value indicating whether the underlying stream or - /// should be closed when the writer is closed. + /// Gets or sets a value indicating whether the destination should be closed when this 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 destination when this writer is closed; otherwise false. The default is true. /// public bool CloseOutput { get; set; } @@ -389,12 +387,13 @@ namespace Newtonsoft.Json } /// - /// Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + /// Flushes whatever is in the buffer to the destination and also flushes the destination. /// public abstract void Flush(); /// - /// Closes this stream and the underlying stream. + /// Closes this writer. + /// If is set to true, the destination is also closed. /// public virtual void Close() { diff --git a/Src/Newtonsoft.Json/Linq/JTokenReader.cs b/Src/Newtonsoft.Json/Linq/JTokenReader.cs index 0f5c98dc..20ea19f8 100644 --- a/Src/Newtonsoft.Json/Linq/JTokenReader.cs +++ b/Src/Newtonsoft.Json/Linq/JTokenReader.cs @@ -65,7 +65,7 @@ namespace Newtonsoft.Json.Linq } /// - /// Reads the next JSON token from the stream. + /// Reads the next JSON token from the underlying . /// /// /// true if the next token was read successfully; false if there are no more tokens to read. diff --git a/Src/Newtonsoft.Json/Linq/JTokenWriter.cs b/Src/Newtonsoft.Json/Linq/JTokenWriter.cs index 3c76cbfc..b60305cf 100644 --- a/Src/Newtonsoft.Json/Linq/JTokenWriter.cs +++ b/Src/Newtonsoft.Json/Linq/JTokenWriter.cs @@ -52,9 +52,9 @@ namespace Newtonsoft.Json.Linq } /// - /// Gets the token being writen. + /// Gets the token being written. /// - /// The token being writen. + /// The token being written. public JToken Token { get @@ -88,15 +88,18 @@ namespace Newtonsoft.Json.Linq } /// - /// Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + /// Flushes whatever is in the buffer to the underlying . /// public override void Flush() { } /// - /// Closes this stream and the underlying stream. + /// Closes this writer. /// + /// + /// Setting to true has no additional effect, since the underlying is a type that cannot be closed. + /// public override void Close() { base.Close();