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

src/MxGateway.Worker.Tests/MxAccess/MxAccessStaSessionTests.cs

@@ -8,8 +8,14 @@ using MxGateway.Worker.Sta;
 
 namespace MxGateway.Worker.Tests.MxAccess;
 
+/// <summary>
+/// Tests for <see cref="MxAccessStaSession"/>.
+/// </summary>
 public sealed class MxAccessStaSessionTests
 {
+    /// <summary>
+    /// Verifies that StartAsync creates the MXAccess COM object and attaches the event sink on the STA thread.
+    /// </summary>
     [Fact]
     public async Task StartAsync_CreatesComObjectAndAttachesEventSinkOnStaThread()
     {
@@ -31,6 +37,9 @@ public sealed class MxAccessStaSessionTests
         Assert.Equal("session-1", eventSink.SessionId);
     }
 
+    /// <summary>
+    /// Verifies that StartAsync maps creation exceptions with HResult when the factory fails.
+    /// </summary>
     [Fact]
     public async Task StartAsync_WhenFactoryFails_MapsCreationExceptionWithHResult()
     {
@@ -49,6 +58,9 @@ public sealed class MxAccessStaSessionTests
         Assert.Null(eventSink.AttachedObject);
     }
 
+    /// <summary>
+    /// Verifies that Dispose detaches the event sink on the STA thread.
+    /// </summary>
     [Fact]
     public async Task Dispose_DetachesEventSinkOnStaThread()
     {
@@ -71,21 +83,40 @@ public sealed class MxAccessStaSessionTests
             TimeSpan.FromMilliseconds(25));
     }
 
+    /// <summary>
+    /// Fake MXAccess COM object factory for testing.
+    /// </summary>
     private sealed class FakeMxAccessComObjectFactory : IMxAccessComObjectFactory
     {
         private readonly Exception? exception;
 
+        /// <summary>
+        /// Initializes a fake factory that optionally throws an exception.
+        /// </summary>
+        /// <param name="exception">Exception to throw when Create is called; null to succeed.</param>
         public FakeMxAccessComObjectFactory(Exception? exception = null)
         {
             this.exception = exception;
         }
 
+        /// <summary>
+        /// Gets the COM object created by this factory.
+        /// </summary>
         public object CreatedObject { get; } = new();
 
+        /// <summary>
+        /// Gets the managed thread ID when Create was called.
+        /// </summary>
         public int? CreateThreadId { get; private set; }
 
+        /// <summary>
+        /// Gets the apartment state when Create was called.
+        /// </summary>
         public ApartmentState? CreateApartmentState { get; private set; }
 
+        /// <summary>
+        /// Creates the COM object or throws the configured exception.
+        /// </summary>
         public object Create()
         {
             CreateThreadId = Thread.CurrentThread.ManagedThreadId;
@@ -100,16 +131,36 @@ public sealed class MxAccessStaSessionTests
         }
     }
 
+    /// <summary>
+    /// Fake MXAccess event sink for testing.
+    /// </summary>
     private sealed class FakeMxAccessEventSink : IMxAccessEventSink
     {
+        /// <summary>
+        /// Gets the attached MXAccess COM object.
+        /// </summary>
         public object? AttachedObject { get; private set; }
 
+        /// <summary>
+        /// Gets the managed thread ID when Attach was called.
+        /// </summary>
         public int? AttachThreadId { get; private set; }
 
+        /// <summary>
+        /// Gets the managed thread ID when Detach was called.
+        /// </summary>
         public int? DetachThreadId { get; private set; }
 
+        /// <summary>
+        /// Gets the session identifier.
+        /// </summary>
         public string? SessionId { get; private set; }
 
+        /// <summary>
+        /// Attaches the MXAccess COM object and records thread context.
+        /// </summary>
+        /// <param name="mxAccessComObject">MXAccess COM object to attach.</param>
+        /// <param name="sessionId">Identifier of the session.</param>
         public void Attach(
             object mxAccessComObject,
             string sessionId)
@@ -119,6 +170,9 @@ public sealed class MxAccessStaSessionTests
             SessionId = sessionId;
         }
 
+        /// <summary>
+        /// Detaches the MXAccess COM object and records thread context.
+        /// </summary>
         public void Detach()
         {
             DetachThreadId = Thread.CurrentThread.ManagedThreadId;
@@ -126,12 +180,21 @@ public sealed class MxAccessStaSessionTests
         }
     }
 
+    /// <summary>
+    /// Noop STA COM apartment initializer for testing.
+    /// </summary>
     private sealed class NoopComApartmentInitializer : IStaComApartmentInitializer
     {
+        /// <summary>
+        /// Initializes the COM apartment (no-op).
+        /// </summary>
         public void Initialize()
         {
         }
 
+        /// <summary>
+        /// Uninitializes the COM apartment (no-op).
+        /// </summary>
         public void Uninitialize()
         {
         }