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
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:
@@ -27,6 +27,9 @@ public static class S7_1500Profile
|
||||
|
||||
public const string WriteScratchTag = "WriteScratch";
|
||||
|
||||
/// <summary>Builds the S7 driver options for the S7-1500 integration tests.</summary>
|
||||
/// <param name="host">The hostname or IP address of the S7 PLC.</param>
|
||||
/// <param name="port">The port number for the S7 PLC connection.</param>
|
||||
public static S7DriverOptions BuildOptions(string host, int port) => new()
|
||||
{
|
||||
Host = host,
|
||||
|
||||
+3
@@ -17,6 +17,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.S7.IntegrationTests.S7_1500;
|
||||
[Trait("Device", "S7_1500")]
|
||||
public sealed class S7_1500SmokeTests(Snap7ServerFixture sim)
|
||||
{
|
||||
/// <summary>Verifies that the driver reads a seeded u16 value through real S7comm.</summary>
|
||||
[Fact]
|
||||
public async Task Driver_reads_seeded_u16_through_real_S7comm()
|
||||
{
|
||||
@@ -34,6 +35,7 @@ public sealed class S7_1500SmokeTests(Snap7ServerFixture sim)
|
||||
Convert.ToInt32(snapshots[0].Value).ShouldBe(S7_1500Profile.ProbeSeedValue);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the driver reads a typed batch of seeded values.</summary>
|
||||
[Fact]
|
||||
public async Task Driver_reads_seeded_typed_batch()
|
||||
{
|
||||
@@ -57,6 +59,7 @@ public sealed class S7_1500SmokeTests(Snap7ServerFixture sim)
|
||||
Convert.ToBoolean(snapshots[3].Value).ShouldBeTrue();
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the driver can write and then read back a value on a scratch register.</summary>
|
||||
[Fact]
|
||||
public async Task Driver_write_then_read_round_trip_on_scratch_word()
|
||||
{
|
||||
|
||||
@@ -40,10 +40,16 @@ public sealed class Snap7ServerFixture : IAsyncDisposable
|
||||
private const string DefaultEndpoint = "10.100.0.35:1102";
|
||||
private const string EndpointEnvVar = "S7_SIM_ENDPOINT";
|
||||
|
||||
/// <summary>Gets the S7 server hostname or IP address.</summary>
|
||||
public string Host { get; }
|
||||
|
||||
/// <summary>Gets the S7 server port number.</summary>
|
||||
public int Port { get; }
|
||||
|
||||
/// <summary>Gets the skip reason if the server is unavailable; otherwise null.</summary>
|
||||
public string? SkipReason { get; }
|
||||
|
||||
/// <summary>Initializes a new instance of the Snap7ServerFixture class and probes connectivity.</summary>
|
||||
public Snap7ServerFixture()
|
||||
{
|
||||
var raw = Environment.GetEnvironmentVariable(EndpointEnvVar) ?? DefaultEndpoint;
|
||||
@@ -75,6 +81,7 @@ public sealed class Snap7ServerFixture : IAsyncDisposable
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Disposes the fixture asynchronously.</summary>
|
||||
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user