-Fixes to XML documentation

-Sandcastle Help File Builder project added
-Quickstart guides added
This commit is contained in:
JamesNK
2008-05-04 01:26:44 +00:00
parent 3209f09f0f
commit d88e2cf2ca
22 changed files with 1045 additions and 25 deletions
@@ -8,7 +8,7 @@ using Newtonsoft.Json.Utilities;
namespace Newtonsoft.Json.Converters
{
/// <summary>
/// Converts text in the ISO 8601 date format to and from JSON.
/// Converts a <see cref="DateTime"/> to and from the ISO 8601 date format (e.g. 2008-04-12T12:53Z).
/// </summary>
public class IsoDateTimeConverter : JsonConverter
{
@@ -34,7 +34,7 @@ using System.Linq;
namespace Newtonsoft.Json.Converters
{
/// <summary>
/// Converts an XmlNode to and from JSON.
/// Converts an <see cref="XmlNode"/> to and from JSON.
/// </summary>
public class XmlNodeConverter : JsonConverter
{
+1 -1
View File
@@ -203,7 +203,7 @@ namespace Newtonsoft.Json
/// <summary>
/// Reads the next Json token from the stream.
/// </summary>
/// <returns></returns>
/// <returns>true if the next token was read successfully; false if there are no more tokens to read.</returns>
public abstract bool Read();
/// <summary>
+4 -5
View File
@@ -68,7 +68,7 @@ namespace Newtonsoft.Json
}
/// <summary>
/// Get or set how missing members are handled during deserialization.
/// Get or set how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization.
/// </summary>
public MissingMemberHandling MissingMemberHandling
{
@@ -83,7 +83,7 @@ namespace Newtonsoft.Json
}
/// <summary>
/// Get or set how null values are handled.
/// Get or set how null values are handled during serialization and deserialization.
/// </summary>
public NullValueHandling NullValueHandling
{
@@ -98,7 +98,7 @@ namespace Newtonsoft.Json
}
/// <summary>
/// Gets or sets how objects are created.
/// Gets or sets how objects are created during deserialization.
/// </summary>
/// <value>The object creation handling.</value>
public ObjectCreationHandling ObjectCreationHandling
@@ -513,10 +513,9 @@ namespace Newtonsoft.Json
ConstructorInfo c = objectType.GetConstructors(BindingFlags.Public | BindingFlags.Instance).SingleOrDefault();
if (c == null)
throw new Exception("sdsdf");
throw new JsonSerializationException("Could not find a public constructor for type {0}.".FormatWith(CultureInfo.InvariantCulture, objectType));
IDictionary<ParameterInfo, object> constructorParameters = c.GetParameters().ToDictionary(p => p, p => (object)null);
//IList<object> constructorValues
bool exit = false;
while (!exit && reader.Read())
+4 -2
View File
@@ -262,7 +262,9 @@ namespace Newtonsoft.Json
/// <summary>
/// Reads the next Json token from the stream.
/// </summary>
/// <returns></returns>
/// <returns>
/// true if the next token was read successfully; false if there are no more tokens to read.
/// </returns>
public override bool Read()
{
while (true)
@@ -792,7 +794,7 @@ namespace Newtonsoft.Json
}
/// <summary>
/// Changes the <see cref="P:State"/> to Closed.
/// Changes the <see cref="P:CurrentState"/> to Closed.
/// </summary>
public override void Close()
{
+2 -2
View File
@@ -179,11 +179,11 @@ namespace Newtonsoft.Json
throw new JsonWriterException("Invalid JsonToken: " + token);
}
}
/// <summary>
/// Writes the property name of a name/value pair on a Json object.
/// </summary>
/// <param name="name"></param>
/// <param name="name">The name of the property.</param>
public override void WritePropertyName(string name)
{
base.WritePropertyName(name);
+1 -1
View File
@@ -287,7 +287,7 @@ namespace Newtonsoft.Json
/// <summary>
/// Writes the property name of a name/value pair on a Json object.
/// </summary>
/// <param name="name"></param>
/// <param name="name">The name of the property.</param>
public virtual void WritePropertyName(string name)
{
AutoComplete(JsonToken.PropertyName);
+1 -1
View File
@@ -95,7 +95,7 @@ namespace Newtonsoft.Json.Linq
/// <summary>
/// Returns a count of this token's child tokens.
/// </summary>
/// <returns></returns>
/// <returns>A count of this token's child tokens.</returns>
public int Count()
{
return Children().Count();
+2 -2
View File
@@ -172,7 +172,7 @@ namespace Newtonsoft.Json.Linq
/// Creates a <see cref="JValue"/> comment with the given value.
/// </summary>
/// <param name="value">The value.</param>
/// <returns></returns>
/// <returns>A <see cref="JValue"/> comment with the given value.</returns>
public static JValue CreateComment(string value)
{
return new JValue(value, JsonTokenType.Comment);
@@ -182,7 +182,7 @@ namespace Newtonsoft.Json.Linq
/// Creates a <see cref="JValue"/> string with the given value.
/// </summary>
/// <param name="value">The value.</param>
/// <returns></returns>
/// <returns>A <see cref="JValue"/> string with the given value.</returns>
public static JValue CreateString(string value)
{
return new JValue(value, JsonTokenType.String);
+3 -1
View File
@@ -30,7 +30,9 @@ namespace Newtonsoft.Json.Linq
/// <summary>
/// Reads the next Json token from the stream.
/// </summary>
/// <returns></returns>
/// <returns>
/// true if the next token was read successfully; false if there are no more tokens to read.
/// </returns>
public override bool Read()
{
if (CurrentState != State.Start)
+1 -1
View File
@@ -118,7 +118,7 @@ namespace Newtonsoft.Json.Linq
/// <summary>
/// Writes the property name of a name/value pair on a Json object.
/// </summary>
/// <param name="name"></param>
/// <param name="name">The name of the property.</param>
public override void WritePropertyName(string name)
{
base.WritePropertyName(name);