docs: complete XML-doc coverage and strip internal tracking IDs from code comments

Resolve all CommentChecker findings across the gateway server, worker, tests,
and .NET client (314 -> 0 real issues): add missing <returns>/<summary>/<param>
on public and test members, convert Stream/interface overrides to <inheritdoc/>,
and remove internal task/issue tracking IDs (SEC-*, IPC-*, WRK-*, GWC-*, TST-*,
Client.Dotnet-*) from shipped code documentation while preserving the design
rationale prose. Shipped comments should not carry internal bookkeeping, and
complete XML docs keep the analyzer/TreatWarningsAsErrors gate and generated API
docs clean. The 6 remaining flags are heuristic false positives (MD5, UTC-4,
capacity-1, near-1601) left intact so real documentation is not corrupted.

Claude-Session: https://claude.ai/code/session_01DMXXvNuPekkkrTEyPNxEkW

clients/dotnet/ZB.MOM.WW.MxGateway.Client.Tests/MxGatewayClientCliTests.cs

@@ -24,6 +24,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that the version command with --json flag prints JSON protocol versions.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_VersionJson_PrintsJsonProtocolVersions()
     {
@@ -38,6 +39,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that the write command builds a write request and prints JSON reply.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_Write_BuildsWriteCommandAndPrintsJsonReply()
     {
@@ -83,7 +85,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>
-    /// Client.Dotnet-030: <c>advise-supervisory</c> was present in the command
+    /// <c>advise-supervisory</c> was present in the command
     /// dispatch table but absent from <see cref="MxGatewayClientCli"/>'s
     /// <c>IsKnownGatewayCommand</c> guard, so the guard intercepted it first and
     /// returned exit code 2 "Unknown command" before dispatch could run. This
@@ -91,6 +93,7 @@ public sealed class MxGatewayClientCliTests
     /// "Unknown command") and reaches the dispatch handler (exit 0, reply written
     /// to stdout).
     /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_AdviseSupervisory_IsRecognizedAndReachesDispatch()
     {
@@ -130,6 +133,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that error output redacts sensitive API key values.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_ErrorOutput_RedactsApiKey()
     {
@@ -154,12 +158,13 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>
-    /// Client.Dotnet-028: when the API key is sourced from the env var
+    /// When the API key is sourced from the env var
     /// (<c>--api-key-env</c> path, no <c>--api-key</c> flag), the error-redaction
     /// catch block must still resolve and redact the effective key. Regression
     /// guard for the catch block reverting to <c>GetOptional("api-key")</c> only,
     /// which is null on the env-var path and leaves the key unredacted.
     /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_ErrorOutput_RedactsApiKey_WhenSourcedFromEnvironmentVariable()
     {
@@ -196,6 +201,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that stream-events with max-events limit stops output in non-JSON format.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_StreamEvents_WithMaxEventsStopsNonJsonOutput()
     {
@@ -238,6 +244,7 @@ public sealed class MxGatewayClientCliTests
 
 
     /// <summary>Verifies that stream-alarms with --max-events stops output and distinguishes payload cases.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_StreamAlarms_WithMaxEventsStopsAndDistinguishesPayloadCases()
     {
@@ -277,6 +284,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that acknowledge-alarm builds a request and prints the JSON reply.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_AcknowledgeAlarm_BuildsRequestAndPrintsJsonReply()
     {
@@ -319,6 +327,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that smoke command closes opened session when a command fails.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_Smoke_WhenCommandFails_ClosesOpenedSession()
     {
@@ -350,6 +359,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that galaxy-test-connection command prints JSON reply.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_GalaxyTestConnection_PrintsJsonReply()
     {
@@ -380,6 +390,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that galaxy-discover command prints hierarchy summary.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_GalaxyDiscover_PrintsHierarchySummary()
     {
@@ -453,6 +464,7 @@ public sealed class MxGatewayClientCliTests
     /// Verifies galaxy-browse walks root objects and eagerly expands one further
     /// level when --depth 1 is passed, printing an indented tree.
     /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_GalaxyBrowse_TextTreeExpandsToDepth()
     {
@@ -509,6 +521,7 @@ public sealed class MxGatewayClientCliTests
     /// Verifies galaxy-browse --json emits a nested JSON document and forwards
     /// the filter flags onto the BrowseChildren request.
     /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_GalaxyBrowse_JsonForwardsFilters()
     {
@@ -553,6 +566,7 @@ public sealed class MxGatewayClientCliTests
     /// Verifies galaxy-browse --parent fetches exactly one level of children for
     /// the supplied gobject id via a parent-scoped BrowseChildren request.
     /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_GalaxyBrowse_ParentFetchesSingleLevel()
     {
@@ -590,6 +604,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that galaxy-watch command prints text output for deploy events.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_GalaxyWatch_PrintsTextOutputForEvents()
     {
@@ -644,6 +659,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that galaxy-watch with --json emits one JSON object per event.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_GalaxyWatch_JsonEmitsOneObjectPerEvent()
     {
@@ -679,6 +695,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that batch mode dispatches a single version command and emits the EOR sentinel.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_Batch_DispatchesVersionAndWritesEndOfRecord()
     {
@@ -705,6 +722,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>Verifies that batch mode routes per-command errors to stdout as JSON between EOR markers.</summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_Batch_WritesErrorsToStdoutAsJson()
     {
@@ -739,7 +757,7 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>
-    /// Client.Dotnet-018: the README CLI examples for the alarm subcommands at
+    /// The README CLI examples for the alarm subcommands at
     /// `clients/dotnet/README.md` must drive cleanly through the production
     /// CLI argument parser. The previous text used non-existent flags
     /// (`--session-id`, `--max-messages`, `--alarm-reference`) that would
@@ -749,6 +767,7 @@ public sealed class MxGatewayClientCliTests
     /// against exit code 0.
     /// </summary>
     /// <param name="command">The alarm subcommand to validate (e.g. "stream-alarms", "acknowledge-alarm").</param>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Theory]
     [InlineData("stream-alarms")]
     [InlineData("acknowledge-alarm")]
@@ -797,12 +816,13 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>
-    /// Client.Dotnet-019: `BenchReadBulkAsync` previously fell back to
+    /// `BenchReadBulkAsync` previously fell back to
     /// <c>reply.ReturnValue.Int32Value</c> when the register reply had no
     /// typed <c>Register</c> payload, silently driving the rest of the bench
     /// against a zero server handle. The fix must fail loudly with a
     /// descriptive <see cref="MxGatewayException"/>.
     /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_BenchReadBulk_WhenRegisterReplyMissingTypedPayload_FailsLoudly()
     {
@@ -810,9 +830,6 @@ public sealed class MxGatewayClientCliTests
         using var error = new StringWriter();
         FakeCliClient fakeClient = new();
         // Successful protocol + MX status but no typed `Register` payload.
-        // Before the Client.Dotnet-019 fix this silently became serverHandle=0
-        // and the bench proceeded through SubscribeBulk / warmup / steady-state
-        // against an invalid handle, producing a misleading zero-result summary.
         fakeClient.InvokeReplies.Enqueue(new MxCommandReply
         {
             SessionId = "session-fixture",
@@ -847,12 +864,13 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>
-    /// Client.Dotnet-020: the steady-state loop in `BenchReadBulkAsync` had a
+    /// The steady-state loop in `BenchReadBulkAsync` had a
     /// bare `catch { failedCalls++; continue; }` that swallowed
     /// <see cref="OperationCanceledException"/>, so token-driven cancellation
     /// kept spinning until <c>--duration-seconds</c> elapsed. After the fix
     /// the bench must exit promptly when the supplied token cancels.
     /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Fact]
     public async Task RunAsync_BenchReadBulk_WhenSteadyStateLoopReceivesCancellation_ExitsPromptly()
     {
@@ -941,12 +959,13 @@ public sealed class MxGatewayClientCliTests
     }
 
     /// <summary>
-    /// Client.Dotnet-021: both `ReadBulkAsync` and `BenchReadBulkAsync` cast
+    /// Both `ReadBulkAsync` and `BenchReadBulkAsync` cast
     /// the user-supplied <c>--timeout-ms</c> to <see cref="uint"/> without
     /// bounds checking, so a negative value (e.g. <c>-1</c>) silently wraps
     /// to ~49.7 days. The fix must reject negatives with a clear error.
     /// </summary>
     /// <param name="command">The bulk-read subcommand to validate (e.g. "read-bulk", "bench-read-bulk").</param>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     [Theory]
     [InlineData("read-bulk")]
     [InlineData("bench-read-bulk")]
@@ -1109,7 +1128,8 @@ public sealed class MxGatewayClientCliTests
         /// <summary>Optional per-call handler that overrides queue-based behaviour.</summary>
         public Func<MxCommandRequest, CancellationToken, Task<MxCommandReply>>? InvokeHandler { get; init; }
 
-        /// <inheritdoc />
+        /// <summary>Disposes the fake client. No-op; there are no unmanaged resources to release.</summary>
+        /// <returns>A task that represents the asynchronous operation.</returns>
         public ValueTask DisposeAsync()
         {
             return ValueTask.CompletedTask;