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
@@ -15,6 +15,7 @@ public sealed class WorkerProcessLauncherTests
private const string Nonce = "super-secret-nonce";
/// <summary>Verifies that a valid worker executable starts with correct bootstrap arguments and nonce environment variable.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LaunchAsync_WithValidWorker_StartsProcessWithBootstrapArgumentsAndNonceEnvironment()
{
@@ -49,6 +50,7 @@ public sealed class WorkerProcessLauncherTests
}
/// <summary>Verifies that a failed startup probe kills and disposes the worker process.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LaunchAsync_WhenStartupProbeFails_KillsAndDisposesWorker()
{
@@ -76,6 +78,7 @@ public sealed class WorkerProcessLauncherTests
}
/// <summary>Verifies that transient startup probe failures are retried without respawning the worker process.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LaunchAsync_WhenStartupProbeFailsTransiently_RetriesWithoutRespawningWorker()
{
@@ -103,6 +106,7 @@ public sealed class WorkerProcessLauncherTests
}
/// <summary>Verifies that a startup probe timeout kills and disposes the worker process.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LaunchAsync_WhenStartupTimesOut_KillsAndDisposesWorker()
{
@@ -129,6 +133,7 @@ public sealed class WorkerProcessLauncherTests
}
/// <summary>Verifies that a missing worker executable fails before attempting to start the process.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LaunchAsync_WhenExecutableDoesNotExist_FailsBeforeStartingProcess()
{
@@ -146,6 +151,7 @@ public sealed class WorkerProcessLauncherTests
}
/// <summary>Verifies that a worker executable with mismatched architecture fails before attempting to start.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LaunchAsync_WhenExecutableArchitectureDoesNotMatch_FailsBeforeStartingProcess()
{
@@ -163,6 +169,7 @@ public sealed class WorkerProcessLauncherTests
}
/// <summary>Verifies that a worker that has already exited fails and disposes without additional killing.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task LaunchAsync_WhenWorkerAlreadyExited_FailsAndDisposesWorkerWithoutKill()
{
@@ -308,7 +315,7 @@ public sealed class WorkerProcessLauncherTests
/// <summary>Gets a value indicating whether the Dispose method was called.</summary>
public bool DisposeCalled { get; private set; }
/// <inheritdoc />
/// <summary>Records that the pipe reservation was released.</summary>
public void Dispose()
{
DisposeCalled = true;
@@ -327,6 +334,7 @@ public sealed class WorkerProcessLauncherTests
public string Path { get; }
/// <summary>Creates a new temporary directory for testing.</summary>
/// <returns>The created <see cref="TestDirectory"/> wrapper.</returns>
public static TestDirectory Create()
{
string path = System.IO.Path.Combine(System.IO.Path.GetTempPath(), $"mxgateway-tests-{Guid.NewGuid():N}");
@@ -355,7 +363,7 @@ public sealed class WorkerProcessLauncherTests
return path;
}
/// <inheritdoc />
/// <summary>Deletes the temporary test directory and its contents.</summary>
public void Dispose()
{
Directory.Delete(Path, recursive: true);