docs(xmldoc): fix genuine doc issues surfaced by /fixdocs (17 fixes)
v2-ci / build (push) Successful in 3m11s
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Failing after 3m51s
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Failing after 1m50s
v2-ci / unit-tests (push) Failing after 8m37s
v2-ci / build (push) Successful in 3m11s
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Failing after 3m51s
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Failing after 1m50s
v2-ci / unit-tests (push) Failing after 8m37s
- CapabilityInvoker: 3 methods that implement IDriverCapabilityInvoker now use <inheritdoc /> instead of duplicating the interface docs (MissingInheritDoc). - TwinCAT NativeRegistration ctor: added the 8 missing <param> tags (MissingParam). - Stripped the arch-review bookkeeping IDs STAB-1 (IS7Plc, S7Driver) + STAB-2 (TwinCATDriver x4) from comments, keeping the descriptive text. Left the other 86 flagged items untouched — they are checker false positives on legitimate technical content: interface-implemented events / IEqualityComparer / IDisposable members whose <inheritdoc/> IS correct (10 InheritDocMisused), and domain terms the heuristic misreads as tracking IDs (IEEE-754, S7-1200/300/400/1500, PLC-5, D2-260, S7/Melsec memory addresses, OPC UA Part 9, phase-N design-doc filename refs, UNS level-N descriptions, and prose like 'the #1 bug source' / failover 'pick #3').
This commit is contained in:
@@ -11,7 +11,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.S7;
|
||||
/// <remarks>
|
||||
/// The seam exists so <see cref="S7Driver.EnsureConnectedAsync"/> can dispose a dead handle and
|
||||
/// re-open a fresh one after a transient PLC reboot / network blip — the reconnect path
|
||||
/// (STAB-1) — and so that path is unit-testable via a fake <see cref="IS7PlcFactory"/> without a
|
||||
/// — and so that path is unit-testable via a fake <see cref="IS7PlcFactory"/> without a
|
||||
/// live PLC (S7.Net ships no in-process fake and <see cref="Plc"/> is <c>sealed</c>). Mirrors
|
||||
/// the TwinCAT driver's <c>ITwinCATClient</c> / <c>ITwinCATClientFactory</c> pattern.
|
||||
/// </remarks>
|
||||
|
||||
@@ -1172,7 +1172,7 @@ public sealed class S7Driver
|
||||
|
||||
/// <summary>
|
||||
/// Returns a live S7 connection, lazily disposing a dead handle and re-opening a fresh one
|
||||
/// when the previous connection dropped (STAB-1 reconnect path). The fast path returns the
|
||||
/// when the previous connection dropped (the reconnect path). The fast path returns the
|
||||
/// current <see cref="Plc"/> when it is still connected and not marked dead; otherwise it
|
||||
/// builds + opens a new connection via <see cref="_plcFactory"/> with the same
|
||||
/// timeout-linked CTS the initial connect uses.
|
||||
|
||||
Reference in New Issue
Block a user