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.
This commit is contained in:
@@ -451,11 +451,13 @@ namespace Newtonsoft.Json
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Creates a new <see cref="JsonSerializer"/> instance.
|
/// Creates a new <see cref="JsonSerializer"/> instance.
|
||||||
/// The <see cref="JsonSerializer"/> will not use default settings.
|
/// The <see cref="JsonSerializer"/> will not use default settings
|
||||||
|
/// from <see cref="JsonConvert.DefaultSettings"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
/// A new <see cref="JsonSerializer"/> instance.
|
/// A new <see cref="JsonSerializer"/> instance.
|
||||||
/// The <see cref="JsonSerializer"/> will not use default settings.
|
/// The <see cref="JsonSerializer"/> will not use default settings
|
||||||
|
/// from <see cref="JsonConvert.DefaultSettings"/>.
|
||||||
/// </returns>
|
/// </returns>
|
||||||
public static JsonSerializer Create()
|
public static JsonSerializer Create()
|
||||||
{
|
{
|
||||||
@@ -464,12 +466,14 @@ namespace Newtonsoft.Json
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Creates a new <see cref="JsonSerializer"/> instance using the specified <see cref="JsonSerializerSettings"/>.
|
/// Creates a new <see cref="JsonSerializer"/> instance using the specified <see cref="JsonSerializerSettings"/>.
|
||||||
/// The <see cref="JsonSerializer"/> will not use default settings.
|
/// The <see cref="JsonSerializer"/> will not use default settings
|
||||||
|
/// from <see cref="JsonConvert.DefaultSettings"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="settings">The settings to be applied to the <see cref="JsonSerializer"/>.</param>
|
/// <param name="settings">The settings to be applied to the <see cref="JsonSerializer"/>.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
/// A new <see cref="JsonSerializer"/> instance using the specified <see cref="JsonSerializerSettings"/>.
|
/// A new <see cref="JsonSerializer"/> instance using the specified <see cref="JsonSerializerSettings"/>.
|
||||||
/// The <see cref="JsonSerializer"/> will not use default settings.
|
/// The <see cref="JsonSerializer"/> will not use default settings
|
||||||
|
/// from <see cref="JsonConvert.DefaultSettings"/>.
|
||||||
/// </returns>
|
/// </returns>
|
||||||
public static JsonSerializer Create(JsonSerializerSettings settings)
|
public static JsonSerializer Create(JsonSerializerSettings settings)
|
||||||
{
|
{
|
||||||
@@ -483,11 +487,13 @@ namespace Newtonsoft.Json
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Creates a new <see cref="JsonSerializer"/> instance.
|
/// Creates a new <see cref="JsonSerializer"/> instance.
|
||||||
/// The <see cref="JsonSerializer"/> will use default settings.
|
/// The <see cref="JsonSerializer"/> will use default settings
|
||||||
|
/// from <see cref="JsonConvert.DefaultSettings"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
/// A new <see cref="JsonSerializer"/> instance.
|
/// A new <see cref="JsonSerializer"/> instance.
|
||||||
/// The <see cref="JsonSerializer"/> will use default settings.
|
/// The <see cref="JsonSerializer"/> will use default settings
|
||||||
|
/// from <see cref="JsonConvert.DefaultSettings"/>.
|
||||||
/// </returns>
|
/// </returns>
|
||||||
public static JsonSerializer CreateDefault()
|
public static JsonSerializer CreateDefault()
|
||||||
{
|
{
|
||||||
@@ -500,12 +506,14 @@ namespace Newtonsoft.Json
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Creates a new <see cref="JsonSerializer"/> instance using the specified <see cref="JsonSerializerSettings"/>.
|
/// Creates a new <see cref="JsonSerializer"/> instance using the specified <see cref="JsonSerializerSettings"/>.
|
||||||
/// The <see cref="JsonSerializer"/> will use default settings.
|
/// The <see cref="JsonSerializer"/> will use default settings
|
||||||
|
/// from <see cref="JsonConvert.DefaultSettings"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="settings">The settings to be applied to the <see cref="JsonSerializer"/>.</param>
|
/// <param name="settings">The settings to be applied to the <see cref="JsonSerializer"/>.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
/// A new <see cref="JsonSerializer"/> instance using the specified <see cref="JsonSerializerSettings"/>.
|
/// A new <see cref="JsonSerializer"/> instance using the specified <see cref="JsonSerializerSettings"/>.
|
||||||
/// The <see cref="JsonSerializer"/> will use default settings.
|
/// The <see cref="JsonSerializer"/> will use default settings
|
||||||
|
/// from <see cref="JsonConvert.DefaultSettings"/>.
|
||||||
/// </returns>
|
/// </returns>
|
||||||
public static JsonSerializer CreateDefault(JsonSerializerSettings settings)
|
public static JsonSerializer CreateDefault(JsonSerializerSettings settings)
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user