Skip to content

Commit 0129d9f

Browse files
Kwok-he-ChuKwok-he-Chu
committed
Added extra documentation in summary
1 parent 3b5a76f commit 0129d9f

File tree

6 files changed

+68
-52
lines changed

6 files changed

+68
-52
lines changed

‎Adyen.Test/Core/Converters/DateTimeNullableJsonConverterTest.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public void Given_NullJson_When_Read_Then_ReturnsNull()
5858
}
5959

6060
[TestMethod]
61-
public void Given_InvalidDateTime_When_Read_Then_ReturnsNull()
61+
public void Given_InvalidDateTime_When_Read_Then_Returns_Null()
6262
{
6363
// Arrange
6464
string json = "\"invalid-datetime\"";

‎Adyen/Core/Converters/ByteArrayConverter.cs‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,18 @@
44

55
namespace Adyen.Core.Converters
66
{
7+
/// <summary>
8+
/// JsonConverter for byte arrays.
9+
/// </summary>
710
public class ByteArrayConverter : JsonConverter<byte[]>
811
{
12+
/// <summary>
13+
/// Reads a byte array during deserialization.
14+
/// </summary>
15+
/// <param name="reader"><see cref="Utf8JsonReader"/>.</param>
16+
/// <param name="typeToConvert"><see cref="Type"/>.</param>
17+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
18+
/// <returns>Byte array.</returns>
919
public override byte[] Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
1020
{
1121
if (reader.TokenType == JsonTokenType.Null)
@@ -15,6 +25,12 @@ public override byte[] Read(ref Utf8JsonReader reader, Type typeToConvert, JsonS
1525
return Encoding.UTF8.GetBytes(value);
1626
}
1727

28+
/// <summary>
29+
/// Writes a byte array during serialization.
30+
/// </summary>
31+
/// <param name="writer"><see cref="Utf8JsonWriter"/>.</param>
32+
/// <param name="value"><see cref="byte[]"/>.</param>
33+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
1834
public override void Write(Utf8JsonWriter writer, byte[] value, JsonSerializerOptions options)
1935
{
2036
if (value == null)

‎Adyen/Core/Converters/DateOnlyJsonConverter.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ namespace Adyen.Core.Converters
1212
public class DateOnlyJsonConverter : JsonConverter<DateOnly>
1313
{
1414
/// <summary>
15-
/// The formats used to deserialize the date
15+
/// The formats used to deserialize the date.
1616
/// </summary>
1717
public static string[] Formats { get; } = {
1818
"yyyy'-'MM'-'dd",
@@ -21,12 +21,12 @@ public class DateOnlyJsonConverter : JsonConverter<DateOnly>
2121
};
2222

2323
/// <summary>
24-
/// Returns a DateOnly from the Json object
24+
/// Returns a <see cref="DateOnly"/> from the Json object.
2525
/// </summary>
26-
/// <param name="reader"></param>
27-
/// <param name="typeToConvert"></param>
28-
/// <param name="options"></param>
29-
/// <returns></returns>
26+
/// <param name="reader"><see cref="Utf8JsonReader"/>.</param>
27+
/// <param name="typeToConvert"><see cref="Type"/>.</param>
28+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
29+
/// <returns><see cref="DateOnly"/>.</returns>
3030
public override DateOnly Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) {
3131
if (reader.TokenType == JsonTokenType.Null)
3232
throw new NotSupportedException();
@@ -41,12 +41,12 @@ public override DateOnly Read(ref Utf8JsonReader reader, Type typeToConvert, Jso
4141
}
4242

4343
/// <summary>
44-
/// Writes the DateOnly to the json writer
44+
/// Writes the <see cref="DateOnly"/> to the <see cref="Utf8JsonWriter"/>.
4545
/// </summary>
46-
/// <param name="writer"></param>
47-
/// <param name="dateOnlyValue"></param>
48-
/// <param name="options"></param>
49-
public override void Write(Utf8JsonWriter writer, DateOnly dateOnlyValue, JsonSerializerOptions options) =>
50-
writer.WriteStringValue(dateOnlyValue.ToString("yyyy'-'MM'-'dd", CultureInfo.InvariantCulture));
46+
/// <param name="writer"><see cref="Utf8JsonWriter"/>.</param>
47+
/// <param name="dateOnly"><see cref="DateOnly"/>.</param>
48+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
49+
public override void Write(Utf8JsonWriter writer, DateOnly dateOnly, JsonSerializerOptions options) =>
50+
writer.WriteStringValue(dateOnly.ToString("yyyy'-'MM'-'dd", CultureInfo.InvariantCulture));
5151
}
5252
}

‎Adyen/Core/Converters/DateOnlyNullableJsonConverter.cs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ namespace Adyen.Core.Converters
1212
public class DateOnlyNullableJsonConverter : JsonConverter<DateOnly?>
1313
{
1414
/// <summary>
15-
/// The formats used to deserialize the date
15+
/// The formats used to deserialize the date.
1616
/// </summary>
1717
public static string[] Formats { get; } = {
1818
"yyyy'-'MM'-'dd",
@@ -21,12 +21,12 @@ public class DateOnlyNullableJsonConverter : JsonConverter<DateOnly?>
2121
};
2222

2323
/// <summary>
24-
/// Returns a DateOnly from the Json object
24+
/// Returns a nullable <see cref="DateOnly"/> from the Json object.
2525
/// </summary>
26-
/// <param name="reader"></param>
27-
/// <param name="typeToConvert"></param>
28-
/// <param name="options"></param>
29-
/// <returns></returns>
26+
/// <param name="reader"><see cref="Utf8JsonReader"/>.</param>
27+
/// <param name="typeToConvert"><see cref="Type"/>.</param>
28+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
29+
/// <returns><see cref="DateOnly"/>.</returns>
3030
public override DateOnly? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) {
3131
if (reader.TokenType == JsonTokenType.Null)
3232
return null;
@@ -41,17 +41,17 @@ public class DateOnlyNullableJsonConverter : JsonConverter<DateOnly?>
4141
}
4242

4343
/// <summary>
44-
/// Writes the DateOnly to the json writer
44+
/// Writes the <see cref="DateOnly"/> to the <see cref="Utf8JsonWriter"/>.
4545
/// </summary>
46-
/// <param name="writer"></param>
47-
/// <param name="dateOnlyValue"></param>
48-
/// <param name="options"></param>
49-
public override void Write(Utf8JsonWriter writer, DateOnly? dateOnlyValue, JsonSerializerOptions options)
46+
/// <param name="writer"><see cref="Utf8JsonWriter"/>.</param>
47+
/// <param name="dateOnly"><see cref="DateOnly"/>.</param>
48+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
49+
public override void Write(Utf8JsonWriter writer, DateOnly? dateOnly, JsonSerializerOptions options)
5050
{
51-
if (dateOnlyValue == null)
51+
if (dateOnly == null)
5252
writer.WriteNullValue();
5353
else
54-
writer.WriteStringValue(dateOnlyValue.Value.ToString("yyyy'-'MM'-'dd", CultureInfo.InvariantCulture));
54+
writer.WriteStringValue(dateOnly.Value.ToString("yyyy'-'MM'-'dd", CultureInfo.InvariantCulture));
5555
}
5656
}
5757
}

‎Adyen/Core/Converters/DateTimeJsonConverter.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ namespace Adyen.Core.Converters
1212
public class DateTimeJsonConverter : JsonConverter<DateTime>
1313
{
1414
/// <summary>
15-
/// The formats used to deserialize the date
15+
/// The formats used to deserialize the date.
1616
/// </summary>
1717
public static string[] Formats { get; } = {
1818
"yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK",
@@ -35,12 +35,12 @@ public class DateTimeJsonConverter : JsonConverter<DateTime>
3535
};
3636

3737
/// <summary>
38-
/// Returns a DateTime from the Json object
38+
/// Returns a <see cref="DateTime"/> from the Json object.
3939
/// </summary>
40-
/// <param name="reader"></param>
41-
/// <param name="typeToConvert"></param>
42-
/// <param name="options"></param>
43-
/// <returns></returns>
40+
/// <param name="reader"><see cref="Utf8JsonReader"/>.</param>
41+
/// <param name="typeToConvert"><see cref="Type"/>.</param>
42+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
43+
/// <returns><see cref="DateTime"/>.</returns>
4444
public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) {
4545
if (reader.TokenType == JsonTokenType.Null)
4646
throw new NotSupportedException();
@@ -55,12 +55,12 @@ public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, Jso
5555
}
5656

5757
/// <summary>
58-
/// Writes the DateTime to the json writer
58+
/// Writes the <see cref="DateTime"/> to the <see cref="Utf8JsonWriter"/>.
5959
/// </summary>
60-
/// <param name="writer"></param>
61-
/// <param name="dateTimeValue"></param>
62-
/// <param name="options"></param>
63-
public override void Write(Utf8JsonWriter writer, DateTime dateTimeValue, JsonSerializerOptions options) =>
64-
writer.WriteStringValue(dateTimeValue.ToString("yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK", CultureInfo.InvariantCulture));
60+
/// <param name="writer"><see cref="Utf8JsonWriter"/>.</param>
61+
/// <param name="dateTime"><see cref="DateTime"/>.</param>
62+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
63+
public override void Write(Utf8JsonWriter writer, DateTime dateTime, JsonSerializerOptions options) =>
64+
writer.WriteStringValue(dateTime.ToString("yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK", CultureInfo.InvariantCulture));
6565
}
6666
}

