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
@@ -5,12 +5,14 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Interfaces.Protocol;
|
||||
/// <summary>
|
||||
/// Single-source-of-truth coverage for <see cref="AlarmCapableProtocols.IsAlarmCapable"/>.
|
||||
/// The OpcUa/MxGateway literal set previously lived inline in the Central UI
|
||||
/// (TemplateEdit / InstanceConfigure); #53 collapsed those copies into this helper,
|
||||
/// (TemplateEdit / InstanceConfigure); those copies were collapsed into this helper,
|
||||
/// so the literal set is pinned here rather than against page markup. Keep this in
|
||||
/// sync with the alarm-subscribable adapters registered in DataConnectionFactory.
|
||||
/// </summary>
|
||||
public class AlarmCapableProtocolsTests
|
||||
{
|
||||
/// <summary>Verifies that alarm-subscribable protocols are reported as alarm capable.</summary>
|
||||
/// <param name="protocol">The protocol name under test.</param>
|
||||
[Theory]
|
||||
[InlineData("OpcUa")]
|
||||
[InlineData("opcua")] // case-insensitive — matches DataConnectionFactory's OrdinalIgnoreCase key lookup
|
||||
@@ -22,6 +24,8 @@ public class AlarmCapableProtocolsTests
|
||||
Assert.True(AlarmCapableProtocols.IsAlarmCapable(protocol));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that non-alarm-capable, null or blank protocols are not reported as alarm capable.</summary>
|
||||
/// <param name="protocol">The protocol name under test.</param>
|
||||
[Theory]
|
||||
[InlineData(null)]
|
||||
[InlineData("")]
|
||||
|
||||
Reference in New Issue
Block a user