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:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -47,6 +47,9 @@ public class SiteCommandDtoMapperGoldenTests
.SelectMany(kv => Enumerable.Range(0, kv.Value.Length)
.Select(i => new object[] { kv.Key.FullName!, i }));
/// <summary>Verifies the case: round Trips, unchanged.</summary>
/// <param name="typeName">The typeName test input.</param>
/// <param name="sampleIndex">The sampleIndex test input.</param>
[Theory]
[MemberData(nameof(AllSamples))]
public void RoundTrips_Unchanged(string typeName, int sampleIndex)
@@ -133,6 +136,7 @@ public class SiteCommandDtoMapperGoldenTests
/// declared in the four multi-command request envelopes. A new proto case
/// with no producing command fails here.
/// </summary>
/// <param name="envelopeName">The name of the request envelope under test.</param>
[Theory]
[MemberData(nameof(RequestEnvelopes))]
public void EveryRequestOneofCase_IsProducedByACommand(string envelopeName)
@@ -152,6 +156,7 @@ public class SiteCommandDtoMapperGoldenTests
}
/// <summary>The reply-envelope mirror of <see cref="EveryRequestOneofCase_IsProducedByACommand"/>.</summary>
/// <param name="envelopeName">The name of the reply envelope under test.</param>
[Theory]
[MemberData(nameof(ReplyEnvelopes))]
public void EveryReplyOneofCase_IsProducedByAReply(string envelopeName)
@@ -232,6 +237,8 @@ public class SiteCommandDtoMapperGoldenTests
// Enum exhaustiveness
// ─────────────────────────────────────────────────────────────────────
/// <summary>Verifies the case: deployment Status, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(DeploymentStatus.Pending)]
[InlineData(DeploymentStatus.InProgress)]
@@ -240,6 +247,8 @@ public class SiteCommandDtoMapperGoldenTests
public void DeploymentStatus_RoundTrips(DeploymentStatus value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: browse Node Class, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(BrowseNodeClass.Object)]
[InlineData(BrowseNodeClass.Variable)]
@@ -248,6 +257,8 @@ public class SiteCommandDtoMapperGoldenTests
public void BrowseNodeClass_RoundTrips(BrowseNodeClass value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: browse Failure Kind, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(BrowseFailureKind.ConnectionNotFound)]
[InlineData(BrowseFailureKind.ConnectionNotConnected)]
@@ -257,6 +268,8 @@ public class SiteCommandDtoMapperGoldenTests
public void BrowseFailureKind_RoundTrips(BrowseFailureKind value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: read Tag Values Failure Kind, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(ReadTagValuesFailureKind.ConnectionNotFound)]
[InlineData(ReadTagValuesFailureKind.ConnectionNotConnected)]
@@ -265,6 +278,8 @@ public class SiteCommandDtoMapperGoldenTests
public void ReadTagValuesFailureKind_RoundTrips(ReadTagValuesFailureKind value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: verify Failure Kind, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(VerifyFailureKind.Unreachable)]
[InlineData(VerifyFailureKind.AuthFailed)]
@@ -274,6 +289,8 @@ public class SiteCommandDtoMapperGoldenTests
public void VerifyFailureKind_RoundTrips(VerifyFailureKind value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: store And Forward Category, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(StoreAndForwardCategory.ExternalSystem)]
[InlineData(StoreAndForwardCategory.Notification)]
@@ -281,12 +298,16 @@ public class SiteCommandDtoMapperGoldenTests
public void StoreAndForwardCategory_RoundTrips(StoreAndForwardCategory value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: alarm State, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(AlarmState.Active)]
[InlineData(AlarmState.Normal)]
public void AlarmState_RoundTrips(AlarmState value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: alarm Level, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(AlarmLevel.None)]
[InlineData(AlarmLevel.Low)]
@@ -296,6 +317,8 @@ public class SiteCommandDtoMapperGoldenTests
public void AlarmLevel_RoundTrips(AlarmLevel value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: alarm Kind, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(AlarmKind.Computed)]
[InlineData(AlarmKind.NativeOpcUa)]
@@ -303,6 +326,8 @@ public class SiteCommandDtoMapperGoldenTests
public void AlarmKind_RoundTrips(AlarmKind value) =>
Assert.Equal(value, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(value)));
/// <summary>Verifies the case: alarm Shelve State, round Trips.</summary>
/// <param name="value">The value test input.</param>
[Theory]
[InlineData(AlarmShelveState.Unshelved)]
[InlineData(AlarmShelveState.OneShotShelved)]