Update comments

aws · Nov 19, 2024 · c01a7d9 · c01a7d9
1 parent ec4a1dd
commit c01a7d9
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git 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
 {
+    /// <summary>
+    /// The interface for unmarshalling a json error response.
+    /// </summary>
+    /// <typeparam name="T">The type to unmarshall.</typeparam>
+    /// <typeparam name="TJsonUnmarshallerContext">The json unmarshaller context</typeparam>
     public interface IJsonErrorResponseUnmarshaller<T, TJsonUnmarshallerContext>
     {
         /// <summary>
-        /// 
+        /// The unmarshall method accepts a context, the error response and a StreamingUTf8JsonReader and returns the modeled exception.
         /// </summary>
         /// <param name="context">The JSON Unmarshaller context</param>
         /// <param name="errorResponse">The error response</param>

diff --git 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<T, TJsonUnmarshallerContext>
     {
         /// <summary>
-        /// Given the current position in the JSON stream, extract a T
+        /// Given the current position in the JSON stream, extract a T.
         /// </summary>
         /// <param name="input">The JSON parsing context</param>
         /// <param name="reader">The Utf8JsonReader in the System Text JSON namespace</param>

diff --git 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
-{
+
+    /// <summary>
+    /// Constants used in JSON unmarshalling.
+    /// </summary>
     public static class JsonConstants
     {
         public static ReadOnlySpan<byte> 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
@@ -24,7 +24,7 @@
 namespace Amazon.Runtime.Internal.Transform
 {
     /// <summary>
-    ///    First-pass unmarshaller for all errors
+    /// First-pass unmarshaller for all errors
     /// </summary>
     public class JsonErrorResponseUnmarshaller : IJsonUnmarshaller<ErrorResponse, JsonUnmarshallerContext>
     {