Add XML documentation across gateway, worker, and .NET client

src/MxGateway.Tests/Gateway/Workers/WorkerFrameProtocolTests.cs

@@ -10,6 +10,7 @@ public sealed class WorkerFrameProtocolTests
 {
     private const string SessionId = "session-1";
 
+    /// <summary>Verifies that writing and reading a valid envelope round-trips the frame correctly.</summary>
     [Fact]
     public async Task WriteAndReadAsync_WithValidEnvelope_RoundTripsFrame()
     {
@@ -27,6 +28,7 @@ public sealed class WorkerFrameProtocolTests
         Assert.Equal(original, parsed);
     }
 
+    /// <summary>Verifies that reading a frame with partial reads reassembles the frame correctly.</summary>
     [Fact]
     public async Task ReadAsync_WithPartialReads_ReassemblesFrame()
     {
@@ -42,6 +44,7 @@ public sealed class WorkerFrameProtocolTests
         Assert.True(stream.ReadCallCount > 2);
     }
 
+    /// <summary>Verifies that reading a frame with zero length throws a malformed length exception.</summary>
     [Fact]
     public async Task ReadAsync_WithZeroLengthFrame_ThrowsMalformedLength()
     {
@@ -56,6 +59,7 @@ public sealed class WorkerFrameProtocolTests
         Assert.Equal(WorkerFrameProtocolErrorCode.MalformedLength, exception.ErrorCode);
     }
 
+    /// <summary>Verifies that reading a frame with oversized length throws before allocating the payload.</summary>
     [Fact]
     public async Task ReadAsync_WithOversizedLength_ThrowsBeforePayloadAllocation()
     {
@@ -72,6 +76,7 @@ public sealed class WorkerFrameProtocolTests
         Assert.Equal(WorkerFrameProtocolErrorCode.MessageTooLarge, exception.ErrorCode);
     }
 
+    /// <summary>Verifies that reading a frame with wrong protocol version throws a protocol version mismatch exception.</summary>
     [Fact]
     public async Task ReadAsync_WithWrongProtocolVersion_ThrowsProtocolVersionMismatch()
     {
@@ -88,6 +93,7 @@ public sealed class WorkerFrameProtocolTests
         Assert.Equal(WorkerFrameProtocolErrorCode.ProtocolVersionMismatch, exception.ErrorCode);
     }
 
+    /// <summary>Verifies that reading a frame with wrong session ID throws a session mismatch exception.</summary>
     [Fact]
     public async Task ReadAsync_WithWrongSessionId_ThrowsSessionMismatch()
     {
@@ -104,6 +110,7 @@ public sealed class WorkerFrameProtocolTests
         Assert.Equal(WorkerFrameProtocolErrorCode.SessionMismatch, exception.ErrorCode);
     }
 
+    /// <summary>Verifies that reading a frame with malformed payload throws an invalid envelope exception.</summary>
     [Fact]
     public async Task ReadAsync_WithMalformedPayload_ThrowsInvalidEnvelope()
     {
@@ -119,6 +126,7 @@ public sealed class WorkerFrameProtocolTests
         Assert.Equal(WorkerFrameProtocolErrorCode.InvalidEnvelope, exception.ErrorCode);
     }
 
+    /// <summary>Verifies that reading a frame with missing envelope body throws an invalid envelope exception.</summary>
     [Fact]
     public async Task ReadAsync_WithMissingEnvelopeBody_ThrowsInvalidEnvelope()
     {
@@ -135,6 +143,7 @@ public sealed class WorkerFrameProtocolTests
         Assert.Equal(WorkerFrameProtocolErrorCode.InvalidEnvelope, exception.ErrorCode);
     }
 
+    /// <summary>Verifies that writing an oversized envelope throws a message too large exception.</summary>
     [Fact]
     public async Task WriteAsync_WithOversizedEnvelope_ThrowsMessageTooLarge()
     {
@@ -186,6 +195,9 @@ public sealed class WorkerFrameProtocolTests
     {
         private readonly int _chunkSize;
 
+        /// <summary>Initializes a new instance of the <see cref="ChunkedReadStream"/> class with chunked reads.</summary>
+        /// <param name="buffer">The buffer containing data to read.</param>
+        /// <param name="chunkSize">The maximum number of bytes to read per operation.</param>
         public ChunkedReadStream(
             byte[] buffer,
             int chunkSize)
@@ -194,8 +206,10 @@ public sealed class WorkerFrameProtocolTests
             _chunkSize = chunkSize;
         }
 
+        /// <summary>Gets the number of read calls made to the stream.</summary>
         public int ReadCallCount { get; private set; }
 
+        /// <inheritdoc />
         public override ValueTask<int> ReadAsync(
             Memory<byte> buffer,
             CancellationToken cancellationToken = default)