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,12 +5,13 @@ using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
|
||||
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests.Protos;
|
||||
|
||||
/// <summary>
|
||||
/// Wire-format round-trip tests for the Audit Log (#23) telemetry proto messages
|
||||
/// Wire-format round-trip tests for the Audit Log telemetry proto messages
|
||||
/// (<see cref="AuditEventDto"/>, <see cref="AuditEventBatch"/>, <see cref="IngestAck"/>).
|
||||
/// Locks the additive contract the site → central audit pipeline depends on.
|
||||
/// </summary>
|
||||
public class AuditEventProtoTests
|
||||
{
|
||||
/// <summary>Verifies that an <c>AuditEventDto</c> round trip preserves all fields.</summary>
|
||||
[Fact]
|
||||
public void AuditEventDto_RoundTrip_PreservesAllFields()
|
||||
{
|
||||
@@ -66,6 +67,7 @@ public class AuditEventProtoTests
|
||||
Assert.Equal(original.Extra, deserialized.Extra);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an unset nullable integer is absent from the wire encoding.</summary>
|
||||
[Fact]
|
||||
public void AuditEventDto_NullableInt_AbsentByDefault_NotIncludedInWire()
|
||||
{
|
||||
@@ -90,6 +92,7 @@ public class AuditEventProtoTests
|
||||
Assert.Null(deserialized.DurationMs);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an empty <c>AuditEventBatch</c> round-trips to an empty event list.</summary>
|
||||
[Fact]
|
||||
public void AuditEventBatch_Empty_RoundTrip_Yields_EmptyEvents()
|
||||
{
|
||||
@@ -102,6 +105,7 @@ public class AuditEventProtoTests
|
||||
Assert.Empty(deserialized.Events);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an <c>IngestAck</c> preserves its accepted event ids.</summary>
|
||||
[Fact]
|
||||
public void IngestAck_PreservesAcceptedEventIds()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user