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:
+5
-1
@@ -1,7 +1,7 @@
|
||||
namespace ZB.MOM.WW.ScadaBridge.HealthMonitoring.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// M2.16 (#30) regression coverage. <see cref="ISiteEventLogger.FailedWriteCount"/>
|
||||
/// Regression coverage. <see cref="ISiteEventLogger.FailedWriteCount"/>
|
||||
/// is a cumulative (point-in-time) counter. A periodic
|
||||
/// <c>SiteEventLogFailureCountReporter</c> hosted service polls the count and
|
||||
/// pushes it into the collector via
|
||||
@@ -15,6 +15,7 @@ public class SiteEventLogWriteFailuresMetricTests
|
||||
{
|
||||
private readonly SiteHealthCollector _collector = new();
|
||||
|
||||
/// <summary>Verifies that a count that was set appears in the collected report.</summary>
|
||||
[Fact]
|
||||
public void Set_Then_CollectReport_IncludesCount()
|
||||
{
|
||||
@@ -25,6 +26,7 @@ public class SiteEventLogWriteFailuresMetricTests
|
||||
Assert.Equal(17L, report.SiteEventLogWriteFailures);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the report payload includes the site event log write failure count, defaulting to zero.</summary>
|
||||
[Fact]
|
||||
public void Report_Payload_Includes_SiteEventLogWriteFailures_AsZeroByDefault()
|
||||
{
|
||||
@@ -33,6 +35,7 @@ public class SiteEventLogWriteFailuresMetricTests
|
||||
Assert.Equal(0L, report.SiteEventLogWriteFailures);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that collecting a report does not reset the site event log write failure count.</summary>
|
||||
[Fact]
|
||||
public void CollectReport_DoesNotReset_SiteEventLogWriteFailures()
|
||||
{
|
||||
@@ -49,6 +52,7 @@ public class SiteEventLogWriteFailuresMetricTests
|
||||
Assert.Equal(42L, second.SiteEventLogWriteFailures);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that setting the count overwrites the previous value.</summary>
|
||||
[Fact]
|
||||
public void Set_Overwrites_Previous_Value()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user