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
@@ -9,7 +9,7 @@ public sealed class StaComApartmentInitializer : IStaComApartmentInitializer
private const int SOk = 0;
private const int SFalse = 1;
/// <summary>Initializes the COM apartment in single-threaded mode.</summary>
/// <inheritdoc />
public void Initialize()
{
int hresult = CoInitializeEx(IntPtr.Zero, CoInitializeApartmentThreaded);
@@ -19,7 +19,7 @@ public sealed class StaComApartmentInitializer : IStaComApartmentInitializer
}
}
/// <summary>Uninitializes the COM apartment.</summary>
/// <inheritdoc />
public void Uninitialize()
{
CoUninitialize();
@@ -43,6 +43,7 @@ public sealed class StaMessagePump
}
/// <summary>Pumps and dispatches all pending Windows messages, returning the count processed.</summary>
/// <returns>The number of messages pumped and dispatched.</returns>
public int PumpPendingMessages()
{
int pumpedMessages = 0;
@@ -86,6 +86,7 @@ public sealed class StaRuntime : IDisposable
/// wait. Callers must already be on the STA; the method is otherwise
/// safe (PeekMessage simply finds no messages).
/// </summary>
/// <returns>The number of messages pumped.</returns>
public int PumpPendingMessages() => messagePump.PumpPendingMessages();
/// <summary>
@@ -212,9 +213,7 @@ public sealed class StaRuntime : IDisposable
return stopped;
}
/// <summary>
/// Releases resources used by the STA runtime.
/// </summary>
/// <inheritdoc />
public void Dispose()
{
if (disposed)
@@ -41,7 +41,7 @@ internal sealed class StaWorkItem<T> : IStaWorkItem
private TaskCompletionSource<T> Completion { get; }
/// <summary>Cancels the work item before execution begins.</summary>
/// <inheritdoc />
public void CancelBeforeExecution()
{
if (Interlocked.CompareExchange(ref started, 1, 0) == 0)
@@ -51,7 +51,7 @@ internal sealed class StaWorkItem<T> : IStaWorkItem
}
}
/// <summary>Executes the work item command.</summary>
/// <inheritdoc />
public void Execute()
{
if (Interlocked.CompareExchange(ref started, 1, 0) != 0)