Skip to content

Commit 3292696

Browse files
committed
json serializer extensions documentation
1 parent e2b02f0 commit 3292696

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

src/PartialResponse.AspNetCore.Mvc.Formatters.Json/Internal/JsonSerializerExtensions.cs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,22 @@
77

88
namespace PartialResponse.AspNetCore.Mvc.Formatters.Json.Internal
99
{
10+
/// <summary>
11+
/// Provides a method for serializing objects to JSON.
12+
/// </summary>
13+
/// <remarks>This type supports the <see cref="Fields"/> infrastructure and is not intended to be used directly
14+
/// from your code.</remarks>
1015
public static class JsonSerializerExtensions
1116
{
17+
/// <summary>
18+
/// Serializes the specified <see cref="Object"/> and writes the JSON structure
19+
/// using the specified <see cref="JsonWriter"/>.
20+
/// </summary>
21+
/// <param name="jsonSerializer">The <see cref="JsonSerializer"/> used to serialize the specified <see cref="Object"/>.</param>
22+
/// <param name="jsonWriter">The <see cref="JsonWriter"/> used to write the JSON structure.</param>
23+
/// <param name="value">The <see cref="Object"/> to serialize.</param>
24+
/// <param name="shouldSerialize">A <see cref="Func{string, bool}"/> that is called for every field in the
25+
/// <see cref="Object"/> to serialize, indicating whether the field should be serialized.</param>
1226
public static void Serialize(this JsonSerializer jsonSerializer, JsonWriter jsonWriter, object value, Func<string, bool> shouldSerialize)
1327
{
1428
if (value == null)

0 commit comments

Comments
 (0)