‎Adyen/Core/Converters/DateTimeNullableJsonConverter.cs‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ namespace Adyen.Core.Converters
1212
public class DateTimeNullableJsonConverter : JsonConverter<DateTime?>
1313
{
1414
/// <summary>
15-
/// The formats used to deserialize the date
15+
/// The formats used to deserialize the date.
1616
/// </summary>
1717
public static string[] Formats { get; } = {
1818
"yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK",
@@ -35,12 +35,12 @@ public class DateTimeNullableJsonConverter : JsonConverter<DateTime?>
3535
};
3636

3737
/// <summary>
38-
/// Returns a DateTime from the Json object
38+
/// Returns a nullable <see cref="DateTime"/> from the Json object.
3939
/// </summary>
40-
/// <param name="reader"></param>
41-
/// <param name="typeToConvert"></param>
42-
/// <param name="options"></param>
43-
/// <returns></returns>
40+
/// <param name="reader"><see cref="Utf8JsonReader"/>.</param>
41+
/// <param name="typeToConvert"><see cref="Type"/>.</param>
42+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
43+
/// <returns><see cref="DateTime"/>.</returns>
4444
public override DateTime? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) {
4545
if (reader.TokenType == JsonTokenType.Null)
4646
return null;
@@ -54,18 +54,18 @@ public class DateTimeNullableJsonConverter : JsonConverter<DateTime?>
5454
return null;
5555
}
5656

