docs: strip task-tracking IDs from code comments and fill missing XML docs
ci / nightly-windev (push) Has been skipped
ci / windows-x86 (push) Successful in 1m16s
ci / java (push) Successful in 2m5s
ci / portable (push) Failing after 5m9s

Tracking IDs are review bookkeeping that rots in shipped source; the rationale they tagged is kept. Comment-only change (CommentChecker 458 -> 16 false positives).
This commit is contained in:
Joseph Doherty
2026-10-07 15:34:32 -04:00
parent f2e0861709
commit f40409a688
115 changed files with 549 additions and 411 deletions
@@ -2166,14 +2166,17 @@ public sealed class MxAccessCommandExecutorTests
/// </summary>
private sealed class CompletionCacheEventSink : IMxAccessEventSink, IWriteCompletionCacheProvider
{
/// <inheritdoc />
public MxAccessWriteCompletionCache WriteCompletionCache { get; } = new MxAccessWriteCompletionCache();
/// <inheritdoc />
public void Attach(
object mxAccessComObject,
string sessionId)
{
}
/// <inheritdoc />
public void Detach()
{
}
@@ -239,14 +239,14 @@ public sealed class MxAccessEventMapperTests
}
/// <summary>
/// Verifies the exact-format fast path PERF-20 added in front of the
/// Verifies the exact-format fast path added in front of the
/// general parse chain returns exactly what that chain returned. The
/// cases cover the captured MXAccess shape (which the fast path is meant
/// to catch on a US-shaped host), its zero-padded and second-precision
/// siblings, and strings the derived formats cannot match — an ISO
/// round-trip form, a long-date form, and a day-first European form —
/// which must fall through to the unchanged two-stage chain. The
/// expectation is computed with the pre-PERF-20 chain in this test, so it
/// expectation is computed with the original chain in this test, so it
/// holds on any host culture: the fast path is a shortcut, never a
/// different answer.
/// </summary>
@@ -353,8 +353,8 @@ public sealed class MxAccessEventMapperTests
}
/// <summary>
/// The parse chain exactly as it stood before PERF-20 added the
/// exact-format stage, used as the parity oracle above.
/// The parse chain exactly as it stood before the
/// exact-format stage was added, used as the parity oracle above.
/// </summary>
/// <param name="text">Timestamp string to parse.</param>
/// <param name="utc">The parsed UTC timestamp on success.</param>
@@ -37,8 +37,7 @@ public sealed class MxAccessEventQueueTests
/// <summary>
/// Verifies that Enqueue takes ownership of the passed event instead of
/// cloning it: the dequeued instance is the very reference passed in, and
/// the worker sequence/timestamp are stamped on that same instance
/// (WRK-11).
/// the worker sequence/timestamp are stamped on that same instance.
/// </summary>
[Fact]
public void Enqueue_TakesOwnershipOfPassedEventInstance()
@@ -105,7 +104,7 @@ public sealed class MxAccessEventQueueTests
/// <summary>
/// Verifies the byte-budgeted drain stops before the budget is exceeded, leaves the
/// remainder queued in order, and reports the exact remaining count (WRK-21). Events that
/// remainder queued in order, and reports the exact remaining count. Events that
/// do not fit must never be dequeued — dequeuing them is how the pre-fix drain lost events
/// when the reply frame was rejected.
/// </summary>
@@ -184,7 +183,7 @@ public sealed class MxAccessEventQueueTests
}
/// <summary>
/// The no-loss half of the WRK-21 acceptance criterion, at full scale. Draining the review's
/// The no-loss half of the drain guarantee, at full scale. Draining the review's
/// 10,000 byte-heavy events under a budget that fits only a fraction of them per call must
/// return every event exactly once and in order: the pre-fix drain removed events from the
/// queue before the reply was sized, so a rejected frame destroyed them. This runs at the
@@ -258,7 +257,7 @@ public sealed class MxAccessEventQueueTests
/// Brackets the byte budget's per-event charge to the exact serialized size of the event.
/// The queue measures that size once at enqueue rather than during the drain, so this pins
/// the two ends of the charge against the very instance the queue holds: a budget one byte
/// short must refuse the head (and leave it queued, WRK-21), and a budget of exactly the
/// short must refuse the head (and leave it queued), and a budget of exactly the
/// charge must ship it. An undercharge — sizing the event before Enqueue stamps its worker
/// sequence and timestamp, say — passes the first probe and breaks the frame guarantee; an
/// overcharge of even one byte fails the second. The <c>preStamped</c> case covers an event
@@ -371,7 +370,7 @@ public sealed class MxAccessEventQueueTests
}
/// <summary>
/// The other half of the WRK-21 head guarantee: a head refused for its size is drained
/// The other half of the head guarantee: a head refused for its size is drained
/// unchanged by a later call whose budget fits it. The size the queue charges lives with the
/// event across calls, so a refused attempt must neither consume nor alter it — and the
/// refusal itself is justified by the event's real serialized size.
@@ -527,7 +527,7 @@ public sealed class MxAccessStaSessionTests
}
/// <summary>
/// WRK-27. While the alarm poll's PollOnce is executing on the STA, a heartbeat captured mid-poll
/// While the alarm poll's PollOnce is executing on the STA, a heartbeat captured mid-poll
/// must report <see cref="WorkerRuntimeHeartbeatSnapshot.StaCallInProgress"/> so the watchdog
/// grants the poll the same grace-to-ceiling suppression as a dispatched command; once the poll
/// returns the flag clears. PollOnce is blocked on a gate so the heartbeat can be captured while
@@ -319,7 +319,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
// -------------------------------------------------------------------------
// Truncation cliff (Task 23). GetXmlCurrentAlarms2 caps its reply at
// Truncation cliff. GetXmlCurrentAlarms2 caps its reply at
// maxAlmCnt with no "more available" flag. Before the guard, a capped fetch
// shrank the retained snapshot, and every alarm past the cap vanished from
// SnapshotActiveAlarms — which the gateway's reconcile pass reads as a
@@ -587,7 +587,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
// -------------------------------------------------------------------------
// Single-pass parse parity (Task 23). The per-field SelectSingleNode calls
// Single-pass parse parity. The per-field SelectSingleNode calls
// were replaced by one walk over ChildNodes; these pin the semantics that
// walk has to reproduce.
// -------------------------------------------------------------------------