dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs(comments): strip internal task/milestone/bundle bookkeeping from code comments

Browse Source 
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
2026-07-07 11:03:26 -04:00
parent 67005ca4c0
commit 9cff87fe85
435 changed files with 2338 additions and 2547 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ZB.MOM.WW.ScadaBridge.NotificationOutbox/Kpi/NotificationOutboxKpiSampleSource.cs
+3 -3
View File
@@ -8,10 +8,10 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Notifications;
namespace ZB.MOM.WW.ScadaBridge.NotificationOutbox.Kpi;
/// <summary>
/// <see cref="IKpiSampleSource"/> for the Notification Outbox (#21): snapshots the same
/// <see cref="IKpiSampleSource"/> for the Notification Outbox: snapshots the same
/// point-in-time delivery KPIs the live Health-dashboard tiles surface — queue depth, stuck
/// count, parked count, delivered-last-interval, and oldest-pending age — at every sampling
/// pass of the central KPI-history recorder (M6 "KPI History &amp; Trends").
/// pass of the central KPI-history recorder ("KPI History &amp; Trends").
/// </summary>
/// <remarks>
/// <para>
@@ -35,7 +35,7 @@ namespace ZB.MOM.WW.ScadaBridge.NotificationOutbox.Kpi;
public sealed class NotificationOutboxKpiSampleSource : IKpiSampleSource
{
// Charted metrics share the public Commons catalog so source + UI trend page key
// off one symbol (#178). The uncharted internal metrics stay private here.
// off one symbol. The uncharted internal metrics stay private here.
private const string MetricQueueDepth = KpiMetrics.NotificationOutbox.QueueDepth;
private const string MetricStuckCount = "stuckCount";
private const string MetricParkedCount = KpiMetrics.NotificationOutbox.ParkedCount;