From dae51ad7aca9398d9d9aa6d48a56a1a9465fb926 Mon Sep 17 00:00:00 2001 From: Victor Nicollet Date: Wed, 8 Apr 2015 11:45:41 +0200 Subject: [PATCH] Document the meaning of "default settings" The term "default settings" did not obviously reference the `JsonConvert.DefaultSettings` global variable (especially to those who were not aware of its existence), and so the actual difference between `Create()` and `CreateDefault()` was unclear. By referencing it explicitly, the code, and therefore its generated documentation, will be clearer. --- Src/Newtonsoft.Json/JsonSerializer.cs | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/Src/Newtonsoft.Json/JsonSerializer.cs b/Src/Newtonsoft.Json/JsonSerializer.cs index c8cb112b..c142cac0 100644 --- a/Src/Newtonsoft.Json/JsonSerializer.cs +++ b/Src/Newtonsoft.Json/JsonSerializer.cs @@ -451,11 +451,13 @@ namespace Newtonsoft.Json /// /// Creates a new instance. - /// The will not use default settings. + /// The will not use default settings + /// from . /// /// /// A new instance. - /// The will not use default settings. + /// The will not use default settings + /// from . /// public static JsonSerializer Create() { @@ -464,12 +466,14 @@ namespace Newtonsoft.Json /// /// Creates a new instance using the specified . - /// The will not use default settings. + /// The will not use default settings + /// from . /// /// The settings to be applied to the . /// /// A new instance using the specified . - /// The will not use default settings. + /// The will not use default settings + /// from . /// public static JsonSerializer Create(JsonSerializerSettings settings) { @@ -483,11 +487,13 @@ namespace Newtonsoft.Json /// /// Creates a new instance. - /// The will use default settings. + /// The will use default settings + /// from . /// /// /// A new instance. - /// The will use default settings. + /// The will use default settings + /// from . /// public static JsonSerializer CreateDefault() { @@ -500,12 +506,14 @@ namespace Newtonsoft.Json /// /// Creates a new instance using the specified . - /// The will use default settings. + /// The will use default settings + /// from . /// /// The settings to be applied to the . /// /// A new instance using the specified . - /// The will use default settings. + /// The will use default settings + /// from . /// public static JsonSerializer CreateDefault(JsonSerializerSettings settings) { @@ -984,4 +992,4 @@ namespace Newtonsoft.Json error(this, e); } } -} \ No newline at end of file +}