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
+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.
/// </summary>
/// <remarks>
/// <see cref="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"/>
/// when deserializing with a value other than <c>TypeNameHandling.None</c>.
/// <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="JsonSerializer.SerializationBinder"/>
/// when deserializing with a value other than <see cref="TypeNameHandling.None"/>.
/// </remarks>
public virtual TypeNameHandling TypeNameHandling
{
@@ -430,7 +430,7 @@ namespace Newtonsoft.Json
}
/// <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>
public virtual DateParseHandling DateParseHandling
{
@@ -448,8 +448,8 @@ namespace Newtonsoft.Json
}
/// <summary>
/// Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
/// <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>,
/// Gets or sets how special floating point numbers, e.g. <see cref="Double.NaN"/>,
/// <see cref="Double.PositiveInfinity"/> and <see cref="Double.NegativeInfinity"/>,
/// are written as JSON text.
/// </summary>
public virtual FloatFormatHandling FloatFormatHandling
@@ -994,7 +994,7 @@ namespace Newtonsoft.Json
/// <summary>
/// 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>
/// <param name="textWriter">The <see cref="TextWriter"/> used to write the JSON structure.</param>
/// <param name="value">The <see cref="Object"/> to serialize.</param>
@@ -1005,13 +1005,13 @@ namespace Newtonsoft.Json
/// <summary>
/// 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>
/// <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="objectType">
/// 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.
/// </param>
public void Serialize(JsonWriter jsonWriter, object value, Type objectType)