57-
/// <summary>
58-
/// Writes the DateTime to the json writer
57+
/// <summary>
58+
/// Writes the <see cref="DateTime"/> to the <see cref="Utf8JsonWriter"/>.
5959
/// </summary>
60-
/// <param name="writer"></param>
61-
/// <param name="dateTimeValue"></param>
62-
/// <param name="options"></param>
63-
public override void Write(Utf8JsonWriter writer, DateTime? dateTimeValue, JsonSerializerOptions options)
60+
/// <param name="writer"><see cref="Utf8JsonWriter"/>.</param>
61+
/// <param name="dateTime"><see cref="DateTime"/>.</param>
62+
/// <param name="options"><see cref="JsonSerializerOptions"/>.</param>
63+
public override void Write(Utf8JsonWriter writer, DateTime? dateTime, JsonSerializerOptions options)
6464
{
65-
if (dateTimeValue == null)
65+
if (dateTime == null)
6666
writer.WriteNullValue();
6767
else
68-
writer.WriteStringValue(dateTimeValue.Value.ToString("yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK", CultureInfo.InvariantCulture));
68+
writer.WriteStringValue(dateTime.Value.ToString("yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffffK", CultureInfo.InvariantCulture));
6969
}
7070
}
7171
}

0 commit comments

Comments
 (0)