docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
This commit is contained in:
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Observability;
|
||||
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Telemetry guards for the aggregated live alarm cache (plan #10, Task 6): the
|
||||
/// Telemetry guards for the aggregated live alarm cache: the
|
||||
/// active-aggregator observable gauge reflects Started/Stopped, and the reconnect
|
||||
/// counter increments on each recorded reconnect. Mirrors the MeterListener read
|
||||
/// pattern used by <c>SiteStreamGrpcServerTests.SiteStreamSubscribersActiveGauge_*</c>; reads are
|
||||
@@ -19,7 +19,7 @@ namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
|
||||
/// <see cref="ScadaBridgeTelemetry.LiveAlarmAggregatorStarted"/>/
|
||||
/// <see cref="ScadaBridgeTelemetry.LiveAlarmAggregatorStopped"/> from its own
|
||||
/// PreStart/PostStop, so every actor <c>Grpc.SiteAlarmAggregatorActorTests</c> spins up
|
||||
/// moves this exact gauge — serialized into the same collection (row-96 pattern) so the
|
||||
/// moves this exact gauge — serialized into the same collection (the same pattern the other telemetry tests use) so the
|
||||
/// two classes never interleave.
|
||||
/// </remarks>
|
||||
[Collection("SiteAlarmAggregatorGauge")]
|
||||
@@ -61,6 +61,7 @@ public class SiteAlarmLiveCacheTelemetryTests
|
||||
return delta;
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the active aggregator gauge reflects aggregator start and stop.</summary>
|
||||
[Fact]
|
||||
public void ActiveAggregatorGauge_ReflectsStartAndStop()
|
||||
{
|
||||
@@ -92,6 +93,7 @@ public class SiteAlarmLiveCacheTelemetryTests
|
||||
Assert.Equal(baseline, ReadGauge(gauge));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the reconnect counter increments on each recorded reconnect.</summary>
|
||||
[Fact]
|
||||
public void ReconnectCounter_IncrementsOnEachRecordedReconnect()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user