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
@@ -8,6 +8,7 @@ namespace ZB.MOM.WW.MxGateway.Worker.Tests.Sta;
public sealed class StaRuntimeTests
{
/// <summary>Verifies that InvokeAsync executes commands on the STA thread.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task InvokeAsync_ExecutesCommandOnStaThread()
{
@@ -35,6 +36,7 @@ public sealed class StaRuntimeTests
/// correct dispatch past an arbitrary millisecond budget, which would be a
/// false failure.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task InvokeAsync_WakesIdlePumpForQueuedCommand()
{
@@ -84,6 +86,7 @@ public sealed class StaRuntimeTests
}
/// <summary>Verifies that InvokeAsync faults the returned task when a command raises an exception without stopping the runtime.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task InvokeAsync_CommandException_FaultsReturnedTaskWithoutStoppingRuntime()
{
@@ -101,14 +104,15 @@ public sealed class StaRuntimeTests
/// <summary>
/// Verifies that InvokeAsync returns a faulted task when called after
/// Shutdown. Worker-016 introduced <see cref="StaRuntimeShutdownException"/>
/// (a dedicated subtype of <see cref="InvalidOperationException"/>) so
/// Shutdown. <see cref="StaRuntimeShutdownException"/> is
/// a dedicated subtype of <see cref="InvalidOperationException"/> so
/// callers — notably <c>MxAccessStaSession.RunAlarmPollLoopAsync</c> —
/// can distinguish the graceful shutdown signal from a vanilla
/// <see cref="InvalidOperationException"/> such as an STA-affinity
/// assertion. The test pins the exact type so a regression that
/// reverts to a plain <c>InvalidOperationException</c> fails here.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task InvokeAsync_AfterShutdown_ReturnsFaultedTask()
{
@@ -164,14 +168,14 @@ public sealed class StaRuntimeTests
/// <summary>The thread ID where Uninitialize was called.</summary>
public int? UninitializeThreadId { get; private set; }
/// <summary>Initializes the COM apartment and records the calling thread.</summary>
/// <inheritdoc />
public void Initialize()
{
InitializeCount++;
InitializeThreadId = Thread.CurrentThread.ManagedThreadId;
}
/// <summary>Uninitializes the COM apartment and records the calling thread.</summary>
/// <inheritdoc />
public void Uninitialize()
{
UninitializeCount++;