From c01a7d9846c456ff0534f3b63ad3d3d8696036e5 Mon Sep 17 00:00:00 2001 From: Peter Song Date: Tue, 19 Nov 2024 14:10:47 -0800 Subject: [PATCH] Update comments --- .../Internal/Transform/IJsonErrorResponseUnmarshaller.cs | 7 ++++++- .../Amazon.Runtime/Internal/Transform/IJsonUnmarshaller.cs | 2 +- .../Amazon.Runtime/Internal/Transform/JsonConstants.cs | 5 ++++- .../Internal/Transform/JsonErrorResponseUnmarshaller.cs | 2 +- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/sdk/src/Core/Amazon.Runtime/Internal/Transform/IJsonErrorResponseUnmarshaller.cs b/sdk/src/Core/Amazon.Runtime/Internal/Transform/IJsonErrorResponseUnmarshaller.cs index e637dd0bc995..bb90c1215e0b 100644 --- a/sdk/src/Core/Amazon.Runtime/Internal/Transform/IJsonErrorResponseUnmarshaller.cs +++ b/sdk/src/Core/Amazon.Runtime/Internal/Transform/IJsonErrorResponseUnmarshaller.cs @@ -7,10 +7,15 @@ namespace Amazon.Runtime.Internal.Transform { + /// + /// The interface for unmarshalling a json error response. + /// + /// The type to unmarshall. + /// The json unmarshaller context public interface IJsonErrorResponseUnmarshaller { /// - /// + /// The unmarshall method accepts a context, the error response and a StreamingUTf8JsonReader and returns the modeled exception. /// /// The JSON Unmarshaller context /// The error response diff --git a/sdk/src/Core/Amazon.Runtime/Internal/Transform/IJsonUnmarshaller.cs b/sdk/src/Core/Amazon.Runtime/Internal/Transform/IJsonUnmarshaller.cs index 8fbc84c117aa..3f86ae309893 100644 --- a/sdk/src/Core/Amazon.Runtime/Internal/Transform/IJsonUnmarshaller.cs +++ b/sdk/src/Core/Amazon.Runtime/Internal/Transform/IJsonUnmarshaller.cs @@ -19,7 +19,7 @@ namespace Amazon.Runtime.Internal.Transform public interface IJsonUnmarshaller { /// - /// Given the current position in the JSON stream, extract a T + /// Given the current position in the JSON stream, extract a T. /// /// The JSON parsing context /// The Utf8JsonReader in the System Text JSON namespace diff --git a/sdk/src/Core/Amazon.Runtime/Internal/Transform/JsonConstants.cs b/sdk/src/Core/Amazon.Runtime/Internal/Transform/JsonConstants.cs index 1d305dc28f11..f1408773cc9e 100644 --- a/sdk/src/Core/Amazon.Runtime/Internal/Transform/JsonConstants.cs +++ b/sdk/src/Core/Amazon.Runtime/Internal/Transform/JsonConstants.cs @@ -17,7 +17,10 @@ using System.Text; namespace Amazon.Runtime.Internal.Transform -{ + + /// + /// Constants used in JSON unmarshalling. + /// public static class JsonConstants { public static ReadOnlySpan Utf8Bom => new byte[] { 0xEF, 0xBB, 0xBF }; diff --git a/sdk/src/Core/Amazon.Runtime/Internal/Transform/JsonErrorResponseUnmarshaller.cs b/sdk/src/Core/Amazon.Runtime/Internal/Transform/JsonErrorResponseUnmarshaller.cs index 94d2d98ef1c6..809a200132c4 100644 --- a/sdk/src/Core/Amazon.Runtime/Internal/Transform/JsonErrorResponseUnmarshaller.cs +++ b/sdk/src/Core/Amazon.Runtime/Internal/Transform/JsonErrorResponseUnmarshaller.cs @@ -24,7 +24,7 @@ namespace Amazon.Runtime.Internal.Transform { /// - /// First-pass unmarshaller for all errors + /// First-pass unmarshaller for all errors /// public class JsonErrorResponseUnmarshaller : IJsonUnmarshaller {