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
@@ -12,7 +12,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Templates;
namespace ZB.MOM.WW.ScadaBridge.DeploymentManager.Tests;
/// <summary>
/// M2.1 (#22): proves the FlatteningPipeline actually computes the alarm-capable
/// Proves the FlatteningPipeline actually computes the alarm-capable
/// connection set from the loaded site data connections and threads it through
/// ValidationService → SemanticValidator. Before the fix the pipeline loaded the
/// connections but never passed the capable set, so the native-alarm-source
@@ -30,6 +30,7 @@ public class FlatteningPipelineNativeAlarmCapabilityTests
private readonly ISharedSchemaRepository _sharedSchemaRepo = Substitute.For<ISharedSchemaRepository>();
private readonly FlatteningPipeline _sut;
/// <summary>Initializes a new instance of the <see cref="FlatteningPipelineNativeAlarmCapabilityTests"/> class.</summary>
public FlatteningPipelineNativeAlarmCapabilityTests()
{
_sharedSchemaRepo.ListAsync(Arg.Any<CancellationToken>())
@@ -73,6 +74,8 @@ public class FlatteningPipelineNativeAlarmCapabilityTests
.Returns([connection]);
}
/// <summary>Verifies that a native alarm source on a connection that is not alarm-capable reports a capability error.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task FlattenAndValidate_NativeAlarmSourceOnNonAlarmCapableConnection_ReportsCapabilityError()
{
@@ -87,6 +90,9 @@ public class FlatteningPipelineNativeAlarmCapabilityTests
&& e.Message.Contains("alarm-capable"));
}
/// <summary>Verifies that a native alarm source on an alarm-capable connection reports no capability error.</summary>
/// <param name="protocol">The data connection protocol under test.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("OpcUa")]
[InlineData("MxGateway")]