docs: strip task-tracking IDs from code comments and fill missing XML docs
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:
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user