From 01f370d1ff7bbf12c7cefc81c2935030ae926dc1 Mon Sep 17 00:00:00 2001 From: stakx Date: Sun, 11 Dec 2016 01:05:16 +0100 Subject: [PATCH] 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". --- Src/Newtonsoft.Json/JsonConvert.cs | 2 +- Src/Newtonsoft.Json/JsonReader.cs | 4 ++-- Src/Newtonsoft.Json/JsonValidatingReader.cs | 2 +- Src/Newtonsoft.Json/JsonWriter.cs | 5 +---- 4 files changed, 5 insertions(+), 8 deletions(-) diff --git a/Src/Newtonsoft.Json/JsonConvert.cs b/Src/Newtonsoft.Json/JsonConvert.cs index 42109a9f..98ed77de 100644 --- a/Src/Newtonsoft.Json/JsonConvert.cs +++ b/Src/Newtonsoft.Json/JsonConvert.cs @@ -46,7 +46,7 @@ using System.Xml.Linq; namespace Newtonsoft.Json { /// - /// Provides methods for converting between Common Language Runtime (CLR) types and JSON types. + /// Provides methods for converting between .NET types and JSON types. /// /// /// diff --git a/Src/Newtonsoft.Json/JsonReader.cs b/Src/Newtonsoft.Json/JsonReader.cs index 00f1827a..13ffcd57 100644 --- a/Src/Newtonsoft.Json/JsonReader.cs +++ b/Src/Newtonsoft.Json/JsonReader.cs @@ -269,7 +269,7 @@ namespace Newtonsoft.Json } /// - /// Gets the Common Language Runtime (CLR) type for the current JSON token. + /// Gets the .NET type for the current JSON token. /// public virtual Type ValueType { @@ -338,7 +338,7 @@ namespace Newtonsoft.Json } /// - /// Initializes a new instance of a -derived class. + /// Initializes a new instance of the class. /// protected JsonReader() { diff --git a/Src/Newtonsoft.Json/JsonValidatingReader.cs b/Src/Newtonsoft.Json/JsonValidatingReader.cs index c8a88966..ecb1b3d4 100644 --- a/Src/Newtonsoft.Json/JsonValidatingReader.cs +++ b/Src/Newtonsoft.Json/JsonValidatingReader.cs @@ -163,7 +163,7 @@ namespace Newtonsoft.Json } /// - /// Gets the Common Language Runtime (CLR) type for the current JSON token. + /// Gets the .NET type for the current JSON token. /// /// public override Type ValueType diff --git a/Src/Newtonsoft.Json/JsonWriter.cs b/Src/Newtonsoft.Json/JsonWriter.cs index b25f75c6..bac433de 100644 --- a/Src/Newtonsoft.Json/JsonWriter.cs +++ b/Src/Newtonsoft.Json/JsonWriter.cs @@ -332,7 +332,7 @@ namespace Newtonsoft.Json } /// - /// Initializes a new instance of a JsonWriter-derived class. + /// Initializes a new instance of the JsonWriter class. /// protected JsonWriter() { @@ -1424,9 +1424,6 @@ namespace Newtonsoft.Json InternalWriteWhitespace(ws); } - /// - /// Releases both unmanaged and managed resources. - /// void IDisposable.Dispose() { Dispose(true);