From 0f4ad7cd4bd420779400183a8674034de135e5b5 Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Sun, 5 May 2013 12:28:21 +1200 Subject: [PATCH] -XML documentation --- .../Properties/AssemblyInfo.cs | 2 +- Src/Newtonsoft.Json/JsonConvert.cs | 61 +++++++++++-------- .../Properties/AssemblyInfo.cs | 2 +- 3 files changed, 37 insertions(+), 28 deletions(-) diff --git a/Src/Newtonsoft.Json.Tests/Properties/AssemblyInfo.cs b/Src/Newtonsoft.Json.Tests/Properties/AssemblyInfo.cs index 4ec3b2b2..872f9349 100644 --- a/Src/Newtonsoft.Json.Tests/Properties/AssemblyInfo.cs +++ b/Src/Newtonsoft.Json.Tests/Properties/AssemblyInfo.cs @@ -75,4 +75,4 @@ using System.Security; // You can specify all the values or you can default the Revision and Build Numbers // by using the '*' as shown below: [assembly: AssemblyVersion("4.5.0.0")] -[assembly: AssemblyFileVersion("5.0.4.16104")] +[assembly: AssemblyFileVersion("5.0.4.16105")] diff --git a/Src/Newtonsoft.Json/JsonConvert.cs b/Src/Newtonsoft.Json/JsonConvert.cs index 8055660e..b5bcee98 100644 --- a/Src/Newtonsoft.Json/JsonConvert.cs +++ b/Src/Newtonsoft.Json/JsonConvert.cs @@ -520,7 +520,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the specified object to a JSON string. + /// Serializes the specified object to a JSON string using formatting. /// /// The object to serialize. /// Indicates how the output is formatted. @@ -544,7 +544,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the specified object to a JSON string using a collection of . + /// Serializes the specified object to a JSON string using formatting and a collection of . /// /// The object to serialize. /// Indicates how the output is formatted. @@ -560,7 +560,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the specified object to a JSON string using a collection of . + /// Serializes the specified object to a JSON string using . /// /// The object to serialize. /// The used to serialize the object. @@ -574,7 +574,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the specified object to a JSON string using a collection of . + /// Serializes the specified object to a JSON string using formatting and . /// /// The object to serialize. /// Indicates how the output is formatted. @@ -589,7 +589,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the specified object to a JSON string using a collection of . + /// Serializes the specified object to a JSON string using a type, formatting and . /// /// The object to serialize. /// Indicates how the output is formatted. @@ -621,7 +621,8 @@ namespace Newtonsoft.Json #if !(NET20 || NET35 || SILVERLIGHT || PORTABLE40) /// - /// Asynchronously serializes the specified object to a JSON string using a collection of . + /// Asynchronously serializes the specified object to a JSON string. + /// Serialization will happen on a new thread. /// /// The object to serialize. /// @@ -633,7 +634,8 @@ namespace Newtonsoft.Json } /// - /// Asynchronously serializes the specified object to a JSON string using a collection of . + /// Asynchronously serializes the specified object to a JSON string using formatting. + /// Serialization will happen on a new thread. /// /// The object to serialize. /// Indicates how the output is formatted. @@ -646,7 +648,8 @@ namespace Newtonsoft.Json } /// - /// Asynchronously serializes the specified object to a JSON string using a collection of . + /// Asynchronously serializes the specified object to a JSON string using formatting and a collection of . + /// Serialization will happen on a new thread. /// /// The object to serialize. /// Indicates how the output is formatted. @@ -674,7 +677,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the JSON to a .NET object. + /// Deserializes the JSON to a .NET object using . /// /// The JSON to deserialize. /// @@ -726,7 +729,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the JSON to the given anonymous type. + /// Deserializes the JSON to the given anonymous type using . /// /// /// The anonymous type to deserialize to. This can't be specified @@ -746,7 +749,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the JSON to the specified .NET type. + /// Deserializes the JSON to the specified .NET type using a collection of . /// /// The type of the object to deserialize to. /// The JSON to deserialize. @@ -758,7 +761,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the JSON to the specified .NET type. + /// Deserializes the JSON to the specified .NET type using . /// /// The type of the object to deserialize to. /// The object to deserialize. @@ -773,7 +776,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the JSON to the specified .NET type. + /// Deserializes the JSON to the specified .NET type using a collection of . /// /// The JSON to deserialize. /// The type of the object to deserialize. @@ -789,7 +792,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the JSON to the specified .NET type. + /// Deserializes the JSON to the specified .NET type using . /// /// The JSON to deserialize. /// The type of the object to deserialize to. @@ -815,6 +818,7 @@ namespace Newtonsoft.Json #if !(NET20 || NET35 || SILVERLIGHT || PORTABLE40) /// /// Asynchronously deserializes the JSON to the specified .NET type. + /// Deserialization will happen on a new thread. /// /// The type of the object to deserialize to. /// The JSON to deserialize. @@ -827,7 +831,8 @@ namespace Newtonsoft.Json } /// - /// Asynchronously deserializes the JSON to the specified .NET type. + /// Asynchronously deserializes the JSON to the specified .NET type using . + /// Deserialization will happen on a new thread. /// /// The type of the object to deserialize to. /// The JSON to deserialize. @@ -845,6 +850,7 @@ namespace Newtonsoft.Json /// /// Asynchronously deserializes the JSON to the specified .NET type. + /// Deserialization will happen on a new thread. /// /// The JSON to deserialize. /// @@ -856,7 +862,8 @@ namespace Newtonsoft.Json } /// - /// Asynchronously deserializes the JSON to the specified .NET type. + /// Asynchronously deserializes the JSON to the specified .NET type using . + /// Deserialization will happen on a new thread. /// /// The JSON to deserialize. /// The type of the object to deserialize to. @@ -885,7 +892,7 @@ namespace Newtonsoft.Json } /// - /// Populates the object with values from the JSON string. + /// Populates the object with values from the JSON string using . /// /// The JSON to populate values from. /// The target object to populate values onto. @@ -909,7 +916,7 @@ namespace Newtonsoft.Json #if !(NET20 || NET35 || SILVERLIGHT || PORTABLE40) /// - /// Asynchronously populates the object with values from the JSON string. + /// Asynchronously populates the object with values from the JSON string using . /// /// The JSON to populate values from. /// The target object to populate values onto. @@ -938,7 +945,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the XML node to a JSON string. + /// Serializes the XML node to a JSON string using formatting. /// /// The node to serialize. /// Indicates how the output is formatted. @@ -951,7 +958,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the XML node to a JSON string. + /// Serializes the XML node to a JSON string using formatting and omits the root object if is true. /// /// The node to serialize. /// Indicates how the output is formatted. @@ -975,7 +982,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the XmlNode from a JSON string nested in a root elment. + /// Deserializes the XmlNode from a JSON string nested in a root elment specified by . /// /// The JSON string. /// The name of the root element to append when deserializing. @@ -986,7 +993,8 @@ namespace Newtonsoft.Json } /// - /// Deserializes the XmlNode from a JSON string nested in a root elment. + /// Deserializes the XmlNode from a JSON string nested in a root elment specified by + /// and writes a .NET array attribute for collections. /// /// The JSON string. /// The name of the root element to append when deserializing. @@ -1017,7 +1025,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the to a JSON string. + /// Serializes the to a JSON string using formatting. /// /// The node to convert to JSON. /// Indicates how the output is formatted. @@ -1028,7 +1036,7 @@ namespace Newtonsoft.Json } /// - /// Serializes the to a JSON string. + /// Serializes the to a JSON string using formatting and omits the root object if is true. /// /// The node to serialize. /// Indicates how the output is formatted. @@ -1052,7 +1060,7 @@ namespace Newtonsoft.Json } /// - /// Deserializes the from a JSON string nested in a root elment. + /// Deserializes the from a JSON string nested in a root elment specified by . /// /// The JSON string. /// The name of the root element to append when deserializing. @@ -1063,7 +1071,8 @@ namespace Newtonsoft.Json } /// - /// Deserializes the from a JSON string nested in a root elment. + /// Deserializes the from a JSON string nested in a root elment specified by + /// and writes a .NET array attribute for collections. /// /// The JSON string. /// The name of the root element to append when deserializing. diff --git a/Src/Newtonsoft.Json/Properties/AssemblyInfo.cs b/Src/Newtonsoft.Json/Properties/AssemblyInfo.cs index 1ae835c1..c4a69234 100644 --- a/Src/Newtonsoft.Json/Properties/AssemblyInfo.cs +++ b/Src/Newtonsoft.Json/Properties/AssemblyInfo.cs @@ -92,6 +92,6 @@ using System.Security; // You can specify all the values or you can default the Revision and Build Numbers // by using the '*' as shown below: [assembly: AssemblyVersion("4.5.0.0")] -[assembly: AssemblyFileVersion("5.0.4.16104")] +[assembly: AssemblyFileVersion("5.0.4.16105")] [assembly: CLSCompliant(true)]