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
@@ -6,6 +6,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Models;
public class ConnectionSettingsTests
{
/// <summary>Verifies that ConnectionSettings defaults are correct.</summary>
[Fact]
public void Defaults_AreCorrect()
{
@@ -24,6 +25,7 @@ public class ConnectionSettingsTests
settings.CertificateStorePath.ShouldBe(string.Empty);
}
/// <summary>Verifies that validation throws on null endpoint URL.</summary>
[Fact]
public void Validate_ThrowsOnNullEndpointUrl()
{
@@ -32,6 +34,7 @@ public class ConnectionSettingsTests
.ParamName.ShouldBe("EndpointUrl");
}
/// <summary>Verifies that validation throws on empty endpoint URL.</summary>
[Fact]
public void Validate_ThrowsOnEmptyEndpointUrl()
{
@@ -40,6 +43,7 @@ public class ConnectionSettingsTests
.ParamName.ShouldBe("EndpointUrl");
}
/// <summary>Verifies that validation throws on whitespace endpoint URL.</summary>
[Fact]
public void Validate_ThrowsOnWhitespaceEndpointUrl()
{
@@ -48,6 +52,7 @@ public class ConnectionSettingsTests
.ParamName.ShouldBe("EndpointUrl");
}
/// <summary>Verifies that validation throws on zero timeout.</summary>
[Fact]
public void Validate_ThrowsOnZeroTimeout()
{
@@ -60,6 +65,7 @@ public class ConnectionSettingsTests
.ParamName.ShouldBe("SessionTimeoutSeconds");
}
/// <summary>Verifies that validation throws on negative timeout.</summary>
[Fact]
public void Validate_ThrowsOnNegativeTimeout()
{
@@ -72,6 +78,7 @@ public class ConnectionSettingsTests
.ParamName.ShouldBe("SessionTimeoutSeconds");
}
/// <summary>Verifies that validation throws on timeout above 3600 seconds.</summary>
[Fact]
public void Validate_ThrowsOnTimeoutAbove3600()
{
@@ -84,6 +91,7 @@ public class ConnectionSettingsTests
.ParamName.ShouldBe("SessionTimeoutSeconds");
}
/// <summary>Verifies that validation succeeds with valid settings.</summary>
[Fact]
public void Validate_SucceedsWithValidSettings()
{
@@ -8,6 +8,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Models;
public class ModelConstructionTests
{
/// <summary>Verifies that BrowseResult constructs correctly with all properties.</summary>
[Fact]
public void BrowseResult_ConstructsCorrectly()
{
@@ -19,6 +20,7 @@ public class ModelConstructionTests
result.HasChildren.ShouldBeTrue();
}
/// <summary>Verifies that BrowseResult correctly sets HasChildren to false.</summary>
[Fact]
public void BrowseResult_WithoutChildren()
{
@@ -26,6 +28,7 @@ public class ModelConstructionTests
result.HasChildren.ShouldBeFalse();
}
/// <summary>Verifies that AlarmEventArgs constructs correctly with all properties.</summary>
[Fact]
public void AlarmEventArgs_ConstructsCorrectly()
{
@@ -42,6 +45,7 @@ public class ModelConstructionTests
args.Time.ShouldBe(time);
}
/// <summary>Verifies that RedundancyInfo constructs correctly with all properties.</summary>
[Fact]
public void RedundancyInfo_ConstructsCorrectly()
{
@@ -54,6 +58,7 @@ public class ModelConstructionTests
info.ApplicationUri.ShouldBe("urn:server1");
}
/// <summary>Verifies that RedundancyInfo handles empty URIs correctly.</summary>
[Fact]
public void RedundancyInfo_WithEmptyUris()
{
@@ -62,6 +67,7 @@ public class ModelConstructionTests
info.ApplicationUri.ShouldBeEmpty();
}
/// <summary>Verifies that DataChangedEventArgs constructs correctly with all properties.</summary>
[Fact]
public void DataChangedEventArgs_ConstructsCorrectly()
{
@@ -73,6 +79,7 @@ public class ModelConstructionTests
args.Value.Value.ShouldBe(42);
}
/// <summary>Verifies that ConnectionStateChangedEventArgs constructs correctly with all properties.</summary>
[Fact]
public void ConnectionStateChangedEventArgs_ConstructsCorrectly()
{
@@ -84,6 +91,7 @@ public class ModelConstructionTests
args.EndpointUrl.ShouldBe("opc.tcp://localhost:4840");
}
/// <summary>Verifies that ConnectionInfo constructs correctly with all properties.</summary>
[Fact]
public void ConnectionInfo_ConstructsCorrectly()
{
@@ -103,6 +111,7 @@ public class ModelConstructionTests
info.SessionName.ShouldBe("TestSession");
}
/// <summary>Verifies that SecurityMode enum has the expected number of values.</summary>
[Fact]
public void SecurityMode_Enum_HasExpectedValues()
{
@@ -112,6 +121,7 @@ public class ModelConstructionTests
((int)SecurityMode.SignAndEncrypt).ShouldBe(2);
}
/// <summary>Verifies that ConnectionState enum has the expected number of values.</summary>
[Fact]
public void ConnectionState_Enum_HasExpectedValues()
{
@@ -122,6 +132,7 @@ public class ModelConstructionTests
((int)ConnectionState.Reconnecting).ShouldBe(3);
}
/// <summary>Verifies that AggregateType enum has the expected number of values.</summary>
[Fact]
public void AggregateType_Enum_HasExpectedValues()
{