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
@@ -20,31 +20,53 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
/// Gets a value indicating whether the fake session has been disposed.
/// </summary>
public bool Disposed { get; private set; }
/// <summary>Gets the number of times ReadValueAsync has been called.</summary>
public int ReadCount { get; private set; }
/// <summary>Gets the number of times WriteValueAsync has been called.</summary>
public int WriteCount { get; private set; }
/// <summary>Gets the number of times BrowseAsync has been called.</summary>
public int BrowseCount { get; private set; }
/// <summary>Gets the number of times BrowseNextAsync has been called.</summary>
public int BrowseNextCount { get; private set; }
/// <summary>Gets the number of times HasChildrenAsync has been called.</summary>
public int HasChildrenCount { get; private set; }
/// <summary>Gets the number of times HistoryReadRawAsync has been called.</summary>
public int HistoryReadRawCount { get; private set; }
/// <summary>Gets the number of times HistoryReadAggregateAsync has been called.</summary>
public int HistoryReadAggregateCount { get; private set; }
// Configurable responses
/// <summary>Gets or sets the data value returned by read operations.</summary>
public DataValue? ReadResponse { get; set; }
/// <summary>Gets or sets a function to generate read responses dynamically based on the node ID.</summary>
public Func<NodeId, DataValue>? ReadResponseFunc { get; set; }
/// <summary>Gets or sets the status code returned by write operations.</summary>
public StatusCode WriteResponse { get; set; } = StatusCodes.Good;
/// <summary>Gets or sets a value indicating whether read operations should throw an exception.</summary>
public bool ThrowOnRead { get; set; }
/// <summary>Gets or sets a value indicating whether write operations should throw an exception.</summary>
public bool ThrowOnWrite { get; set; }
/// <summary>Gets or sets a value indicating whether browse operations should throw an exception.</summary>
public bool ThrowOnBrowse { get; set; }
/// <summary>Gets or sets the browse references returned by browse operations.</summary>
public ReferenceDescriptionCollection BrowseResponse { get; set; } = [];
/// <summary>Gets or sets the continuation point for browse operations.</summary>
public byte[]? BrowseContinuationPoint { get; set; }
/// <summary>Gets or sets the browse references returned by browse-next operations.</summary>
public ReferenceDescriptionCollection BrowseNextResponse { get; set; } = [];
/// <summary>Gets or sets the continuation point for browse-next operations.</summary>
public byte[]? BrowseNextContinuationPoint { get; set; }
/// <summary>Gets or sets the result returned by has-children operations.</summary>
public bool HasChildrenResponse { get; set; } = false;
/// <summary>Gets or sets the historical values returned by raw history-read operations.</summary>
public List<DataValue> HistoryReadRawResponse { get; set; } = [];
/// <summary>Gets or sets the historical values returned by aggregate history-read operations.</summary>
public List<DataValue> HistoryReadAggregateResponse { get; set; } = [];
/// <summary>Gets or sets a value indicating whether raw history-read operations should throw an exception.</summary>
public bool ThrowOnHistoryReadRaw { get; set; }
/// <summary>Gets or sets a value indicating whether aggregate history-read operations should throw an exception.</summary>
public bool ThrowOnHistoryReadAggregate { get; set; }
/// <summary>
@@ -210,6 +232,7 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
/// <summary>
/// Simulates a keep-alive event.
/// </summary>
/// <param name="isGood">Whether the keep-alive status is good.</param>
public void SimulateKeepAlive(bool isGood)
{
_keepAliveCallback?.Invoke(isGood);