Skip to content

Commit fd03998

Browse files
committed
docs(http-tests): add XML doc comments on HttpClientDeviceModel surface
Adds /// doc comments to the HttpClientDeviceModel test fixture and each of its five [Test] methods so the project survives the campaign's 100% XML-doc coverage gate (CS1591 → error). The original block comment on the class is promoted to a /// summary; each test gains a one-line summary that pins the behaviour the test name expresses. The gap surfaced when this PR's branch was union-merged into the integration branch on top of feat/docs-full-coverage (TrakHound#182), which turns CS1591 into a build error for every test project.
1 parent c31b286 commit fd03998

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

tests/MTConnect.NET-HTTP-Tests/Clients/HttpClientDeviceModel.cs

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@
1111

1212
namespace MTConnect.Tests.Http.Clients
1313
{
14-
// Drives the full MTConnectHttpClient (the streaming client, not the
15-
// single-shot probe client) against the real embedded MTConnectHttpServer
16-
// started by AgentRunner, pinning the two surfaces issue #176 added:
17-
//
18-
// - the public Devices snapshot accessor, which exposes the post-probe
19-
// device cache that the client already maintains internally;
20-
// - the DeviceReceived event, which historically built an empty list
21-
// and iterated it, so it never fired in the field.
22-
//
23-
// Both invariants are exercised end to end through Start()/Stop(), so the
24-
// probe round trip and the ProcessProbeDocument hand-off both run.
14+
/// <summary>
15+
/// Drives the full MTConnectHttpClient (the streaming client, not the
16+
/// single-shot probe client) against the real embedded MTConnectHttpServer
17+
/// started by AgentRunner, pinning the two surfaces issue #176 added:
18+
/// the public Devices snapshot accessor (which exposes the post-probe
19+
/// device cache the client already maintains internally) and the
20+
/// DeviceReceived event (which historically built an empty list and
21+
/// iterated it, so it never fired in the field). Both invariants are
22+
/// exercised end to end through Start()/Stop(), so the probe round trip
23+
/// and the ProcessProbeDocument hand-off both run.
24+
/// </summary>
2525
[TestFixture]
2626
public class HttpClientDeviceModel : HttpClientFixture
2727
{
@@ -31,6 +31,7 @@ public class HttpClientDeviceModel : HttpClientFixture
3131
private const int ProbeWaitTimeoutMs = 15000;
3232
private const int ProbeWaitPollMs = 50;
3333

34+
/// <summary>Pins the behaviour expressed by the test name: devices accessor is empty before probe.</summary>
3435
[Test]
3536
public void DevicesAccessorIsEmptyBeforeProbe()
3637
{
@@ -40,6 +41,7 @@ public void DevicesAccessorIsEmptyBeforeProbe()
4041
Assert.That(client.Devices.Count, Is.EqualTo(0), "Devices accessor was non-empty before any probe ran");
4142
}
4243

44+
/// <summary>Pins the behaviour expressed by the test name: devices accessor is populated after probe.</summary>
4345
[Test]
4446
public void DevicesAccessorIsPopulatedAfterProbe()
4547
{
@@ -68,6 +70,7 @@ public void DevicesAccessorIsPopulatedAfterProbe()
6870
}
6971
}
7072

73+
/// <summary>Pins the behaviour expressed by the test name: devices accessor returns snapshot not live view.</summary>
7174
[Test]
7275
public void DevicesAccessorReturnsSnapshotNotLiveView()
7376
{
@@ -97,6 +100,7 @@ public void DevicesAccessorReturnsSnapshotNotLiveView()
97100
}
98101
}
99102

103+
/// <summary>Pins the behaviour expressed by the test name: device received fires once per device on first probe.</summary>
100104
[Test]
101105
public void DeviceReceivedFiresOncePerDeviceOnFirstProbe()
102106
{
@@ -138,6 +142,7 @@ public void DeviceReceivedFiresOncePerDeviceOnFirstProbe()
138142
}
139143
}
140144

145+
/// <summary>Pins the behaviour expressed by the test name: device received carries wired data item back pointers.</summary>
141146
[Test]
142147
public void DeviceReceivedCarriesWiredDataItemBackPointers()
143148
{

0 commit comments

Comments
 (0)