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 <c> markup in a few places.
This commit is contained in:
stakx
2016-12-23 16:15:24 +01:00
parent 780100b81f
commit e19ac3f28c
59 changed files with 342 additions and 352 deletions
+1 -1
View File
@@ -223,7 +223,7 @@ namespace Newtonsoft.Json.Bson
} }
/// <summary> /// <summary>
/// Changes the <see cref="JsonReader.State"/> to Closed. /// Changes the reader's state to <see cref="JsonReader.State.Closed"/>.
/// </summary> /// </summary>
public override void Close() public override void Close()
{ {
@@ -32,7 +32,7 @@ using Newtonsoft.Json.Utilities;
namespace Newtonsoft.Json.Converters namespace Newtonsoft.Json.Converters
{ {
/// <summary> /// <summary>
/// Converts an Entity Framework <c>EntityKey</c> to and from JSON. /// Converts an Entity Framework <see cref="T:System.Data.EntityKeyMember"/> to and from JSON.
/// </summary> /// </summary>
public class EntityKeyMemberConverter : JsonConverter public class EntityKeyMemberConverter : JsonConverter
{ {
@@ -30,7 +30,7 @@ using Newtonsoft.Json.Utilities;
namespace Newtonsoft.Json.Converters namespace Newtonsoft.Json.Converters
{ {
/// <summary> /// <summary>
/// Converts a <see cref="DateTime"/> to and from the ISO 8601 date format (e.g. 2008-04-12T12:53Z). /// Converts a <see cref="DateTime"/> to and from the ISO 8601 date format (e.g. <c>"2008-04-12T12:53Z"</c>).
/// </summary> /// </summary>
public class IsoDateTimeConverter : DateTimeConverterBase public class IsoDateTimeConverter : DateTimeConverterBase
{ {
@@ -30,7 +30,7 @@ using Newtonsoft.Json.Utilities;
namespace Newtonsoft.Json.Converters namespace Newtonsoft.Json.Converters
{ {
/// <summary> /// <summary>
/// Converts a <see cref="DateTime"/> to and from a JavaScript date constructor (e.g. new Date(52231943)). /// Converts a <see cref="DateTime"/> to and from a JavaScript <c>Date</c> constructor (e.g. <c>new Date(52231943)</c>).
/// </summary> /// </summary>
public class JavaScriptDateTimeConverter : DateTimeConverterBase public class JavaScriptDateTimeConverter : DateTimeConverterBase
{ {
@@ -30,7 +30,7 @@ using Newtonsoft.Json.Utilities;
namespace Newtonsoft.Json.Converters namespace Newtonsoft.Json.Converters
{ {
/// <summary> /// <summary>
/// Converts a <see cref="Version"/> to and from a string (e.g. "1.2.3.4"). /// Converts a <see cref="Version"/> to and from a string (e.g. <c>"1.2.3.4"</c>).
/// </summary> /// </summary>
public class VersionConverter : JsonConverter public class VersionConverter : JsonConverter
{ {
+2 -2
View File
@@ -31,12 +31,12 @@ namespace Newtonsoft.Json
public enum DateFormatHandling public enum DateFormatHandling
{ {
/// <summary> /// <summary>
/// Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". /// Dates are written in the ISO 8601 format, e.g. <c>"2012-03-21T05:40Z"</c>.
/// </summary> /// </summary>
IsoDateFormat, IsoDateFormat,
/// <summary> /// <summary>
/// Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". /// Dates are written in the Microsoft JSON format, e.g. <c>"\/Date(1198908717056)\/"</c>.
/// </summary> /// </summary>
MicrosoftDateFormat MicrosoftDateFormat
} }
+3 -3
View File
@@ -26,7 +26,7 @@
namespace Newtonsoft.Json namespace Newtonsoft.Json
{ {
/// <summary> /// <summary>
/// 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. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed when reading JSON text.
/// </summary> /// </summary>
public enum DateParseHandling public enum DateParseHandling
{ {
@@ -36,12 +36,12 @@ namespace Newtonsoft.Json
None = 0, None = 0,
/// <summary> /// <summary>
/// Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to <see cref="DateTime"/>. /// Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="DateTime"/>.
/// </summary> /// </summary>
DateTime = 1, DateTime = 1,
#if !NET20 #if !NET20
/// <summary> /// <summary>
/// Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to <see cref="DateTimeOffset"/>. /// Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="DateTimeOffset"/>.
/// </summary> /// </summary>
DateTimeOffset = 2 DateTimeOffset = 2
#endif #endif
+7 -5
View File
@@ -23,27 +23,29 @@
// OTHER DEALINGS IN THE SOFTWARE. // OTHER DEALINGS IN THE SOFTWARE.
#endregion #endregion
using System;
namespace Newtonsoft.Json namespace Newtonsoft.Json
{ {
/// <summary> /// <summary>
/// Specifies float format handling options when writing special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, /// Specifies float format handling options when writing special floating point numbers, e.g. <see cref="Double.NaN"/>,
/// <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/> with <see cref="JsonWriter"/>. /// <see cref="Double.PositiveInfinity"/> and <see cref="Double.NegativeInfinity"/> with <see cref="JsonWriter"/>.
/// </summary> /// </summary>
public enum FloatFormatHandling public enum FloatFormatHandling
{ {
/// <summary> /// <summary>
/// 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. <c>"NaN"</c>, <c>"Infinity"</c>, <c>"-Infinity"</c>.
/// </summary> /// </summary>
String = 0, String = 0,
/// <summary> /// <summary>
/// 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. <c>NaN</c>, <c>Infinity</c>, <c>-Infinity</c>.
/// Note that this will produce non-valid JSON. /// Note that this will produce non-valid JSON.
/// </summary> /// </summary>
Symbol = 1, Symbol = 1,
/// <summary> /// <summary>
/// Write special floating point values as the property's default value in JSON, e.g. 0.0 for a <see cref="System.Double"/> property, <c>null</c> for a <see cref="System.Nullable{Double}"/> property. /// Write special floating point values as the property's default value in JSON, e.g. 0.0 for a <see cref="Double"/> property, <c>null</c> for a <see cref="Nullable{T}"/> of <see cref="Double"/> property.
/// </summary> /// </summary>
DefaultValue = 2 DefaultValue = 2
} }
@@ -9,12 +9,12 @@ namespace System.Runtime.Serialization.Formatters
public enum FormatterAssemblyStyle public enum FormatterAssemblyStyle
{ {
/// <summary> /// <summary>
/// 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 <c>LoadWithPartialName</c> 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 <see cref="M:System.Reflection.Assembly.LoadWithPartialName(String)"/> method is used to load the assembly.
/// </summary> /// </summary>
Simple = 0, Simple = 0,
/// <summary> /// <summary>
/// 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 <see cref="System.Reflection.Assembly.Load"/> is used to load the assembly.
/// </summary> /// </summary>
Full = 1 Full = 1
} }
+14 -14
View File
@@ -596,7 +596,7 @@ namespace Newtonsoft.Json
/// If this is <c>null</c>, default serialization settings will be used.</param> /// If this is <c>null</c>, default serialization settings will be used.</param>
/// <param name="type"> /// <param name="type">
/// The type of the value being serialized. /// The type of the value being serialized.
/// This parameter is used when <see cref="TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match. /// This parameter is used when <see cref="JsonSerializer.TypeNameHandling"/> is <see cref="TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match.
/// Specifing the type is optional. /// Specifing the type is optional.
/// </param> /// </param>
/// <returns> /// <returns>
@@ -633,7 +633,7 @@ namespace Newtonsoft.Json
/// If this is <c>null</c>, default serialization settings will be used.</param> /// If this is <c>null</c>, default serialization settings will be used.</param>
/// <param name="type"> /// <param name="type">
/// The type of the value being serialized. /// The type of the value being serialized.
/// This parameter is used when <see cref="TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match. /// This parameter is used when <see cref="JsonSerializer.TypeNameHandling"/> is <see cref="TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match.
/// Specifing the type is optional. /// Specifing the type is optional.
/// </param> /// </param>
/// <returns> /// <returns>
@@ -996,7 +996,7 @@ namespace Newtonsoft.Json
/// Serializes the <see cref="XmlNode"/> to a JSON string. /// Serializes the <see cref="XmlNode"/> to a JSON string.
/// </summary> /// </summary>
/// <param name="node">The node to serialize.</param> /// <param name="node">The node to serialize.</param>
/// <returns>A JSON string of the XmlNode.</returns> /// <returns>A JSON string of the <see cref="XmlNode"/>.</returns>
public static string SerializeXmlNode(XmlNode node) public static string SerializeXmlNode(XmlNode node)
{ {
return SerializeXmlNode(node, Formatting.None); return SerializeXmlNode(node, Formatting.None);
@@ -1007,7 +1007,7 @@ namespace Newtonsoft.Json
/// </summary> /// </summary>
/// <param name="node">The node to serialize.</param> /// <param name="node">The node to serialize.</param>
/// <param name="formatting">Indicates how the output should be formatted.</param> /// <param name="formatting">Indicates how the output should be formatted.</param>
/// <returns>A JSON string of the XmlNode.</returns> /// <returns>A JSON string of the <see cref="XmlNode"/>.</returns>
public static string SerializeXmlNode(XmlNode node, Formatting formatting) public static string SerializeXmlNode(XmlNode node, Formatting formatting)
{ {
XmlNodeConverter converter = new XmlNodeConverter(); XmlNodeConverter converter = new XmlNodeConverter();
@@ -1021,7 +1021,7 @@ namespace Newtonsoft.Json
/// <param name="node">The node to serialize.</param> /// <param name="node">The node to serialize.</param>
/// <param name="formatting">Indicates how the output should be formatted.</param> /// <param name="formatting">Indicates how the output should be formatted.</param>
/// <param name="omitRootObject">Omits writing the root object.</param> /// <param name="omitRootObject">Omits writing the root object.</param>
/// <returns>A JSON string of the XmlNode.</returns> /// <returns>A JSON string of the <see cref="XmlNode"/>.</returns>
public static string SerializeXmlNode(XmlNode node, Formatting formatting, bool omitRootObject) public static string SerializeXmlNode(XmlNode node, Formatting formatting, bool omitRootObject)
{ {
XmlNodeConverter converter = new XmlNodeConverter { OmitRootObject = omitRootObject }; XmlNodeConverter converter = new XmlNodeConverter { OmitRootObject = omitRootObject };
@@ -1033,7 +1033,7 @@ namespace Newtonsoft.Json
/// Deserializes the <see cref="XmlNode"/> from a JSON string. /// Deserializes the <see cref="XmlNode"/> from a JSON string.
/// </summary> /// </summary>
/// <param name="value">The JSON string.</param> /// <param name="value">The JSON string.</param>
/// <returns>The deserialized XmlNode.</returns> /// <returns>The deserialized <see cref="XmlNode"/>.</returns>
public static XmlDocument DeserializeXmlNode(string value) public static XmlDocument DeserializeXmlNode(string value)
{ {
return DeserializeXmlNode(value, null); return DeserializeXmlNode(value, null);
@@ -1044,7 +1044,7 @@ namespace Newtonsoft.Json
/// </summary> /// </summary>
/// <param name="value">The JSON string.</param> /// <param name="value">The JSON string.</param>
/// <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> /// <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
/// <returns>The deserialized XmlNode.</returns> /// <returns>The deserialized <see cref="XmlNode"/>.</returns>
public static XmlDocument DeserializeXmlNode(string value, string deserializeRootElementName) public static XmlDocument DeserializeXmlNode(string value, string deserializeRootElementName)
{ {
return DeserializeXmlNode(value, deserializeRootElementName, false); return DeserializeXmlNode(value, deserializeRootElementName, false);
@@ -1060,7 +1060,7 @@ namespace Newtonsoft.Json
/// A flag to indicate whether to write the Json.NET array attribute. /// 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. /// This attribute helps preserve arrays when converting the written XML back to JSON.
/// </param> /// </param>
/// <returns>The deserialized XmlNode.</returns> /// <returns>The deserialized <see cref="XmlNode"/>.</returns>
public static XmlDocument DeserializeXmlNode(string value, string deserializeRootElementName, bool writeArrayAttribute) public static XmlDocument DeserializeXmlNode(string value, string deserializeRootElementName, bool writeArrayAttribute)
{ {
XmlNodeConverter converter = new XmlNodeConverter(); XmlNodeConverter converter = new XmlNodeConverter();
@@ -1076,7 +1076,7 @@ namespace Newtonsoft.Json
/// Serializes the <see cref="XNode"/> to a JSON string. /// Serializes the <see cref="XNode"/> to a JSON string.
/// </summary> /// </summary>
/// <param name="node">The node to convert to JSON.</param> /// <param name="node">The node to convert to JSON.</param>
/// <returns>A JSON string of the XNode.</returns> /// <returns>A JSON string of the <see cref="XNode"/>.</returns>
public static string SerializeXNode(XObject node) public static string SerializeXNode(XObject node)
{ {
return SerializeXNode(node, Formatting.None); return SerializeXNode(node, Formatting.None);
@@ -1087,7 +1087,7 @@ namespace Newtonsoft.Json
/// </summary> /// </summary>
/// <param name="node">The node to convert to JSON.</param> /// <param name="node">The node to convert to JSON.</param>
/// <param name="formatting">Indicates how the output should be formatted.</param> /// <param name="formatting">Indicates how the output should be formatted.</param>
/// <returns>A JSON string of the XNode.</returns> /// <returns>A JSON string of the <see cref="XNode"/>.</returns>
public static string SerializeXNode(XObject node, Formatting formatting) public static string SerializeXNode(XObject node, Formatting formatting)
{ {
return SerializeXNode(node, formatting, false); return SerializeXNode(node, formatting, false);
@@ -1099,7 +1099,7 @@ namespace Newtonsoft.Json
/// <param name="node">The node to serialize.</param> /// <param name="node">The node to serialize.</param>
/// <param name="formatting">Indicates how the output should be formatted.</param> /// <param name="formatting">Indicates how the output should be formatted.</param>
/// <param name="omitRootObject">Omits writing the root object.</param> /// <param name="omitRootObject">Omits writing the root object.</param>
/// <returns>A JSON string of the XNode.</returns> /// <returns>A JSON string of the <see cref="XNode"/>.</returns>
public static string SerializeXNode(XObject node, Formatting formatting, bool omitRootObject) public static string SerializeXNode(XObject node, Formatting formatting, bool omitRootObject)
{ {
XmlNodeConverter converter = new XmlNodeConverter { OmitRootObject = omitRootObject }; XmlNodeConverter converter = new XmlNodeConverter { OmitRootObject = omitRootObject };
@@ -1111,7 +1111,7 @@ namespace Newtonsoft.Json
/// Deserializes the <see cref="XNode"/> from a JSON string. /// Deserializes the <see cref="XNode"/> from a JSON string.
/// </summary> /// </summary>
/// <param name="value">The JSON string.</param> /// <param name="value">The JSON string.</param>
/// <returns>The deserialized XNode.</returns> /// <returns>The deserialized <see cref="XNode"/>.</returns>
public static XDocument DeserializeXNode(string value) public static XDocument DeserializeXNode(string value)
{ {
return DeserializeXNode(value, null); return DeserializeXNode(value, null);
@@ -1122,7 +1122,7 @@ namespace Newtonsoft.Json
/// </summary> /// </summary>
/// <param name="value">The JSON string.</param> /// <param name="value">The JSON string.</param>
/// <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> /// <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
/// <returns>The deserialized XNode.</returns> /// <returns>The deserialized <see cref="XNode"/>.</returns>
public static XDocument DeserializeXNode(string value, string deserializeRootElementName) public static XDocument DeserializeXNode(string value, string deserializeRootElementName)
{ {
return DeserializeXNode(value, deserializeRootElementName, false); return DeserializeXNode(value, deserializeRootElementName, false);
@@ -1138,7 +1138,7 @@ namespace Newtonsoft.Json
/// A flag to indicate whether to write the Json.NET array attribute. /// 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. /// This attribute helps preserve arrays when converting the written XML back to JSON.
/// </param> /// </param>
/// <returns>The deserialized XNode.</returns> /// <returns>The deserialized <see cref="XNode"/>.</returns>
public static XDocument DeserializeXNode(string value, string deserializeRootElementName, bool writeArrayAttribute) public static XDocument DeserializeXNode(string value, string deserializeRootElementName, bool writeArrayAttribute)
{ {
XmlNodeConverter converter = new XmlNodeConverter(); XmlNodeConverter converter = new XmlNodeConverter();
+1 -1
View File
@@ -71,7 +71,7 @@ namespace Newtonsoft.Json
/// JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details. /// JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
/// </note> /// </note>
/// </summary> /// </summary>
/// <returns>The <see cref="JsonSchema"/> of the JSON produced by the JsonConverter.</returns> /// <returns>The <see cref="JsonSchema"/> of the JSON produced by the <see cref="JsonConverter"/>.</returns>
[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.")] [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() public virtual JsonSchema GetSchema()
{ {
+4 -4
View File
@@ -72,10 +72,10 @@ namespace Newtonsoft.Json
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="JsonException"/> class. /// Initializes a new instance of the <see cref="JsonException"/> class.
/// </summary> /// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> /// <exception cref="ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> /// <exception cref="SerializationException">The class name is <c>null</c> or <see cref="Exception.HResult"/> is zero (0).</exception>
public JsonException(SerializationInfo info, StreamingContext context) public JsonException(SerializationInfo info, StreamingContext context)
: base(info, context) : base(info, context)
{ {
+1 -1
View File
@@ -74,7 +74,7 @@ namespace Newtonsoft.Json
public Type NamingStrategyType { get; set; } public Type NamingStrategyType { get; set; }
/// <summary> /// <summary>
/// The parameter list to use when constructing the <see cref="NamingStrategy"/> described by NamingStrategyType. /// The parameter list to use when constructing the <see cref="NamingStrategy"/> described by <see cref="JsonPropertyAttribute.NamingStrategyType"/>.
/// If <c>null</c>, the default constructor is used. /// If <c>null</c>, the default constructor is used.
/// When non-<c>null</c>, there must be a constructor defined in the <see cref="NamingStrategy"/> that exactly matches the number, /// When non-<c>null</c>, there must be a constructor defined in the <see cref="NamingStrategy"/> that exactly matches the number,
/// order, and type of these parameters. /// order, and type of these parameters.
+15 -18
View File
@@ -51,7 +51,7 @@ namespace Newtonsoft.Json
protected internal enum State protected internal enum State
{ {
/// <summary> /// <summary>
/// The <see cref="Read"/> method has not been called. /// A <see cref="JsonReader"/> read method has not been called.
/// </summary> /// </summary>
Start, Start,
@@ -86,7 +86,7 @@ namespace Newtonsoft.Json
Array, Array,
/// <summary> /// <summary>
/// The <see cref="Close"/> method has been called. /// The <see cref="JsonReader.Close()"/> method has been called.
/// </summary> /// </summary>
Closed, Closed,
@@ -412,9 +412,9 @@ namespace Newtonsoft.Json
public abstract bool Read(); public abstract bool Read();
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Int32}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Int32"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Int32}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Int32"/>. This method will return <c>null</c> at the end of an array.</returns>
public virtual int? ReadAsInt32() public virtual int? ReadAsInt32()
{ {
JsonToken t = GetContentToken(); JsonToken t = GetContentToken();
@@ -606,9 +606,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Double}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Double"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Double}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Double"/>. This method will return <c>null</c> at the end of an array.</returns>
public virtual double? ReadAsDouble() public virtual double? ReadAsDouble()
{ {
JsonToken t = GetContentToken(); JsonToken t = GetContentToken();
@@ -668,9 +668,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Boolean}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Boolean"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Boolean}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Boolean"/>. This method will return <c>null</c> at the end of an array.</returns>
public virtual bool? ReadAsBoolean() public virtual bool? ReadAsBoolean()
{ {
JsonToken t = GetContentToken(); JsonToken t = GetContentToken();
@@ -729,9 +729,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Decimal}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Decimal"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Decimal}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Decimal"/>. This method will return <c>null</c> at the end of an array.</returns>
public virtual decimal? ReadAsDecimal() public virtual decimal? ReadAsDecimal()
{ {
JsonToken t = GetContentToken(); JsonToken t = GetContentToken();
@@ -779,9 +779,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{DateTime}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="DateTime"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{DateTime}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="DateTime"/>. This method will return <c>null</c> at the end of an array.</returns>
public virtual DateTime? ReadAsDateTime() public virtual DateTime? ReadAsDateTime()
{ {
switch (GetContentToken()) switch (GetContentToken())
@@ -835,9 +835,9 @@ namespace Newtonsoft.Json
#if !NET20 #if !NET20
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{DateTimeOffset}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{DateTimeOffset}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/>. This method will return <c>null</c> at the end of an array.</returns>
public virtual DateTimeOffset? ReadAsDateTimeOffset() public virtual DateTimeOffset? ReadAsDateTimeOffset()
{ {
JsonToken t = GetContentToken(); JsonToken t = GetContentToken();
@@ -1104,9 +1104,6 @@ namespace Newtonsoft.Json
} }
} }
/// <summary>
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
/// </summary>
void IDisposable.Dispose() void IDisposable.Dispose()
{ {
Dispose(true); Dispose(true);
@@ -1126,7 +1123,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Changes the <see cref="State"/> to Closed. /// Changes the reader's state to <see cref="JsonReader.State.Closed"/>.
/// </summary> /// </summary>
public virtual void Close() public virtual void Close()
{ {
+4 -4
View File
@@ -88,10 +88,10 @@ namespace Newtonsoft.Json
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="JsonReaderException"/> class. /// Initializes a new instance of the <see cref="JsonReaderException"/> class.
/// </summary> /// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> /// <exception cref="ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> /// <exception cref="SerializationException">The class name is <c>null</c> or <see cref="Exception.HResult"/> is zero (0).</exception>
public JsonReaderException(SerializationInfo info, StreamingContext context) public JsonReaderException(SerializationInfo info, StreamingContext context)
: base(info, context) : base(info, context)
{ {
@@ -70,10 +70,10 @@ namespace Newtonsoft.Json
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="JsonSerializationException"/> class. /// Initializes a new instance of the <see cref="JsonSerializationException"/> class.
/// </summary> /// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> /// <exception cref="ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> /// <exception cref="SerializationException">The class name is <c>null</c> or <see cref="Exception.HResult"/> is zero (0).</exception>
public JsonSerializationException(SerializationInfo info, StreamingContext context) public JsonSerializationException(SerializationInfo info, StreamingContext context)
: base(info, context) : base(info, context)
{ {
+9 -9
View File
@@ -171,9 +171,9 @@ namespace Newtonsoft.Json
/// Gets or sets how type name writing and reading is handled by the serializer. /// Gets or sets how type name writing and reading is handled by the serializer.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// <see cref="TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source. /// <see cref="JsonSerializer.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source.
/// Incoming types should be validated with a custom <see cref="T:System.Runtime.Serialization.SerializationBinder"/> /// Incoming types should be validated with a custom <see cref="JsonSerializer.SerializationBinder"/>
/// when deserializing with a value other than <c>TypeNameHandling.None</c>. /// when deserializing with a value other than <see cref="TypeNameHandling.None"/>.
/// </remarks> /// </remarks>
public virtual TypeNameHandling TypeNameHandling public virtual TypeNameHandling TypeNameHandling
{ {
@@ -430,7 +430,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// 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. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed when reading JSON.
/// </summary> /// </summary>
public virtual DateParseHandling DateParseHandling public virtual DateParseHandling DateParseHandling
{ {
@@ -448,8 +448,8 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, /// Gets or sets how special floating point numbers, e.g. <see cref="Double.NaN"/>,
/// <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, /// <see cref="Double.PositiveInfinity"/> and <see cref="Double.NegativeInfinity"/>,
/// are written as JSON text. /// are written as JSON text.
/// </summary> /// </summary>
public virtual FloatFormatHandling FloatFormatHandling public virtual FloatFormatHandling FloatFormatHandling
@@ -994,7 +994,7 @@ namespace Newtonsoft.Json
/// <summary> /// <summary>
/// Serializes the specified <see cref="Object"/> and writes the JSON structure /// Serializes the specified <see cref="Object"/> and writes the JSON structure
/// to a <c>Stream</c> using the specified <see cref="TextWriter"/>. /// to a <see cref="Stream"/> using the specified <see cref="TextWriter"/>.
/// </summary> /// </summary>
/// <param name="textWriter">The <see cref="TextWriter"/> used to write the JSON structure.</param> /// <param name="textWriter">The <see cref="TextWriter"/> used to write the JSON structure.</param>
/// <param name="value">The <see cref="Object"/> to serialize.</param> /// <param name="value">The <see cref="Object"/> to serialize.</param>
@@ -1005,13 +1005,13 @@ namespace Newtonsoft.Json
/// <summary> /// <summary>
/// Serializes the specified <see cref="Object"/> and writes the JSON structure /// Serializes the specified <see cref="Object"/> and writes the JSON structure
/// to a <c>Stream</c> using the specified <see cref="TextWriter"/>. /// to a <see cref="Stream"/> using the specified <see cref="TextWriter"/>.
/// </summary> /// </summary>
/// <param name="jsonWriter">The <see cref="JsonWriter"/> used to write the JSON structure.</param> /// <param name="jsonWriter">The <see cref="JsonWriter"/> used to write the JSON structure.</param>
/// <param name="value">The <see cref="Object"/> to serialize.</param> /// <param name="value">The <see cref="Object"/> to serialize.</param>
/// <param name="objectType"> /// <param name="objectType">
/// The type of the value being serialized. /// The type of the value being serialized.
/// This parameter is used when <see cref="TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match. /// This parameter is used when <see cref="JsonSerializer.TypeNameHandling"/> is <see cref="TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match.
/// Specifing the type is optional. /// Specifing the type is optional.
/// </param> /// </param>
public void Serialize(JsonWriter jsonWriter, object value, Type objectType) public void Serialize(JsonWriter jsonWriter, object value, Type objectType)
@@ -157,9 +157,9 @@ namespace Newtonsoft.Json
/// Gets or sets how type name writing and reading is handled by the serializer. /// Gets or sets how type name writing and reading is handled by the serializer.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// <see cref="TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source. /// <see cref="JsonSerializerSettings.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source.
/// Incoming types should be validated with a custom <see cref="T:System.Runtime.Serialization.SerializationBinder"/> /// Incoming types should be validated with a custom <see cref="JsonSerializerSettings.SerializationBinder"/>
/// when deserializing with a value other than <c>TypeNameHandling.None</c>. /// when deserializing with a value other than <see cref="TypeNameHandling.None"/>.
/// </remarks> /// </remarks>
/// <value>The type name handling.</value> /// <value>The type name handling.</value>
public TypeNameHandling TypeNameHandling public TypeNameHandling TypeNameHandling
@@ -374,8 +374,8 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, /// Gets or sets how special floating point numbers, e.g. <see cref="Double.NaN"/>,
/// <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, /// <see cref="Double.PositiveInfinity"/> and <see cref="Double.NegativeInfinity"/>,
/// are written as JSON. /// are written as JSON.
/// </summary> /// </summary>
public FloatFormatHandling FloatFormatHandling public FloatFormatHandling FloatFormatHandling
+17 -17
View File
@@ -75,7 +75,7 @@ namespace Newtonsoft.Json
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="JsonTextReader"/> class with the specified <see cref="TextReader"/>. /// Initializes a new instance of the <see cref="JsonTextReader"/> class with the specified <see cref="TextReader"/>.
/// </summary> /// </summary>
/// <param name="reader">The <c>TextReader</c> containing the JSON data to read.</param> /// <param name="reader">The <see cref="TextReader"/> containing the JSON data to read.</param>
public JsonTextReader(TextReader reader) public JsonTextReader(TextReader reader)
{ {
if (reader == null) if (reader == null)
@@ -416,18 +416,18 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Int32}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Int32"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Int32}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Int32"/>. This method will return <c>null</c> at the end of an array.</returns>
public override int? ReadAsInt32() public override int? ReadAsInt32()
{ {
return (int?)ReadNumberValue(ReadType.ReadAsInt32); return (int?)ReadNumberValue(ReadType.ReadAsInt32);
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{DateTime}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="DateTime"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{DateTime}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="DateTime"/>. This method will return <c>null</c> at the end of an array.</returns>
public override DateTime? ReadAsDateTime() public override DateTime? ReadAsDateTime()
{ {
return (DateTime?)ReadStringValue(ReadType.ReadAsDateTime); return (DateTime?)ReadStringValue(ReadType.ReadAsDateTime);
@@ -697,9 +697,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Boolean}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Boolean"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Boolean}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Boolean"/>. This method will return <c>null</c> at the end of an array.</returns>
public override bool? ReadAsBoolean() public override bool? ReadAsBoolean()
{ {
EnsureBuffer(); EnsureBuffer();
@@ -945,9 +945,9 @@ namespace Newtonsoft.Json
#if !NET20 #if !NET20
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{DateTimeOffset}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{DateTimeOffset}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/>. This method will return <c>null</c> at the end of an array.</returns>
public override DateTimeOffset? ReadAsDateTimeOffset() public override DateTimeOffset? ReadAsDateTimeOffset()
{ {
return (DateTimeOffset?)ReadStringValue(ReadType.ReadAsDateTimeOffset); return (DateTimeOffset?)ReadStringValue(ReadType.ReadAsDateTimeOffset);
@@ -955,18 +955,18 @@ namespace Newtonsoft.Json
#endif #endif
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Decimal}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Decimal"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Decimal}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Decimal"/>. This method will return <c>null</c> at the end of an array.</returns>
public override decimal? ReadAsDecimal() public override decimal? ReadAsDecimal()
{ {
return (decimal?)ReadNumberValue(ReadType.ReadAsDecimal); return (decimal?)ReadNumberValue(ReadType.ReadAsDecimal);
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Double}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Double"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Double}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Double"/>. This method will return <c>null</c> at the end of an array.</returns>
public override double? ReadAsDouble() public override double? ReadAsDouble()
{ {
return (double?)ReadNumberValue(ReadType.ReadAsDouble); return (double?)ReadNumberValue(ReadType.ReadAsDouble);
@@ -2401,7 +2401,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Changes the state to Closed. /// Changes the reader's state to <see cref="JsonReader.State.Closed"/>.
/// </summary> /// </summary>
public override void Close() public override void Close()
{ {
@@ -2429,7 +2429,7 @@ namespace Newtonsoft.Json
/// Gets a value indicating whether the class can return line information. /// Gets a value indicating whether the class can return line information.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// <c>true</c> if LineNumber and LinePosition can be provided; otherwise, <c>false</c>. /// <c>true</c> if <see cref="JsonTextReader.LineNumber"/> and <see cref="JsonTextReader.LinePosition"/> can be provided; otherwise, <c>false</c>.
/// </returns> /// </returns>
public bool HasLineInfo() public bool HasLineInfo()
{ {
@@ -2440,7 +2440,7 @@ namespace Newtonsoft.Json
/// Gets the current line number. /// Gets the current line number.
/// </summary> /// </summary>
/// <value> /// <value>
/// The current line number or 0 if no line information is available (for example, HasLineInfo returns <c>false</c>). /// The current line number or 0 if no line information is available (for example, <see cref="JsonTextReader.HasLineInfo"/> returns <c>false</c>).
/// </value> /// </value>
public int LineNumber public int LineNumber
{ {
@@ -2459,7 +2459,7 @@ namespace Newtonsoft.Json
/// Gets the current line position. /// Gets the current line position.
/// </summary> /// </summary>
/// <value> /// <value>
/// The current line position or 0 if no line information is available (for example, HasLineInfo returns <c>false</c>). /// The current line position or 0 if no line information is available (for example, <see cref="JsonTextReader.HasLineInfo"/> returns <c>false</c>).
/// </value> /// </value>
public int LinePosition public int LinePosition
{ {
+8 -8
View File
@@ -83,7 +83,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Gets or sets how many IndentChars to write for each level in the hierarchy when <see cref="Formatting"/> is set to <c>Formatting.Indented</c>. /// Gets or sets how many <see cref="JsonTextWriter.IndentChar"/>s to write for each level in the hierarchy when <see cref="JsonWriter.Formatting"/> is set to <see cref="Formatting.Indented"/>.
/// </summary> /// </summary>
public int Indentation public int Indentation
{ {
@@ -118,7 +118,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Gets or sets which character to use for indenting when <see cref="Formatting"/> is set to <c>Formatting.Indented</c>. /// Gets or sets which character to use for indenting when <see cref="JsonWriter.Formatting"/> is set to <see cref="Formatting.Indented"/>.
/// </summary> /// </summary>
public char IndentChar public char IndentChar
{ {
@@ -143,9 +143,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Initializes a new instance of the <c>JsonTextWriter</c> class using the specified <see cref="TextWriter"/>. /// Initializes a new instance of the <see cref="JsonTextWriter"/> class using the specified <see cref="TextWriter"/>.
/// </summary> /// </summary>
/// <param name="textWriter">The <c>TextWriter</c> to write to.</param> /// <param name="textWriter">The <see cref="TextWriter"/> to write to.</param>
public JsonTextWriter(TextWriter textWriter) public JsonTextWriter(TextWriter textWriter)
{ {
if (textWriter == null) if (textWriter == null)
@@ -478,9 +478,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Single}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Single"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Single}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Single"/> value to write.</param>
public override void WriteValue(float? value) public override void WriteValue(float? value)
{ {
if (value == null) if (value == null)
@@ -505,9 +505,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Double}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Double"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Double}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Double"/> value to write.</param>
public override void WriteValue(double? value) public override void WriteValue(double? value)
{ {
if (value == null) if (value == null)
+1 -1
View File
@@ -35,7 +35,7 @@ namespace Newtonsoft.Json
public enum JsonToken public enum JsonToken
{ {
/// <summary> /// <summary>
/// This is returned by the <see cref="JsonReader"/> if a <see cref="JsonReader.Read"/> method has not been called. /// This is returned by the <see cref="JsonReader"/> if a read method has not been called.
/// </summary> /// </summary>
None = 0, None = 0,
+12 -12
View File
@@ -392,9 +392,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Int32}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Int32"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Int32}"/>.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Int32"/>.</returns>
public override int? ReadAsInt32() public override int? ReadAsInt32()
{ {
int? i = _reader.ReadAsInt32(); int? i = _reader.ReadAsInt32();
@@ -418,9 +418,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Decimal}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Decimal"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Decimal}"/>.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Decimal"/>.</returns>
public override decimal? ReadAsDecimal() public override decimal? ReadAsDecimal()
{ {
decimal? d = _reader.ReadAsDecimal(); decimal? d = _reader.ReadAsDecimal();
@@ -430,9 +430,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Double}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Double"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Double}"/>.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Double"/>.</returns>
public override double? ReadAsDouble() public override double? ReadAsDouble()
{ {
double? d = _reader.ReadAsDouble(); double? d = _reader.ReadAsDouble();
@@ -442,9 +442,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{Boolean}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="Boolean"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{Boolean}"/>.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="Boolean"/>.</returns>
public override bool? ReadAsBoolean() public override bool? ReadAsBoolean()
{ {
bool? b = _reader.ReadAsBoolean(); bool? b = _reader.ReadAsBoolean();
@@ -466,9 +466,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{DateTime}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="DateTime"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{DateTime}"/>. This method will return <c>null</c> at the end of an array.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="DateTime"/>. This method will return <c>null</c> at the end of an array.</returns>
public override DateTime? ReadAsDateTime() public override DateTime? ReadAsDateTime()
{ {
DateTime? dateTime = _reader.ReadAsDateTime(); DateTime? dateTime = _reader.ReadAsDateTime();
@@ -479,9 +479,9 @@ namespace Newtonsoft.Json
#if !NET20 #if !NET20
/// <summary> /// <summary>
/// Reads the next JSON token from the stream as a <see cref="Nullable{DateTimeOffset}"/>. /// Reads the next JSON token from the stream as a <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/>.
/// </summary> /// </summary>
/// <returns>A <see cref="Nullable{DateTimeOffset}"/>.</returns> /// <returns>A <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/>.</returns>
public override DateTimeOffset? ReadAsDateTimeOffset() public override DateTimeOffset? ReadAsDateTimeOffset()
{ {
DateTimeOffset? dateTimeOffset = _reader.ReadAsDateTimeOffset(); DateTimeOffset? dateTimeOffset = _reader.ReadAsDateTimeOffset();
+38 -38
View File
@@ -295,8 +295,8 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, /// Gets or sets how special floating point numbers, e.g. <see cref="Double.NaN"/>,
/// <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, /// <see cref="Double.PositiveInfinity"/> and <see cref="Double.NegativeInfinity"/>,
/// are written to JSON text. /// are written to JSON text.
/// </summary> /// </summary>
public FloatFormatHandling FloatFormatHandling public FloatFormatHandling FloatFormatHandling
@@ -1071,9 +1071,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Int32}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Int32"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Int32}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Int32"/> value to write.</param>
public virtual void WriteValue(int? value) public virtual void WriteValue(int? value)
{ {
if (value == null) if (value == null)
@@ -1087,9 +1087,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{UInt32}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="UInt32"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{UInt32}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="UInt32"/> value to write.</param>
[CLSCompliant(false)] [CLSCompliant(false)]
public virtual void WriteValue(uint? value) public virtual void WriteValue(uint? value)
{ {
@@ -1104,9 +1104,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Int64}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Int64"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Int64}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Int64"/> value to write.</param>
public virtual void WriteValue(long? value) public virtual void WriteValue(long? value)
{ {
if (value == null) if (value == null)
@@ -1120,9 +1120,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{UInt64}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="UInt64"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{UInt64}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="UInt64"/> value to write.</param>
[CLSCompliant(false)] [CLSCompliant(false)]
public virtual void WriteValue(ulong? value) public virtual void WriteValue(ulong? value)
{ {
@@ -1137,9 +1137,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Single}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Single"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Single}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Single"/> value to write.</param>
public virtual void WriteValue(float? value) public virtual void WriteValue(float? value)
{ {
if (value == null) if (value == null)
@@ -1153,9 +1153,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Double}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Double"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Double}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Double"/> value to write.</param>
public virtual void WriteValue(double? value) public virtual void WriteValue(double? value)
{ {
if (value == null) if (value == null)
@@ -1169,9 +1169,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Boolean}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Boolean"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Boolean}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Boolean"/> value to write.</param>
public virtual void WriteValue(bool? value) public virtual void WriteValue(bool? value)
{ {
if (value == null) if (value == null)
@@ -1185,9 +1185,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Int16}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Int16"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Int16}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Int16"/> value to write.</param>
public virtual void WriteValue(short? value) public virtual void WriteValue(short? value)
{ {
if (value == null) if (value == null)
@@ -1201,9 +1201,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{UInt16}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="UInt16"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{UInt16}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="UInt16"/> value to write.</param>
[CLSCompliant(false)] [CLSCompliant(false)]
public virtual void WriteValue(ushort? value) public virtual void WriteValue(ushort? value)
{ {
@@ -1218,9 +1218,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Char}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Char"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Char}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Char"/> value to write.</param>
public virtual void WriteValue(char? value) public virtual void WriteValue(char? value)
{ {
if (value == null) if (value == null)
@@ -1234,9 +1234,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Byte}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Byte"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Byte}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Byte"/> value to write.</param>
public virtual void WriteValue(byte? value) public virtual void WriteValue(byte? value)
{ {
if (value == null) if (value == null)
@@ -1250,9 +1250,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{SByte}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="SByte"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{SByte}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="SByte"/> value to write.</param>
[CLSCompliant(false)] [CLSCompliant(false)]
public virtual void WriteValue(sbyte? value) public virtual void WriteValue(sbyte? value)
{ {
@@ -1267,9 +1267,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Decimal}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Decimal"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Decimal}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Decimal"/> value to write.</param>
public virtual void WriteValue(decimal? value) public virtual void WriteValue(decimal? value)
{ {
if (value == null) if (value == null)
@@ -1283,9 +1283,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{DateTime}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="DateTime"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{DateTime}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="DateTime"/> value to write.</param>
public virtual void WriteValue(DateTime? value) public virtual void WriteValue(DateTime? value)
{ {
if (value == null) if (value == null)
@@ -1300,9 +1300,9 @@ namespace Newtonsoft.Json
#if !NET20 #if !NET20
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{DateTimeOffset}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{DateTimeOffset}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/> value to write.</param>
public virtual void WriteValue(DateTimeOffset? value) public virtual void WriteValue(DateTimeOffset? value)
{ {
if (value == null) if (value == null)
@@ -1317,9 +1317,9 @@ namespace Newtonsoft.Json
#endif #endif
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{Guid}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="Guid"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{Guid}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="Guid"/> value to write.</param>
public virtual void WriteValue(Guid? value) public virtual void WriteValue(Guid? value)
{ {
if (value == null) if (value == null)
@@ -1333,9 +1333,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Writes a <see cref="Nullable{TimeSpan}"/> value. /// Writes a <see cref="Nullable{T}"/> of <see cref="TimeSpan"/> value.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Nullable{TimeSpan}"/> value to write.</param> /// <param name="value">The <see cref="Nullable{T}"/> of <see cref="TimeSpan"/> value to write.</param>
public virtual void WriteValue(TimeSpan? value) public virtual void WriteValue(TimeSpan? value)
{ {
if (value == null) if (value == null)
@@ -1608,9 +1608,9 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Sets the state of the JsonWriter. /// Sets the state of the <see cref="JsonWriter"/>.
/// </summary> /// </summary>
/// <param name="token">The JsonToken being written.</param> /// <param name="token">The <see cref="JsonToken"/> being written.</param>
/// <param name="value">The value being written.</param> /// <param name="value">The value being written.</param>
protected void SetWriteState(JsonToken token, object value) protected void SetWriteState(JsonToken token, object value)
{ {
+4 -4
View File
@@ -76,10 +76,10 @@ namespace Newtonsoft.Json
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="JsonWriterException"/> class. /// Initializes a new instance of the <see cref="JsonWriterException"/> class.
/// </summary> /// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> /// <exception cref="ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> /// <exception cref="SerializationException">The class name is <c>null</c> or <see cref="Exception.HResult"/> is zero (0).</exception>
public JsonWriterException(SerializationInfo info, StreamingContext context) public JsonWriterException(SerializationInfo info, StreamingContext context)
: base(info, context) : base(info, context)
{ {
+2 -2
View File
@@ -30,7 +30,7 @@ namespace Newtonsoft.Json.Linq
/// <summary> /// <summary>
/// Represents a collection of <see cref="JToken"/> objects. /// Represents a collection of <see cref="JToken"/> objects.
/// </summary> /// </summary>
/// <typeparam name="T">The type of token</typeparam> /// <typeparam name="T">The type of token.</typeparam>
public interface IJEnumerable< public interface IJEnumerable<
#if !(NET20 || NET35) #if !(NET20 || NET35)
out out
@@ -38,7 +38,7 @@ namespace Newtonsoft.Json.Linq
T> : IEnumerable<T> where T : JToken T> : IEnumerable<T> where T : JToken
{ {
/// <summary> /// <summary>
/// Gets the <see cref="IJEnumerable{JToken}"/> with the specified key. /// Gets the <see cref="IJEnumerable{T}"/> of <see cref="JToken"/> with the specified key.
/// </summary> /// </summary>
/// <value></value> /// <value></value>
IJEnumerable<JToken> this[object key] { get; } IJEnumerable<JToken> this[object key] { get; }
+24 -27
View File
@@ -290,9 +290,9 @@ namespace Newtonsoft.Json.Linq
#region IList<JToken> Members #region IList<JToken> Members
/// <summary> /// <summary>
/// Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1"/>. /// Determines the index of a specific item in the <see cref="JArray"/>.
/// </summary> /// </summary>
/// <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param> /// <param name="item">The object to locate in the <see cref="JArray"/>.</param>
/// <returns> /// <returns>
/// The index of <paramref name="item"/> if found in the list; otherwise, -1. /// The index of <paramref name="item"/> if found in the list; otherwise, -1.
/// </returns> /// </returns>
@@ -302,25 +302,25 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Inserts an item to the <see cref="T:System.Collections.Generic.IList`1"/> at the specified index. /// Inserts an item to the <see cref="JArray"/> at the specified index.
/// </summary> /// </summary>
/// <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> /// <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
/// <param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1"/>.</param> /// <param name="item">The object to insert into the <see cref="JArray"/>.</param>
/// <exception cref="T:System.ArgumentOutOfRangeException"> /// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception> /// <paramref name="index"/> is not a valid index in the <see cref="JArray"/>.
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception> /// </exception>
public void Insert(int index, JToken item) public void Insert(int index, JToken item)
{ {
InsertItem(index, item, false); InsertItem(index, item, false);
} }
/// <summary> /// <summary>
/// Removes the <see cref="T:System.Collections.Generic.IList`1"/> item at the specified index. /// Removes the <see cref="JArray"/> item at the specified index.
/// </summary> /// </summary>
/// <param name="index">The zero-based index of the item to remove.</param> /// <param name="index">The zero-based index of the item to remove.</param>
/// <exception cref="T:System.ArgumentOutOfRangeException"> /// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception> /// <paramref name="index"/> is not a valid index in the <see cref="JArray"/>.
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception> /// </exception>
public void RemoveAt(int index) public void RemoveAt(int index)
{ {
RemoveItemAt(index); RemoveItemAt(index);
@@ -330,7 +330,7 @@ namespace Newtonsoft.Json.Linq
/// Returns an enumerator that iterates through the collection. /// Returns an enumerator that iterates through the collection.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection. /// A <see cref="IEnumerator{T}"/> of <see cref="JToken"/> that can be used to iterate through the collection.
/// </returns> /// </returns>
public IEnumerator<JToken> GetEnumerator() public IEnumerator<JToken> GetEnumerator()
{ {
@@ -340,30 +340,28 @@ namespace Newtonsoft.Json.Linq
#region ICollection<JToken> Members #region ICollection<JToken> Members
/// <summary> /// <summary>
/// Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1"/>. /// Adds an item to the <see cref="JArray"/>.
/// </summary> /// </summary>
/// <param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> /// <param name="item">The object to add to the <see cref="JArray"/>.</param>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception>
public void Add(JToken item) public void Add(JToken item)
{ {
Add((object)item); Add((object)item);
} }
/// <summary> /// <summary>
/// Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1"/>. /// Removes all items from the <see cref="JArray"/>.
/// </summary> /// </summary>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only. </exception>
public void Clear() public void Clear()
{ {
ClearItems(); ClearItems();
} }
/// <summary> /// <summary>
/// Determines whether the <see cref="T:System.Collections.Generic.ICollection`1"/> contains a specific value. /// Determines whether the <see cref="JArray"/> contains a specific value.
/// </summary> /// </summary>
/// <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> /// <param name="item">The object to locate in the <see cref="JArray"/>.</param>
/// <returns> /// <returns>
/// <c>true</c> if <paramref name="item"/> is found in the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, <c>false</c>. /// <c>true</c> if <paramref name="item"/> is found in the <see cref="JArray"/>; otherwise, <c>false</c>.
/// </returns> /// </returns>
public bool Contains(JToken item) public bool Contains(JToken item)
{ {
@@ -371,7 +369,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Copies to. /// Copies the elements of the <see cref="JArray"/> to an array, starting at a particular array index.
/// </summary> /// </summary>
/// <param name="array">The array.</param> /// <param name="array">The array.</param>
/// <param name="arrayIndex">Index of the array.</param> /// <param name="arrayIndex">Index of the array.</param>
@@ -381,22 +379,21 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only. /// Gets a value indicating whether the <see cref="JArray"/> is read-only.
/// </summary> /// </summary>
/// <returns><c>true</c> if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, <c>false</c>.</returns> /// <returns><c>true</c> if the <see cref="JArray"/> is read-only; otherwise, <c>false</c>.</returns>
public bool IsReadOnly public bool IsReadOnly
{ {
get { return false; } get { return false; }
} }
/// <summary> /// <summary>
/// Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"/>. /// Removes the first occurrence of a specific object from the <see cref="JArray"/>.
/// </summary> /// </summary>
/// <param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> /// <param name="item">The object to remove from the <see cref="JArray"/>.</param>
/// <returns> /// <returns>
/// <c>true</c> if <paramref name="item"/> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, <c>false</c>. This method also returns <c>false</c> if <paramref name="item"/> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"/>. /// <c>true</c> if <paramref name="item"/> was successfully removed from the <see cref="JArray"/>; otherwise, <c>false</c>. This method also returns <c>false</c> if <paramref name="item"/> is not found in the original <see cref="JArray"/>.
/// </returns> /// </returns>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception>
public bool Remove(JToken item) public bool Remove(JToken item)
{ {
return RemoveItem(item); return RemoveItem(item);
+2 -2
View File
@@ -208,7 +208,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Loads an <see cref="JConstructor"/> from a <see cref="JsonReader"/>. /// Loads a <see cref="JConstructor"/> from a <see cref="JsonReader"/>.
/// </summary> /// </summary>
/// <param name="reader">A <see cref="JsonReader"/> that will be read for the content of the <see cref="JConstructor"/>.</param> /// <param name="reader">A <see cref="JsonReader"/> that will be read for the content of the <see cref="JConstructor"/>.</param>
/// <returns>A <see cref="JConstructor"/> that contains the JSON that was read from the specified <see cref="JsonReader"/>.</returns> /// <returns>A <see cref="JConstructor"/> that contains the JSON that was read from the specified <see cref="JsonReader"/>.</returns>
@@ -218,7 +218,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Loads an <see cref="JConstructor"/> from a <see cref="JsonReader"/>. /// Loads a <see cref="JConstructor"/> from a <see cref="JsonReader"/>.
/// </summary> /// </summary>
/// <param name="reader">A <see cref="JsonReader"/> that will be read for the content of the <see cref="JConstructor"/>.</param> /// <param name="reader">A <see cref="JsonReader"/> that will be read for the content of the <see cref="JConstructor"/>.</param>
/// <param name="settings">The <see cref="JsonLoadSettings"/> used to load the JSON. /// <param name="settings">The <see cref="JsonLoadSettings"/> used to load the JSON.
+3 -3
View File
@@ -286,7 +286,7 @@ namespace Newtonsoft.Json.Linq
/// <summary> /// <summary>
/// Returns a collection of the descendant tokens for this token in document order. /// Returns a collection of the descendant tokens for this token in document order.
/// </summary> /// </summary>
/// <returns>An <see cref="IEnumerable{JToken}"/> containing the descendant tokens of the <see cref="JToken"/>.</returns> /// <returns>An <see cref="IEnumerable{T}"/> of <see cref="JToken"/> containing the descendant tokens of the <see cref="JToken"/>.</returns>
public IEnumerable<JToken> Descendants() public IEnumerable<JToken> Descendants()
{ {
return GetDescendants(false); return GetDescendants(false);
@@ -295,7 +295,7 @@ namespace Newtonsoft.Json.Linq
/// <summary> /// <summary>
/// Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. /// Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order.
/// </summary> /// </summary>
/// <returns>An <see cref="IEnumerable{JToken}"/> containing this token, and all the descendant tokens of the <see cref="JToken"/>.</returns> /// <returns>An <see cref="IEnumerable{T}"/> of <see cref="JToken"/> containing this token, and all the descendant tokens of the <see cref="JToken"/>.</returns>
public IEnumerable<JToken> DescendantsAndSelf() public IEnumerable<JToken> DescendantsAndSelf()
{ {
return GetDescendants(true); return GetDescendants(true);
@@ -1026,7 +1026,7 @@ namespace Newtonsoft.Json.Linq
/// <summary> /// <summary>
/// Gets the count of child JSON tokens. /// Gets the count of child JSON tokens.
/// </summary> /// </summary>
/// <value>The count of child JSON tokens</value> /// <value>The count of child JSON tokens.</value>
public int Count public int Count
{ {
get { return ChildrenTokens.Count; } get { return ChildrenTokens.Count; }
+7 -13
View File
@@ -38,7 +38,7 @@ namespace Newtonsoft.Json.Linq
/// <summary> /// <summary>
/// Represents a collection of <see cref="JToken"/> objects. /// Represents a collection of <see cref="JToken"/> objects.
/// </summary> /// </summary>
/// <typeparam name="T">The type of token</typeparam> /// <typeparam name="T">The type of token.</typeparam>
public struct JEnumerable<T> : IJEnumerable<T>, IEquatable<JEnumerable<T>> where T : JToken public struct JEnumerable<T> : IJEnumerable<T>, IEquatable<JEnumerable<T>> where T : JToken
{ {
/// <summary> /// <summary>
@@ -60,10 +60,10 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Returns an enumerator that iterates through the collection. /// Returns an enumerator that can be used to iterate through the collection.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. /// A <see cref="IEnumerator{T}"/> that can be used to iterate through the collection.
/// </returns> /// </returns>
public IEnumerator<T> GetEnumerator() public IEnumerator<T> GetEnumerator()
{ {
@@ -75,19 +75,13 @@ namespace Newtonsoft.Json.Linq
return _enumerable.GetEnumerator(); return _enumerable.GetEnumerator();
} }
/// <summary>
/// Returns an enumerator that iterates through a collection.
/// </summary>
/// <returns>
/// An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
/// </returns>
IEnumerator IEnumerable.GetEnumerator() IEnumerator IEnumerable.GetEnumerator()
{ {
return GetEnumerator(); return GetEnumerator();
} }
/// <summary> /// <summary>
/// Gets the <see cref="IJEnumerable{JToken}"/> with the specified key. /// Gets the <see cref="IJEnumerable{T}"/> of <see cref="JToken"/> with the specified key.
/// </summary> /// </summary>
/// <value></value> /// <value></value>
public IJEnumerable<JToken> this[object key] public IJEnumerable<JToken> this[object key]
@@ -116,11 +110,11 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Determines whether the specified <see cref="System.Object"/> is equal to this instance. /// Determines whether the specified <see cref="Object"/> is equal to this instance.
/// </summary> /// </summary>
/// <param name="obj">The <see cref="System.Object"/> to compare with this instance.</param> /// <param name="obj">The <see cref="Object"/> to compare with this instance.</param>
/// <returns> /// <returns>
/// <c>true</c> if the specified <see cref="System.Object"/> is equal to this instance; otherwise, <c>false</c>. /// <c>true</c> if the specified <see cref="Object"/> is equal to this instance; otherwise, <c>false</c>.
/// </returns> /// </returns>
public override bool Equals(object obj) public override bool Equals(object obj)
{ {
+8 -8
View File
@@ -244,9 +244,9 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Gets an <see cref="IEnumerable{JProperty}"/> of this object's properties. /// Gets an <see cref="IEnumerable{T}"/> of <see cref="JProperty"/> of this object's properties.
/// </summary> /// </summary>
/// <returns>An <see cref="IEnumerable{JProperty}"/> of this object's properties.</returns> /// <returns>An <see cref="IEnumerable{T}"/> of <see cref="JProperty"/> of this object's properties.</returns>
public IEnumerable<JProperty> Properties() public IEnumerable<JProperty> Properties()
{ {
return _properties.Cast<JProperty>(); return _properties.Cast<JProperty>();
@@ -270,9 +270,9 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Gets a <see cref="JEnumerable{JToken}"/> of this object's property values. /// Gets a <see cref="JEnumerable{T}"/> of <see cref="JToken"/> of this object's property values.
/// </summary> /// </summary>
/// <returns>A <see cref="JEnumerable{JToken}"/> of this object's property values.</returns> /// <returns>A <see cref="JEnumerable{T}"/> of <see cref="JToken"/> of this object's property values.</returns>
public JEnumerable<JToken> PropertyValues() public JEnumerable<JToken> PropertyValues()
{ {
return new JEnumerable<JToken>(Properties().Select(p => p.Value)); return new JEnumerable<JToken>(Properties().Select(p => p.Value));
@@ -311,7 +311,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Gets or sets the <see cref="Newtonsoft.Json.Linq.JToken"/> with the specified property name. /// Gets or sets the <see cref="JToken"/> with the specified property name.
/// </summary> /// </summary>
/// <value></value> /// <value></value>
public JToken this[string propertyName] 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. /// Returns an enumerator that can be used to iterate through the collection.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. /// A <see cref="IEnumerator{T}"/> that can be used to iterate through the collection.
/// </returns> /// </returns>
public IEnumerator<KeyValuePair<string, JToken>> GetEnumerator() public IEnumerator<KeyValuePair<string, JToken>> GetEnumerator()
{ {
@@ -792,11 +792,11 @@ namespace Newtonsoft.Json.Linq
#if !(NET35 || NET20 || PORTABLE40) #if !(NET35 || NET20 || PORTABLE40)
/// <summary> /// <summary>
/// Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. /// Returns the <see cref="DynamicMetaObject"/> responsible for binding operations performed on this object.
/// </summary> /// </summary>
/// <param name="parameter">The expression tree representation of the runtime value.</param> /// <param name="parameter">The expression tree representation of the runtime value.</param>
/// <returns> /// <returns>
/// The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. /// The <see cref="DynamicMetaObject"/> to bind this object.
/// </returns> /// </returns>
protected override DynamicMetaObject GetMetaObject(Expression parameter) protected override DynamicMetaObject GetMetaObject(Expression parameter)
{ {
+1 -1
View File
@@ -371,7 +371,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Loads an <see cref="JProperty"/> from a <see cref="JsonReader"/>. /// Loads a <see cref="JProperty"/> from a <see cref="JsonReader"/>.
/// </summary> /// </summary>
/// <param name="reader">A <see cref="JsonReader"/> that will be read for the content of the <see cref="JProperty"/>.</param> /// <param name="reader">A <see cref="JsonReader"/> that will be read for the content of the <see cref="JProperty"/>.</param>
/// <param name="settings">The <see cref="JsonLoadSettings"/> used to load the JSON. /// <param name="settings">The <see cref="JsonLoadSettings"/> used to load the JSON.
@@ -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. /// When overridden in a derived class, gets the type of the component this property is bound to.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A <see cref="T:System.Type"/> that represents the type of component this property is bound to. /// A <see cref="Type"/> that represents the type of component this property is bound to.
/// When the <see cref="M:System.ComponentModel.PropertyDescriptor.GetValue(System.Object)"/> or /// When the <see cref="PropertyDescriptor.GetValue(Object)"/> or
/// <see cref="M:System.ComponentModel.PropertyDescriptor.SetValue(System.Object,System.Object)"/> /// <see cref="PropertyDescriptor.SetValue(Object, Object)"/>
/// methods are invoked, the object specified might be an instance of this type. /// methods are invoked, the object specified might be an instance of this type.
/// </returns> /// </returns>
public override Type ComponentType public override Type ComponentType
@@ -135,7 +135,7 @@ namespace Newtonsoft.Json.Linq
/// When overridden in a derived class, gets the type of the property. /// When overridden in a derived class, gets the type of the property.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A <see cref="T:System.Type"/> that represents the type of the property. /// A <see cref="Type"/> that represents the type of the property.
/// </returns> /// </returns>
public override Type PropertyType public override Type PropertyType
{ {
+64 -64
View File
@@ -429,7 +429,7 @@ namespace Newtonsoft.Json.Linq
/// Returns the JSON for this token using the given formatting and converters. /// Returns the JSON for this token using the given formatting and converters.
/// </summary> /// </summary>
/// <param name="formatting">Indicates how the output should be formatted.</param> /// <param name="formatting">Indicates how the output should be formatted.</param>
/// <param name="converters">A collection of <see cref="JsonConverter"/> which will be used when writing the token.</param> /// <param name="converters">A collection of <see cref="JsonConverter"/>s which will be used when writing the token.</param>
/// <returns>The JSON for this token using the given formatting and converters.</returns> /// <returns>The JSON for this token using the given formatting and converters.</returns>
public string ToString(Formatting formatting, params JsonConverter[] converters) public string ToString(Formatting formatting, params JsonConverter[] converters)
{ {
@@ -529,7 +529,7 @@ namespace Newtonsoft.Json.Linq
#endif #endif
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Boolean}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Boolean"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -557,7 +557,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Int64"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Int64"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -580,7 +580,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{DateTime}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="DateTime"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -609,7 +609,7 @@ namespace Newtonsoft.Json.Linq
#if !NET20 #if !NET20
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{DateTimeOffset}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -643,7 +643,7 @@ namespace Newtonsoft.Json.Linq
#endif #endif
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Decimal}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Decimal"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -671,7 +671,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Double}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Double"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -699,7 +699,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Char}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Char"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -727,7 +727,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Int32"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Int32"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -750,7 +750,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Int16"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Int16"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -773,7 +773,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.UInt16"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="UInt16"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -797,7 +797,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Char"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Char"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -821,7 +821,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Byte"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Byte"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -868,7 +868,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Int32}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Int32"/> .
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -896,7 +896,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Int16}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Int16"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -924,7 +924,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{UInt16}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="UInt16"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -953,7 +953,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Byte}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Byte"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -981,7 +981,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{SByte}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="SByte"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1010,7 +1010,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.DateTime"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="DateTime"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1033,7 +1033,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Int64}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Int64"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1061,7 +1061,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Single}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Single"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1089,7 +1089,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Decimal"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Decimal"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1112,7 +1112,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{UInt32}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="UInt32"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1141,7 +1141,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{UInt64}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="UInt64"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1170,7 +1170,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Double"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Double"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1193,7 +1193,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Single"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Single"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1216,7 +1216,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.String"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="String"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1252,7 +1252,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.UInt32"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="UInt32"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1300,7 +1300,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Byte"/>[]. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Byte"/>[].
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1337,7 +1337,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Guid"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Guid"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1358,7 +1358,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{Guid}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="Guid"/> .
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1389,7 +1389,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.TimeSpan"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="TimeSpan"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1405,7 +1405,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="Nullable{TimeSpan}"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Nullable{T}"/> of <see cref="TimeSpan"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1431,7 +1431,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an explicit conversion from <see cref="Newtonsoft.Json.Linq.JToken"/> to <see cref="System.Uri"/>. /// Performs an explicit conversion from <see cref="JToken"/> to <see cref="Uri"/>.
/// </summary> /// </summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
@@ -1520,7 +1520,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Byte}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Byte"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1541,7 +1541,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{SByte}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="SByte"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1552,7 +1552,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Boolean}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Boolean"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1562,7 +1562,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Int64}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Int64"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1572,7 +1572,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{DateTime}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="DateTime"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1583,7 +1583,7 @@ namespace Newtonsoft.Json.Linq
#if !NET20 #if !NET20
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{DateTimeOffset}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="DateTimeOffset"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1594,7 +1594,7 @@ namespace Newtonsoft.Json.Linq
#endif #endif
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Decimal}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Decimal"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1604,7 +1604,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Double}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Double"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1646,7 +1646,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Int32}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Int32"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1666,7 +1666,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Int64}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Int64"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1676,7 +1676,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Single}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Single"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1696,7 +1696,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Int16}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Int16"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1707,7 +1707,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{UInt16}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="UInt16"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1718,7 +1718,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{UInt32}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="UInt32"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1729,7 +1729,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{UInt64}"/> to <see cref="JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="UInt64"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1792,7 +1792,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Byte"/>[] to <see cref="Newtonsoft.Json.Linq.JToken"/>. /// Performs an implicit conversion from <see cref="Byte"/>[] to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1802,7 +1802,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="T:System.Uri"/> to <see cref="Newtonsoft.Json.Linq.JToken"/>. /// Performs an implicit conversion from <see cref="Uri"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1812,7 +1812,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="T:System.TimeSpan"/> to <see cref="Newtonsoft.Json.Linq.JToken"/>. /// Performs an implicit conversion from <see cref="TimeSpan"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1822,7 +1822,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{TimeSpan}"/> to <see cref="Newtonsoft.Json.Linq.JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="TimeSpan"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1832,7 +1832,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="T:System.Guid"/> to <see cref="Newtonsoft.Json.Linq.JToken"/>. /// Performs an implicit conversion from <see cref="Guid"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1842,7 +1842,7 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Performs an implicit conversion from <see cref="Nullable{Guid}"/> to <see cref="Newtonsoft.Json.Linq.JToken"/>. /// Performs an implicit conversion from <see cref="Nullable{T}"/> of <see cref="Guid"/> to <see cref="JToken"/>.
/// </summary> /// </summary>
/// <param name="value">The value to create a <see cref="JValue"/> from.</param> /// <param name="value">The value to create a <see cref="JValue"/> from.</param>
/// <returns>The <see cref="JValue"/> initialized with the specified value.</returns> /// <returns>The <see cref="JValue"/> initialized with the specified value.</returns>
@@ -1897,7 +1897,7 @@ namespace Newtonsoft.Json.Linq
/// Creates a <see cref="JToken"/> from an object. /// Creates a <see cref="JToken"/> from an object.
/// </summary> /// </summary>
/// <param name="o">The object that will be used to create <see cref="JToken"/>.</param> /// <param name="o">The object that will be used to create <see cref="JToken"/>.</param>
/// <returns>A <see cref="JToken"/> with the value of the specified object</returns> /// <returns>A <see cref="JToken"/> with the value of the specified object.</returns>
public static JToken FromObject(object o) public static JToken FromObject(object o)
{ {
return FromObjectInternal(o, JsonSerializer.CreateDefault()); return FromObjectInternal(o, JsonSerializer.CreateDefault());
@@ -1908,7 +1908,7 @@ namespace Newtonsoft.Json.Linq
/// </summary> /// </summary>
/// <param name="o">The object that will be used to create <see cref="JToken"/>.</param> /// <param name="o">The object that will be used to create <see cref="JToken"/>.</param>
/// <param name="jsonSerializer">The <see cref="JsonSerializer"/> that will be used when reading the object.</param> /// <param name="jsonSerializer">The <see cref="JsonSerializer"/> that will be used when reading the object.</param>
/// <returns>A <see cref="JToken"/> with the value of the specified object</returns> /// <returns>A <see cref="JToken"/> with the value of the specified object.</returns>
public static JToken FromObject(object o, JsonSerializer jsonSerializer) public static JToken FromObject(object o, JsonSerializer jsonSerializer)
{ {
return FromObjectInternal(o, jsonSerializer); return FromObjectInternal(o, jsonSerializer);
@@ -2095,7 +2095,7 @@ namespace Newtonsoft.Json.Linq
/// <param name="settings">The <see cref="JsonLoadSettings"/> used to load the JSON. /// <param name="settings">The <see cref="JsonLoadSettings"/> used to load the JSON.
/// If this is <c>null</c>, default load settings will be used.</param> /// If this is <c>null</c>, default load settings will be used.</param>
/// <returns> /// <returns>
/// An <see cref="JToken"/> that contains the token and its descendant tokens /// A <see cref="JToken"/> that contains the token and its descendant tokens
/// that were read from the reader. The runtime type of the token is determined /// 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. /// by the token type of the first token encountered in the reader.
/// </returns> /// </returns>
@@ -2324,7 +2324,7 @@ namespace Newtonsoft.Json.Linq
/// <param name="path"> /// <param name="path">
/// A <see cref="String"/> that contains a JPath expression. /// A <see cref="String"/> that contains a JPath expression.
/// </param> /// </param>
/// <returns>An <see cref="IEnumerable{JToken}"/> that contains the selected elements.</returns> /// <returns>An <see cref="IEnumerable{T}"/> of <see cref="JToken"/> that contains the selected elements.</returns>
public IEnumerable<JToken> SelectTokens(string path) public IEnumerable<JToken> SelectTokens(string path)
{ {
return SelectTokens(path, false); return SelectTokens(path, false);
@@ -2337,7 +2337,7 @@ namespace Newtonsoft.Json.Linq
/// A <see cref="String"/> that contains a JPath expression. /// A <see cref="String"/> that contains a JPath expression.
/// </param> /// </param>
/// <param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param> /// <param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
/// <returns>An <see cref="IEnumerable{JToken}"/> that contains the selected elements.</returns> /// <returns>An <see cref="IEnumerable{T}"/> of <see cref="JToken"/> that contains the selected elements.</returns>
public IEnumerable<JToken> SelectTokens(string path, bool errorWhenNoMatch) public IEnumerable<JToken> SelectTokens(string path, bool errorWhenNoMatch)
{ {
JPath p = new JPath(path); JPath p = new JPath(path);
@@ -2346,11 +2346,11 @@ namespace Newtonsoft.Json.Linq
#if !(NET35 || NET20 || PORTABLE40) #if !(NET35 || NET20 || PORTABLE40)
/// <summary> /// <summary>
/// Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. /// Returns the <see cref="DynamicMetaObject"/> responsible for binding operations performed on this object.
/// </summary> /// </summary>
/// <param name="parameter">The expression tree representation of the runtime value.</param> /// <param name="parameter">The expression tree representation of the runtime value.</param>
/// <returns> /// <returns>
/// The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. /// The <see cref="DynamicMetaObject"/> to bind this object.
/// </returns> /// </returns>
protected virtual DynamicMetaObject GetMetaObject(Expression parameter) protected virtual DynamicMetaObject GetMetaObject(Expression parameter)
{ {
@@ -2358,11 +2358,11 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. /// Returns the <see cref="DynamicMetaObject"/> responsible for binding operations performed on this object.
/// </summary> /// </summary>
/// <param name="parameter">The expression tree representation of the runtime value.</param> /// <param name="parameter">The expression tree representation of the runtime value.</param>
/// <returns> /// <returns>
/// The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. /// The <see cref="DynamicMetaObject"/> to bind this object.
/// </returns> /// </returns>
DynamicMetaObject IDynamicMetaObjectProvider.GetMetaObject(Expression parameter) DynamicMetaObject IDynamicMetaObjectProvider.GetMetaObject(Expression parameter)
{ {
@@ -48,9 +48,9 @@ namespace Newtonsoft.Json.Linq
/// <summary> /// <summary>
/// Returns a hash code for the specified object. /// Returns a hash code for the specified object.
/// </summary> /// </summary>
/// <param name="obj">The <see cref="T:System.Object"/> for which a hash code is to be returned.</param> /// <param name="obj">The <see cref="System.Object"/> for which a hash code is to be returned.</param>
/// <returns>A hash code for the specified object.</returns> /// <returns>A hash code for the specified object.</returns>
/// <exception cref="T:System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and <paramref name="obj"/> is <c>null</c>.</exception> /// <exception cref="System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and <paramref name="obj"/> is <c>null</c>.</exception>
public int GetHashCode(JToken obj) public int GetHashCode(JToken obj)
{ {
if (obj == null) if (obj == null)
+1 -1
View File
@@ -216,7 +216,7 @@ namespace Newtonsoft.Json.Linq
#region WriteValue methods #region WriteValue methods
/// <summary> /// <summary>
/// Writes a <see cref="Object"/> value. /// Writes a <see cref="Object"/> 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.
/// </summary> /// </summary>
/// <param name="value">The <see cref="Object"/> value to write.</param> /// <param name="value">The <see cref="Object"/> value to write.</param>
public override void WriteValue(object value) public override void WriteValue(object value)
+16 -16
View File
@@ -728,7 +728,7 @@ namespace Newtonsoft.Json.Linq
/// Writes this token to a <see cref="JsonWriter"/>. /// Writes this token to a <see cref="JsonWriter"/>.
/// </summary> /// </summary>
/// <param name="writer">A <see cref="JsonWriter"/> into which this method will write.</param> /// <param name="writer">A <see cref="JsonWriter"/> into which this method will write.</param>
/// <param name="converters">A collection of <see cref="JsonConverter"/> which will be used when writing the token.</param> /// <param name="converters">A collection of <see cref="JsonConverter"/>s which will be used when writing the token.</param>
public override void WriteTo(JsonWriter writer, params JsonConverter[] converters) public override void WriteTo(JsonWriter writer, params JsonConverter[] converters)
{ {
if (converters != null && converters.Length > 0 && _value != null) if (converters != null && converters.Length > 0 && _value != null)
@@ -863,11 +863,11 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>. /// Determines whether the specified <see cref="Object"/> is equal to the current <see cref="Object"/>.
/// </summary> /// </summary>
/// <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param> /// <param name="obj">The <see cref="Object"/> to compare with the current <see cref="Object"/>.</param>
/// <returns> /// <returns>
/// <c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>. /// <c>true</c> if the specified <see cref="Object"/> is equal to the current <see cref="Object"/>; otherwise, <c>false</c>.
/// </returns> /// </returns>
public override bool Equals(object obj) public override bool Equals(object obj)
{ {
@@ -889,7 +889,7 @@ namespace Newtonsoft.Json.Linq
/// Serves as a hash function for a particular type. /// Serves as a hash function for a particular type.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A hash code for the current <see cref="T:System.Object"/>. /// A hash code for the current <see cref="Object"/>.
/// </returns> /// </returns>
public override int GetHashCode() public override int GetHashCode()
{ {
@@ -902,10 +902,10 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Returns a <see cref="System.String"/> that represents this instance. /// Returns a <see cref="String"/> that represents this instance.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A <see cref="System.String"/> that represents this instance. /// A <see cref="String"/> that represents this instance.
/// </returns> /// </returns>
public override string ToString() public override string ToString()
{ {
@@ -918,11 +918,11 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Returns a <see cref="System.String"/> that represents this instance. /// Returns a <see cref="String"/> that represents this instance.
/// </summary> /// </summary>
/// <param name="format">The format.</param> /// <param name="format">The format.</param>
/// <returns> /// <returns>
/// A <see cref="System.String"/> that represents this instance. /// A <see cref="String"/> that represents this instance.
/// </returns> /// </returns>
public string ToString(string format) public string ToString(string format)
{ {
@@ -930,11 +930,11 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Returns a <see cref="System.String"/> that represents this instance. /// Returns a <see cref="String"/> that represents this instance.
/// </summary> /// </summary>
/// <param name="formatProvider">The format provider.</param> /// <param name="formatProvider">The format provider.</param>
/// <returns> /// <returns>
/// A <see cref="System.String"/> that represents this instance. /// A <see cref="String"/> that represents this instance.
/// </returns> /// </returns>
public string ToString(IFormatProvider formatProvider) public string ToString(IFormatProvider formatProvider)
{ {
@@ -942,12 +942,12 @@ namespace Newtonsoft.Json.Linq
} }
/// <summary> /// <summary>
/// Returns a <see cref="System.String"/> that represents this instance. /// Returns a <see cref="String"/> that represents this instance.
/// </summary> /// </summary>
/// <param name="format">The format.</param> /// <param name="format">The format.</param>
/// <param name="formatProvider">The format provider.</param> /// <param name="formatProvider">The format provider.</param>
/// <returns> /// <returns>
/// A <see cref="System.String"/> that represents this instance. /// A <see cref="String"/> that represents this instance.
/// </returns> /// </returns>
public string ToString(string format, IFormatProvider formatProvider) public string ToString(string format, IFormatProvider formatProvider)
{ {
@@ -969,11 +969,11 @@ namespace Newtonsoft.Json.Linq
#if !(NET35 || NET20 || PORTABLE40) #if !(NET35 || NET20 || PORTABLE40)
/// <summary> /// <summary>
/// Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. /// Returns the <see cref="DynamicMetaObject"/> responsible for binding operations performed on this object.
/// </summary> /// </summary>
/// <param name="parameter">The expression tree representation of the runtime value.</param> /// <param name="parameter">The expression tree representation of the runtime value.</param>
/// <returns> /// <returns>
/// The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. /// The <see cref="DynamicMetaObject"/> to bind this object.
/// </returns> /// </returns>
protected override DynamicMetaObject GetMetaObject(Expression parameter) protected override DynamicMetaObject GetMetaObject(Expression parameter)
{ {
@@ -1075,7 +1075,7 @@ namespace Newtonsoft.Json.Linq
/// Greater than zero /// Greater than zero
/// This instance is greater than <paramref name="obj"/>. /// This instance is greater than <paramref name="obj"/>.
/// </returns> /// </returns>
/// <exception cref="T:System.ArgumentException"> /// <exception cref="ArgumentException">
/// <paramref name="obj"/> is not of the same type as this instance. /// <paramref name="obj"/> is not of the same type as this instance.
/// </exception> /// </exception>
public int CompareTo(JValue obj) public int CompareTo(JValue obj)
@@ -31,7 +31,7 @@ namespace Newtonsoft.Json
{ {
/// <summary> /// <summary>
/// Specifies reference handling options for the <see cref="JsonSerializer"/>. /// Specifies reference handling options for the <see cref="JsonSerializer"/>.
/// Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement <c>ISerializable</c>. /// Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement <see cref="T:System.Runtime.Serialization.ISerializable"/>.
/// </summary> /// </summary>
/// <example> /// <example>
/// <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="PreservingObjectReferencesOn" title="Preserve Object References" /> /// <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="PreservingObjectReferencesOn" title="Preserve Object References" />
+7 -7
View File
@@ -121,15 +121,15 @@ namespace Newtonsoft.Json.Schema
public double? Maximum { get; set; } public double? Maximum { get; set; }
/// <summary> /// <summary>
/// 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 <c>minimum</c> attribute (<see cref="JsonSchema.Minimum"/>).
/// </summary> /// </summary>
/// <value>A flag indicating whether the value can not equal the number defined by the "minimum" attribute.</value> /// <value>A flag indicating whether the value can not equal the number defined by the <c>minimum</c> attribute (<see cref="JsonSchema.Minimum"/>).</value>
public bool? ExclusiveMinimum { get; set; } public bool? ExclusiveMinimum { get; set; }
/// <summary> /// <summary>
/// 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 <c>maximum</c> attribute (<see cref="JsonSchema.Maximum"/>).
/// </summary> /// </summary>
/// <value>A flag indicating whether the value can not equal the number defined by the "maximum" attribute.</value> /// <value>A flag indicating whether the value can not equal the number defined by the <c>maximum</c> attribute (<see cref="JsonSchema.Maximum"/>).</value>
public bool? ExclusiveMaximum { get; set; } public bool? ExclusiveMaximum { get; set; }
/// <summary> /// <summary>
@@ -218,7 +218,7 @@ namespace Newtonsoft.Json.Schema
/// <summary> /// <summary>
/// Gets or sets disallowed types. /// Gets or sets disallowed types.
/// </summary> /// </summary>
/// <value>The disallow types.</value> /// <value>The disallowed types.</value>
public JsonSchemaType? Disallow { get; set; } public JsonSchemaType? Disallow { get; set; }
/// <summary> /// <summary>
@@ -337,10 +337,10 @@ namespace Newtonsoft.Json.Schema
} }
/// <summary> /// <summary>
/// Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. /// Returns a <see cref="String"/> that represents the current <see cref="Object"/>.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. /// A <see cref="String"/> that represents the current <see cref="Object"/>.
/// </returns> /// </returns>
public override string ToString() public override string ToString()
{ {
@@ -92,10 +92,10 @@ namespace Newtonsoft.Json.Schema
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="JsonSchemaException"/> class. /// Initializes a new instance of the <see cref="JsonSchemaException"/> class.
/// </summary> /// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception> /// <exception cref="ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception> /// <exception cref="SerializationException">The class name is <c>null</c> or <see cref="Exception.HResult"/> is zero (0).</exception>
public JsonSchemaException(SerializationInfo info, StreamingContext context) public JsonSchemaException(SerializationInfo info, StreamingContext context)
: base(info, context) : base(info, context)
{ {
@@ -1510,7 +1510,7 @@ namespace Newtonsoft.Json.Serialization
} }
// resolve converter for property // 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.Converter = JsonTypeReflector.GetJsonConverter(attributeProvider);
property.MemberConverter = JsonTypeReflector.GetJsonConverter(attributeProvider); property.MemberConverter = JsonTypeReflector.GetJsonConverter(attributeProvider);
@@ -177,8 +177,8 @@ namespace Newtonsoft.Json.Serialization
/// <summary> /// <summary>
/// When overridden in a derived class, controls the binding of a serialized object to a type. /// When overridden in a derived class, controls the binding of a serialized object to a type.
/// </summary> /// </summary>
/// <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param> /// <param name="assemblyName">Specifies the <see cref="Assembly"/> name of the serialized object.</param>
/// <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param> /// <param name="typeName">Specifies the <see cref="System.Type"/> name of the serialized object.</param>
/// <returns> /// <returns>
/// The type of the object the formatter creates a new instance of. /// The type of the object the formatter creates a new instance of.
/// </returns> /// </returns>
@@ -191,8 +191,8 @@ namespace Newtonsoft.Json.Serialization
/// When overridden in a derived class, controls the binding of a serialized object to a type. /// When overridden in a derived class, controls the binding of a serialized object to a type.
/// </summary> /// </summary>
/// <param name="serializedType">The type of the object the formatter creates a new instance of.</param> /// <param name="serializedType">The type of the object the formatter creates a new instance of.</param>
/// <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object. </param> /// <param name="assemblyName">Specifies the <see cref="Assembly"/> name of the serialized object.</param>
/// <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object. </param> /// <param name="typeName">Specifies the <see cref="System.Type"/> name of the serialized object.</param>
public public
#if !(NET35 || NET20) #if !(NET35 || NET20)
override override
@@ -12,8 +12,8 @@ namespace Newtonsoft.Json.Serialization
{ {
/// <summary> /// <summary>
/// Gets the <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer. /// Gets the <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer.
/// For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>, /// For example a filter level of <see cref="TraceLevel.Info"/> will exclude <see cref="TraceLevel.Verbose"/> messages and include <see cref="TraceLevel.Info"/>,
/// <code>Warning</code> and <code>Error</code> messages. /// <see cref="TraceLevel.Warning"/> and <see cref="TraceLevel.Error"/> messages.
/// </summary> /// </summary>
/// <value> /// <value>
/// The <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer. /// The <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer.
@@ -28,7 +28,7 @@ using System;
namespace Newtonsoft.Json.Serialization namespace Newtonsoft.Json.Serialization
{ {
/// <summary> /// <summary>
/// Used by <see cref="JsonSerializer"/> to resolves a <see cref="JsonContract"/> for a given <see cref="Type"/>. /// Used by <see cref="JsonSerializer"/> to resolve a <see cref="JsonContract"/> for a given <see cref="Type"/>.
/// </summary> /// </summary>
/// <example> /// <example>
/// <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverObject" title="IContractResolver Class" /> /// <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverObject" title="IContractResolver Class" />
@@ -35,7 +35,7 @@ namespace Newtonsoft.Json.Serialization
/// </summary> /// </summary>
/// <param name="context">The serialization context.</param> /// <param name="context">The serialization context.</param>
/// <param name="reference">The reference to resolve.</param> /// <param name="reference">The reference to resolve.</param>
/// <returns>The object that</returns> /// <returns>The object that was resolved from the reference.</returns>
object ResolveReference(object context, string reference); object ResolveReference(object context, string reference);
/// <summary> /// <summary>
@@ -11,8 +11,8 @@ namespace Newtonsoft.Json.Serialization
{ {
/// <summary> /// <summary>
/// Gets the <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer. /// Gets the <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer.
/// For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>, /// For example a filter level of <see cref="TraceLevel.Info"/> will exclude <see cref="TraceLevel.Verbose"/> messages and include <see cref="TraceLevel.Info"/>,
/// <code>Warning</code> and <code>Error</code> messages. /// <see cref="TraceLevel.Warning"/> and <see cref="TraceLevel.Error"/> messages.
/// </summary> /// </summary>
/// <value>The <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer.</value> /// <value>The <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer.</value>
TraceLevel LevelFilter { get; } TraceLevel LevelFilter { get; }
@@ -35,9 +35,9 @@ namespace Newtonsoft.Json.Serialization
public class JsonISerializableContract : JsonContainerContract public class JsonISerializableContract : JsonContainerContract
{ {
/// <summary> /// <summary>
/// Gets or sets the ISerializable object constructor. /// Gets or sets the <see cref="ISerializable"/> object constructor.
/// </summary> /// </summary>
/// <value>The ISerializable object constructor.</value> /// <value>The <see cref="ISerializable"/> object constructor.</value>
public ObjectConstructor<object> ISerializableCreator { get; set; } public ObjectConstructor<object> ISerializableCreator { get; set; }
/// <summary> /// <summary>
@@ -59,7 +59,7 @@ namespace Newtonsoft.Json.Serialization
public JsonPropertyCollection Properties { get; private set; } public JsonPropertyCollection Properties { get; private set; }
/// <summary> /// <summary>
/// Gets the constructor parameters required for any non-default constructor /// Gets the constructor parameters required for any non-default constructor.
/// </summary> /// </summary>
[Obsolete("ConstructorParameters is obsolete. Use CreatorParameters instead.")] [Obsolete("ConstructorParameters is obsolete. Use CreatorParameters instead.")]
public JsonPropertyCollection ConstructorParameters public JsonPropertyCollection ConstructorParameters
@@ -68,7 +68,7 @@ namespace Newtonsoft.Json.Serialization
} }
/// <summary> /// <summary>
/// Gets a collection of <see cref="JsonProperty"/> instances that define the parameters used with <see cref="OverrideCreator"/>. /// Gets a collection of <see cref="JsonProperty"/> instances that define the parameters used with <see cref="JsonObjectContract.OverrideCreator"/>.
/// </summary> /// </summary>
public JsonPropertyCollection CreatorParameters public JsonPropertyCollection CreatorParameters
{ {
@@ -85,8 +85,8 @@ namespace Newtonsoft.Json.Serialization
/// <summary> /// <summary>
/// Gets or sets the override constructor used to create the object. /// Gets or sets the override constructor used to create the object.
/// This is set when a constructor is marked up using the /// This is set when a constructor is marked up using
/// JsonConstructor attribute. /// <see cref="JsonConstructorAttribute"/>.
/// </summary> /// </summary>
/// <value>The override constructor.</value> /// <value>The override constructor.</value>
[Obsolete("OverrideConstructor is obsolete. Use OverrideCreator instead.")] [Obsolete("OverrideConstructor is obsolete. Use OverrideCreator instead.")]
@@ -117,7 +117,7 @@ namespace Newtonsoft.Json.Serialization
/// <summary> /// <summary>
/// Gets or sets the function used to create the object. When set this function will override <see cref="JsonContract.DefaultCreator"/>. /// Gets or sets the function used to create the object. When set this function will override <see cref="JsonContract.DefaultCreator"/>.
/// This function is called with a collection of arguments which are defined by the <see cref="CreatorParameters"/> collection. /// This function is called with a collection of arguments which are defined by the <see cref="JsonObjectContract.CreatorParameters"/> collection.
/// </summary> /// </summary>
/// <value>The function used to create the object.</value> /// <value>The function used to create the object.</value>
public ObjectConstructor<object> OverrideCreator public ObjectConstructor<object> OverrideCreator
@@ -113,7 +113,7 @@ namespace Newtonsoft.Json.Serialization
/// <summary> /// <summary>
/// Gets or sets the <see cref="JsonConverter" /> for the property. /// Gets or sets the <see cref="JsonConverter" /> 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.
/// </summary> /// </summary>
/// <value>The converter.</value> /// <value>The converter.</value>
public JsonConverter Converter { get; set; } public JsonConverter Converter { get; set; }
@@ -118,7 +118,7 @@ namespace Newtonsoft.Json.Serialization
/// <summary> /// <summary>
/// Gets the closest matching <see cref="JsonProperty"/> object. /// Gets the closest matching <see cref="JsonProperty"/> object.
/// First attempts to get an exact case match of propertyName and then /// First attempts to get an exact case match of <paramref name="propertyName"/> and then
/// a case insensitive match. /// a case insensitive match.
/// </summary> /// </summary>
/// <param name="propertyName">Name of the property.</param> /// <param name="propertyName">Name of the property.</param>
@@ -173,9 +173,9 @@ namespace Newtonsoft.Json.Serialization
} }
/// <summary> /// <summary>
/// Lookup and create an instance of the JsonConverter type described by the argument. /// Lookup and create an instance of the <see cref="JsonConverter"/> type described by the argument.
/// </summary> /// </summary>
/// <param name="converterType">The JsonConverter type to create.</param> /// <param name="converterType">The <see cref="JsonConverter"/> type to create.</param>
/// <param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter. /// <param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
/// If <c>null</c>, the default constructor is used.</param> /// If <c>null</c>, the default constructor is used.</param>
public static JsonConverter CreateJsonConverterInstance(Type converterType, object[] converterArgs) public static JsonConverter CreateJsonConverterInstance(Type converterType, object[] converterArgs)
@@ -16,8 +16,8 @@ namespace Newtonsoft.Json.Serialization
/// <summary> /// <summary>
/// Gets the <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer. /// Gets the <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer.
/// For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>, /// For example a filter level of <see cref="TraceLevel.Info"/> will exclude <see cref="TraceLevel.Verbose"/> messages and include <see cref="TraceLevel.Info"/>,
/// <code>Warning</code> and <code>Error</code> messages. /// <see cref="TraceLevel.Warning"/> and <see cref="TraceLevel.Error"/> messages.
/// </summary> /// </summary>
/// <value> /// <value>
/// The <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer. /// The <see cref="TraceLevel"/> that will be used to filter the trace messages passed to the writer.
@@ -22,7 +22,7 @@
/// Gets the serialized name for a given property name. /// Gets the serialized name for a given property name.
/// </summary> /// </summary>
/// <param name="name">The initial property name.</param> /// <param name="name">The initial property name.</param>
/// <param name="hasSpecifiedName">A flag indicating whether the property has had a name explicitly specfied.</param> /// <param name="hasSpecifiedName">A flag indicating whether the property has had a name explicitly specified.</param>
/// <returns>The serialized property name.</returns> /// <returns>The serialized property name.</returns>
public virtual string GetPropertyName(string name, bool hasSpecifiedName) public virtual string GetPropertyName(string name, bool hasSpecifiedName)
{ {
@@ -31,12 +31,12 @@ namespace Newtonsoft.Json
public enum TypeNameAssemblyFormatHandling public enum TypeNameAssemblyFormatHandling
{ {
/// <summary> /// <summary>
/// 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 <c>LoadWithPartialName</c> 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 <see cref="T:System.Reflection.Assembly.LoadWithPartialName"/> method is used to load the assembly.
/// </summary> /// </summary>
Simple = 0, Simple = 0,
/// <summary> /// <summary>
/// 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 <c>Load</c> method of the <see cref="System.Reflection.Assembly"/> class is used to load the assembly.
/// </summary> /// </summary>
Full = 1 Full = 1
} }
+5 -5
View File
@@ -32,9 +32,9 @@ namespace Newtonsoft.Json
/// Specifies type name handling options for the <see cref="JsonSerializer"/>. /// Specifies type name handling options for the <see cref="JsonSerializer"/>.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// <see cref="TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source. /// <see cref="JsonSerializer.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source.
/// Incoming types should be validated with a custom <see cref="T:System.Runtime.Serialization.SerializationBinder"/> /// Incoming types should be validated with a custom <see cref="JsonSerializer.SerializationBinder"/>
/// when deserializing with a value other than <c>TypeNameHandling.None</c>. /// when deserializing with a value other than <see cref="TypeNameHandling.None"/>.
/// </remarks> /// </remarks>
[Flags] [Flags]
public enum TypeNameHandling public enum TypeNameHandling
@@ -62,8 +62,8 @@ namespace Newtonsoft.Json
/// <summary> /// <summary>
/// Include the .NET type name when the type of the object being serialized is not the same as its declared type. /// 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 /// 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 <see cref="Newtonsoft.Json.JsonConvert.SerializeObject(object, Type, Newtonsoft.Json.JsonSerializerSettings)"/> /// you must specify a root type object with <see cref="JsonConvert.SerializeObject(object, Type, JsonSerializerSettings)"/>
/// or <see cref="Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter, object, Type)" />. /// or <see cref="JsonSerializer.Serialize(JsonWriter, object, Type)"/>.
/// </summary> /// </summary>
Auto = 4 Auto = 4
} }
@@ -58,7 +58,7 @@ namespace Newtonsoft.Json.Utilities
} }
/// <summary> /// <summary>
/// Adds the elements of the specified collection to the specified generic IList. /// Adds the elements of the specified collection to the specified generic <see cref="IList{T}"/>.
/// </summary> /// </summary>
/// <param name="initial">The list to add to.</param> /// <param name="initial">The list to add to.</param>
/// <param name="collection">The collection of elements to add.</param> /// <param name="collection">The collection of elements to add.</param>
+1 -1
View File
@@ -104,7 +104,7 @@ namespace Newtonsoft.Json.Utilities
} }
/// <summary> /// <summary>
/// Gets a dictionary of the names and values of an Enum type. /// Gets a dictionary of the names and values of an <see cref="Enum"/> type.
/// </summary> /// </summary>
/// <returns></returns> /// <returns></returns>
public static IList<EnumValue<ulong>> GetNamesAndValues<T>() where T : struct public static IList<EnumValue<ulong>> GetNamesAndValues<T>() where T : struct
@@ -79,7 +79,7 @@
/// </summary> /// </summary>
/// <param name="parameters">Method parameters.</param> /// <param name="parameters">Method parameters.</param>
/// <param name="types">Argument types.</param> /// <param name="types">Argument types.</param>
/// <param name="enableParamArray">Try to pack extra arguments into ParamArray.</param> /// <param name="enableParamArray">Try to pack extra arguments into the last parameter when it is marked up with <see cref="ParamArrayAttribute"/>.</param>
/// <returns><c>true</c> if method can be called with given arguments, <c>false</c> otherwise.</returns> /// <returns><c>true</c> if method can be called with given arguments, <c>false</c> otherwise.</returns>
private static bool FilterParameters(ParameterInfo[] parameters, IList<Type> types, bool enableParamArray) private static bool FilterParameters(ParameterInfo[] parameters, IList<Type> types, bool enableParamArray)
{ {
@@ -28,7 +28,7 @@ using System;
namespace Newtonsoft.Json.Utilities namespace Newtonsoft.Json.Utilities
{ {
/// <summary> /// <summary>
/// Builds a string. Unlike StringBuilder this class lets you reuse it's internal buffer. /// Builds a string. Unlike <see cref="System.Text.StringBuilder"/> this class lets you reuse its internal buffer.
/// </summary> /// </summary>
internal struct StringBuffer internal struct StringBuffer
{ {
+4 -4
View File
@@ -34,13 +34,13 @@ namespace Newtonsoft.Json
{ {
/// <summary> /// <summary>
/// An exception has been thrown, which has left the <see cref="JsonWriter"/> in an invalid state. /// An exception has been thrown, which has left the <see cref="JsonWriter"/> in an invalid state.
/// You may call the <see cref="JsonWriter.Close"/> method to put the <see cref="JsonWriter"/> in the <c>Closed</c> state. /// You may call the <see cref="JsonWriter.Close()"/> method to put the <see cref="JsonWriter"/> in the <see cref="JsonWriter.State.Closed"/> state.
/// Any other <see cref="JsonWriter"/> method calls result in an <see cref="InvalidOperationException"/> being thrown. /// Any other <see cref="JsonWriter"/> method calls result in an <see cref="InvalidOperationException"/> being thrown.
/// </summary> /// </summary>
Error = 0, Error = 0,
/// <summary> /// <summary>
/// The <see cref="JsonWriter.Close"/> method has been called. /// The <see cref="JsonWriter.Close()"/> method has been called.
/// </summary> /// </summary>
Closed = 1, Closed = 1,
@@ -50,7 +50,7 @@ namespace Newtonsoft.Json
Object = 2, Object = 2,
/// <summary> /// <summary>
/// A array is being written. /// An array is being written.
/// </summary> /// </summary>
Array = 3, Array = 3,
@@ -65,7 +65,7 @@ namespace Newtonsoft.Json
Property = 5, Property = 5,
/// <summary> /// <summary>
/// A write method has not been called. /// A <see cref="JsonWriter"/> write method has not been called.
/// </summary> /// </summary>
Start = 6 Start = 6
} }