docs(comments): strip internal task/milestone/bundle bookkeeping from code comments
Remove project bookkeeping citations from shipped code comments across the solution: hyphenated task IDs (WP-14, StoreAndForward-025), milestone/task/ issue refs (M3, Task 4, Audit Log #23, #21), Bundle X task-bundle labels, and C/D/K/S/T phase labels. Comment text only — no code logic, string/log literals, or XML-doc structure changed. Genuine descriptions are preserved (only the citation is stripped), and technical lookalikes are retained (UTF-8, SHA-256, T00:00:00, M365, UTC-5, pre-C4/pre-C5 schema versions). Flagged by the new CommentChecker TaskReferenceInComment / TrackingReferenceInComment checks plus targeted grep passes; full solution builds clean, append-only guard tests pass.
This commit is contained in:
Joseph Doherty
@@ -14,7 +14,7 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Persistence;
|
||||
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Actors;
|
||||
|
||||
/// <summary>
|
||||
/// Task 15: Native Alarm Actor — child of Instance Actor, peer to the computed
|
||||
/// Native Alarm Actor — child of Instance Actor, peer to the computed
|
||||
/// <see cref="AlarmActor"/>. Mirrors a single source binding's native alarms
|
||||
/// read-only: subscribes through the DCL, applies snapshot/live transitions,
|
||||
/// retains active+unacked conditions, persists to site SQLite, and emits an
|
||||
@@ -41,7 +41,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
private readonly IServiceProvider? _serviceProvider;
|
||||
|
||||
/// <summary>
|
||||
/// M1.5: severity at or above which a native-alarm raise is logged as
|
||||
/// Severity at or above which a native-alarm raise is logged as
|
||||
/// <c>Error</c> to the site event log; below it, raises log as <c>Warning</c>.
|
||||
/// Mirrors the 0–1000 condition-severity scale.
|
||||
/// </summary>
|
||||
@@ -66,7 +66,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
/// <param name="nativeKind">Alarm kind to stamp on emitted events (OPC UA vs MxAccess); set by the
|
||||
/// Instance Actor from the connection protocol. Defaults to <see cref="AlarmKind.NativeOpcUa"/>.</param>
|
||||
/// <param name="serviceProvider">Optional DI service provider used to resolve the optional
|
||||
/// <see cref="ISiteEventLogger"/> for M1.5 <c>alarm</c> operational events. Fire-and-forget;
|
||||
/// <see cref="ISiteEventLogger"/> for <c>alarm</c> operational events. Fire-and-forget;
|
||||
/// a logging failure never affects the mirror.</param>
|
||||
public NativeAlarmActor(
|
||||
ResolvedNativeAlarmSource source,
|
||||
@@ -166,7 +166,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
condition, string.Empty, string.Empty, string.Empty, string.Empty, string.Empty,
|
||||
null, row.LastTransitionAt, string.Empty, string.Empty);
|
||||
_alarms[row.SourceReference] = t;
|
||||
// M1.5: rehydration replays last-known state on (re)start — surface it
|
||||
// Rehydration replays last-known state on (re)start — surface it
|
||||
// upward for the DebugView but do NOT re-log it as a fresh operational
|
||||
// event (it is not a live transition).
|
||||
Emit(t, t.Condition, logSiteEvent: false);
|
||||
@@ -205,7 +205,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
{
|
||||
Emit(prior, prior.Condition with { Active = false });
|
||||
PersistDelete(sourceRef);
|
||||
// SiteRuntime-027: this condition is gone for good — tell the parent
|
||||
// This condition is gone for good — tell the parent
|
||||
// to evict its _latestAlarmEvents key so it does not retain a stale
|
||||
// (Normal) entry forever.
|
||||
NotifyParentDropped(sourceRef);
|
||||
@@ -217,7 +217,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
{
|
||||
_alarms[sourceRef] = t;
|
||||
PersistUpsert(t);
|
||||
// M1.5: a snapshot replay is a re-sync of the source's current
|
||||
// A snapshot replay is a re-sync of the source's current
|
||||
// active set on (re)subscribe, NOT a live transition — surface it
|
||||
// upward for the DebugView but do NOT re-log an `alarm` operational
|
||||
// event. Otherwise every DCL reconnect would re-emit an `alarm`
|
||||
@@ -249,7 +249,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
{
|
||||
_alarms.Remove(t.SourceReference);
|
||||
PersistDelete(t.SourceReference);
|
||||
// SiteRuntime-027: evict the parent's _latestAlarmEvents key for the
|
||||
// Evict the parent's _latestAlarmEvents key for the
|
||||
// now-resolved condition so it does not leak.
|
||||
NotifyParentDropped(t.SourceReference);
|
||||
}
|
||||
@@ -303,7 +303,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
{
|
||||
var sourceRef = evicted.SourceReference;
|
||||
|
||||
// SiteRuntime-028: the sibling drop paths (ApplySnapshotSwap, the
|
||||
// The sibling drop paths (ApplySnapshotSwap, the
|
||||
// ApplyLiveTransition retention drop) always emit a return-to-normal
|
||||
// before the condition leaves the mirror. EnforceCap previously dropped
|
||||
// a condition whose last-emitted state could still be Active, with no
|
||||
@@ -319,7 +319,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
|
||||
_alarms.Remove(sourceRef);
|
||||
PersistDelete(sourceRef);
|
||||
// SiteRuntime-027: this condition is gone for good — evict the parent's
|
||||
// This condition is gone for good — evict the parent's
|
||||
// _latestAlarmEvents key so it does not retain a stale entry.
|
||||
NotifyParentDropped(sourceRef);
|
||||
_logger.LogWarning(
|
||||
@@ -329,7 +329,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// SiteRuntime-027: signals the parent Instance Actor that a native condition has
|
||||
/// Signals the parent Instance Actor that a native condition has
|
||||
/// left the mirror for good so it can evict the matching <c>_latestAlarmEvents</c>
|
||||
/// key. Always sent AFTER the condition's final return-to-normal
|
||||
/// <see cref="AlarmStateChanged"/> emit, so the stream still sees the clear.
|
||||
@@ -345,7 +345,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
/// <param name="t">The mirrored transition.</param>
|
||||
/// <param name="condition">The condition state to surface (may differ from <paramref name="t"/>'s
|
||||
/// own condition, e.g. a synthesised return-to-normal on snapshot swap).</param>
|
||||
/// <param name="logSiteEvent">M1.5: when <c>true</c> (live + snapshot transitions), emit an
|
||||
/// <param name="logSiteEvent">When <c>true</c> (live + snapshot transitions), emit an
|
||||
/// <c>alarm</c> operational event. Suppressed for SQLite rehydration so a node restart does not
|
||||
/// re-log every last-known condition.</param>
|
||||
private void Emit(NativeAlarmTransition t, AlarmConditionState condition, bool logSiteEvent = true)
|
||||
@@ -380,7 +380,7 @@ public class NativeAlarmActor : ReceiveActor
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// M1.5: fire-and-forget an <c>alarm</c> operational event mirroring a native
|
||||
/// Fire-and-forget an <c>alarm</c> operational event mirroring a native
|
||||
/// condition transition. An active condition is a raise (severity by the
|
||||
/// condition's severity); an inactive condition is a return-to-normal; an
|
||||
/// acknowledge transition is informational. Resolved optionally and never
|
||||
|
||||
Reference in New Issue
Block a user