docs(src): add missing XML docs and strip tracking-ID comments

Sweep of 203 source files resolving CommentChecker findings: add
<summary>/<param>/<returns>/<inheritdoc> where missing, and remove
resolved task/issue tracking markers (Tests-NNN, Worker-NNN, Server-NNN,
Task N) from code comments. Comment/doc-only — no logic changes.
Server+Tests build clean under TreatWarningsAsErrors.
This commit is contained in:
Joseph Doherty
2026-07-07 14:09:49 -04:00
parent 8914472706
commit fca978de07
203 changed files with 1834 additions and 1383 deletions
@@ -11,6 +11,7 @@ public sealed class FakeWorkerHarnessTests
private static readonly TimeSpan TestTimeout = TimeSpan.FromSeconds(5);
/// <summary>Verifies that completing startup with hello and ready transitions the client to ready state.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CompleteStartupAsync_WithHelloAndReady_TransitionsClientToReady()
{
@@ -28,6 +29,7 @@ public sealed class FakeWorkerHarnessTests
}
/// <summary>Verifies that a protocol version mismatch during startup fails the client.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task StartAsync_WithProtocolMismatch_FailsStartup()
{
@@ -47,6 +49,7 @@ public sealed class FakeWorkerHarnessTests
}
/// <summary>Verifies that a scripted reply completes a pending command invocation.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task InvokeAsync_WithScriptedReply_CompletesCommand()
{
@@ -69,6 +72,7 @@ public sealed class FakeWorkerHarnessTests
}
/// <summary>Verifies that scripted events are yielded in order through the event stream.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ReadEventsAsync_WithScriptedEvents_YieldsOrderedEvents()
{
@@ -93,6 +97,7 @@ public sealed class FakeWorkerHarnessTests
}
/// <summary>Verifies that a scripted fault from the worker faults the client.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ReadLoop_WithScriptedFault_FaultsClient()
{
@@ -116,6 +121,7 @@ public sealed class FakeWorkerHarnessTests
/// <see cref="ManualTimeProvider"/> so the timestamp advance is deterministic rather
/// than relying on a wall-clock <c>Task.Delay</c> exceeding clock resolution.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SendHeartbeatAsync_UpdatesClientHeartbeatState()
{
@@ -138,6 +144,7 @@ public sealed class FakeWorkerHarnessTests
}
/// <summary>Verifies that a hung worker times out pending command invocations.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task InvokeAsync_WithHungWorker_TimesOutPendingCommand()
{
@@ -159,6 +166,7 @@ public sealed class FakeWorkerHarnessTests
}
/// <summary>Verifies that a malformed frame in the read loop faults the client.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ReadLoop_WithMalformedFrame_FaultsClient()
{
@@ -176,6 +184,7 @@ public sealed class FakeWorkerHarnessTests
}
/// <summary>Verifies that a shutdown acknowledgment from the worker closes the client.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ShutdownAsync_WithShutdownAck_ClosesClient()
{
@@ -196,6 +205,7 @@ public sealed class FakeWorkerHarnessTests
/// Verifies that RespondToControlCommandAsync echoes the Ping message back
/// in the DiagnosticMessage field, matching the real worker's ping reply shape.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RespondToControlCommandAsync_Ping_EchoesMessageInDiagnostic()
{
@@ -220,6 +230,7 @@ public sealed class FakeWorkerHarnessTests
/// Verifies that RespondToControlCommandAsync returns a SessionStateReply
/// with state Ready for a GetSessionState command.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RespondToControlCommandAsync_GetSessionState_ReturnsReadyState()
{
@@ -245,6 +256,7 @@ public sealed class FakeWorkerHarnessTests
/// Verifies that RespondToControlCommandAsync returns a WorkerInfoReply
/// with the fake worker's process ID, version, and MXAccess identifiers.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RespondToControlCommandAsync_GetWorkerInfo_ReturnsFakeWorkerInfo()
{
@@ -273,6 +285,7 @@ public sealed class FakeWorkerHarnessTests
/// Verifies that RespondToControlCommandAsync returns an empty DrainEventsReply
/// for a DrainEvents command (the fake harness has no queued events).
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RespondToControlCommandAsync_DrainEvents_ReturnsEmptyReply()
{
@@ -298,6 +311,7 @@ public sealed class FakeWorkerHarnessTests
/// Verifies that RespondToControlCommandAsync for ShutdownWorker sends an OK
/// reply followed by a WorkerShutdownAck, which closes the client.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RespondToControlCommandAsync_ShutdownWorker_SendsReplyThenAck()
{