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
@@ -125,7 +125,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
/// <summary>
/// Worker-001 regression: the consumer must own no internal
/// The consumer must own no internal
/// <see cref="Timer"/>. A thread-pool timer calling the
/// apartment-threaded wnwrap COM object off its owning STA can
/// deadlock on cross-apartment marshaling, so the timer field and
@@ -144,7 +144,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
/// <summary>
/// Worker-001 regression: no public constructor may accept a
/// No public constructor may accept a
/// poll-interval parameter. A non-zero poll interval was the only
/// way to arm the off-STA timer; removing the parameter makes the
/// footgun structurally unreachable.
@@ -163,7 +163,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
/// <summary>
/// Worker.Tests-022: pins the "new alarm sighting" branch of
/// Pins the "new alarm sighting" branch of
/// <see cref="WnWrapAlarmConsumer.ComputeTransitions"/>. A GUID
/// that appears in <c>next</c> but not in <c>previous</c> must
/// produce exactly one transition with
@@ -191,7 +191,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
/// <summary>
/// Worker.Tests-022: pins the "state unchanged" branch. A GUID
/// Pins the "state unchanged" branch. A GUID
/// present in both snapshots with identical
/// <see cref="MxAlarmSnapshotRecord.State"/> must produce no
/// transition — a regression that emits a transition every poll
@@ -218,7 +218,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
/// <summary>
/// Worker.Tests-022: pins the "state changed" branch. A GUID
/// Pins the "state changed" branch. A GUID
/// present in both snapshots with a different state must produce
/// one transition carrying the prior state so the proto layer
/// can distinguish e.g. <c>UnackAlm</c>→<c>AckAlm</c>
@@ -247,7 +247,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
/// <summary>
/// Worker.Tests-022: pins the "alarm cleared from the active set"
/// Pins the "alarm cleared from the active set"
/// branch. AVEVA drops cleared alarms from
/// <c>GetXmlCurrentAlarms2</c>'s active set rather than emitting a
/// transition record. A GUID present in
@@ -273,7 +273,7 @@ public sealed class WnWrapAlarmConsumerXmlTests
}
/// <summary>
/// Worker.Tests-022: pins the multi-alarm fan-out. Multiple
/// Pins the multi-alarm fan-out. Multiple
/// simultaneous transitions (new + changed + unchanged + dropped)
/// in one snapshot must produce exactly the changed and new
/// entries — not the unchanged and not the dropped.