Change comments as per @JamesNK's feedback

* Explicitly implemented interfaces don't need comments.

 * Protected constructors of abstract classes should be documented
   like Microsoft does on MSDN.

 * Replace term "Common Language Runtime (CLR) type" with ".NET type".
This commit is contained in:
stakx
2016-12-11 01:19:50 +01:00
parent 3c6b49a3dd
commit 01f370d1ff
4 changed files with 5 additions and 8 deletions
+1 -1
View File
@@ -46,7 +46,7 @@ using System.Xml.Linq;
namespace Newtonsoft.Json namespace Newtonsoft.Json
{ {
/// <summary> /// <summary>
/// Provides methods for converting between Common Language Runtime (CLR) types and JSON types. /// Provides methods for converting between .NET types and JSON types.
/// </summary> /// </summary>
/// <example> /// <example>
/// <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="SerializeObject" title="Serializing and Deserializing JSON with JsonConvert" /> /// <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="SerializeObject" title="Serializing and Deserializing JSON with JsonConvert" />
+2 -2
View File
@@ -269,7 +269,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Gets the Common Language Runtime (CLR) type for the current JSON token. /// Gets the .NET type for the current JSON token.
/// </summary> /// </summary>
public virtual Type ValueType public virtual Type ValueType
{ {
@@ -338,7 +338,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Initializes a new instance of a <see cref="JsonReader"/>-derived class. /// Initializes a new instance of the <see cref="JsonReader"/> class.
/// </summary> /// </summary>
protected JsonReader() protected JsonReader()
{ {
+1 -1
View File
@@ -163,7 +163,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Gets the Common Language Runtime (CLR) type for the current JSON token. /// Gets the .NET type for the current JSON token.
/// </summary> /// </summary>
/// <value></value> /// <value></value>
public override Type ValueType public override Type ValueType
+1 -4
View File
@@ -332,7 +332,7 @@ namespace Newtonsoft.Json
} }
/// <summary> /// <summary>
/// Initializes a new instance of a <c>JsonWriter</c>-derived class. /// Initializes a new instance of the <c>JsonWriter</c> class.
/// </summary> /// </summary>
protected JsonWriter() protected JsonWriter()
{ {
@@ -1424,9 +1424,6 @@ namespace Newtonsoft.Json
InternalWriteWhitespace(ws); InternalWriteWhitespace(ws);
} }
/// <summary>
/// Releases both unmanaged and managed resources.
/// </summary>
void IDisposable.Dispose() void IDisposable.Dispose()
{ {
Dispose(true); Dispose(true);