docs: backfill XML documentation across 756 files
v2-ci / build (push) Failing after 1m43s
v2-ci / unit-tests (tests/Core/ZB.MOM.WW.OtOpcUa.Cluster.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.ControlPlane.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Security.Tests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Has been skipped

Adds <summary>, <param>, <typeparam>, and <inheritdoc/> tags to public
members surfaced by commentchecker — resolves 5,847 of 5,869 issues
(99.6%) across three /fixdocs passes.
This commit is contained in:
Joseph Doherty
2026-05-28 08:10:17 -04:00
parent f9fc7dd2e1
commit 64e3fbe035
756 changed files with 9876 additions and 96 deletions
@@ -12,6 +12,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.CLI.Tests;
/// </summary>
public class CommandRangeValidationTests
{
/// <summary>Verifies that BrowseCommand rejects negative depth values with a command exception.</summary>
[Fact]
public async Task BrowseCommand_NegativeDepth_ThrowsCommandException()
{
@@ -28,6 +29,7 @@ public class CommandRangeValidationTests
ex.Message.ShouldContain("--depth");
}
/// <summary>Verifies that BrowseCommand rejects zero depth values with a command exception.</summary>
[Fact]
public async Task BrowseCommand_ZeroDepth_ThrowsCommandException()
{
@@ -44,6 +46,7 @@ public class CommandRangeValidationTests
ex.Message.ShouldContain("--depth");
}
/// <summary>Verifies that SubscribeCommand rejects zero interval values with a command exception.</summary>
[Fact]
public async Task SubscribeCommand_ZeroInterval_ThrowsCommandException()
{
@@ -61,6 +64,7 @@ public class CommandRangeValidationTests
ex.Message.ShouldContain("--interval");
}
/// <summary>Verifies that SubscribeCommand rejects negative interval values with a command exception.</summary>
[Fact]
public async Task SubscribeCommand_NegativeInterval_ThrowsCommandException()
{
@@ -77,6 +81,7 @@ public class CommandRangeValidationTests
await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
}
/// <summary>Verifies that SubscribeCommand in recursive mode rejects zero max depth with a command exception.</summary>
[Fact]
public async Task SubscribeCommand_RecursiveZeroMaxDepth_ThrowsCommandException()
{
@@ -96,6 +101,7 @@ public class CommandRangeValidationTests
ex.Message.ShouldContain("--max-depth");
}
/// <summary>Verifies that SubscribeCommand rejects negative duration values with a command exception.</summary>
[Fact]
public async Task SubscribeCommand_NegativeDuration_ThrowsCommandException()
{
@@ -112,6 +118,7 @@ public class CommandRangeValidationTests
await Should.ThrowAsync<CommandException>(async () => await command.ExecuteAsync(console));
}
/// <summary>Verifies that AlarmsCommand rejects zero interval values with a command exception.</summary>
[Fact]
public async Task AlarmsCommand_ZeroInterval_ThrowsCommandException()
{
@@ -128,6 +135,7 @@ public class CommandRangeValidationTests
ex.Message.ShouldContain("--interval");
}
/// <summary>Verifies that HistoryReadCommand rejects negative max values with a command exception.</summary>
[Fact]
public async Task HistoryReadCommand_NegativeMax_ThrowsCommandException()
{
@@ -145,6 +153,7 @@ public class CommandRangeValidationTests
ex.Message.ShouldContain("--max");
}
/// <summary>Verifies that HistoryReadCommand rejects zero interval values with a command exception.</summary>
[Fact]
public async Task HistoryReadCommand_ZeroInterval_ThrowsCommandException()
{