docs: fill missing XML docs and strip tracking IDs from src comments

Clears CommentChecker findings in src/ (3,280 -> 209, the remainder being false
positives like PLC-5/IEEE-754/M0.0) by adding missing summaries/params/returns,
normalising inheritdoc usage, and removing Gitea/review tracking IDs while keeping
the rationale they annotated. Comment-only: comment-stripped sources are identical
to the parent commit.
This commit is contained in:
Joseph Doherty
2026-10-15 06:14:58 -04:00
parent ebcbd81fca
commit 826312befe
430 changed files with 4434 additions and 3923 deletions
@@ -41,7 +41,7 @@ public enum ClusterFilterMode
}
/// <summary>
/// The data-plane authorization inputs decoded out of a deployment artifact for one node (#520).
/// The data-plane authorization inputs decoded out of a deployment artifact for one node.
/// </summary>
/// <param name="ClusterId">The node's cluster per its <c>ClusterNode</c> row, or null on a
/// single-cluster / legacy artifact where no scoping applies.</param>
@@ -149,7 +149,7 @@ public static class DeploymentArtifact
/// Every failure — corrupt stream, truncated stream, over-limit inflation — is reported as
/// <see cref="JsonException"/> so it lands in the exact catch the malformed-JSON path already
/// owns: the static wrappers degrade to empty results, and the apply paths fail the apply and
/// keep last-known-good (#485 "no bytes is no answer"). Unusable bytes are unusable bytes; the
/// keep last-known-good ("no bytes is no answer"). Unusable bytes are unusable bytes; the
/// reason they are unusable does not change any caller's decision.
/// </para>
/// </remarks>
@@ -269,7 +269,7 @@ public static class DeploymentArtifact
/// <summary>
/// Parse the data-plane authorization inputs a node needs to authenticate OPC UA sessions:
/// the <c>ApiKeys</c> the artifact carries and the <c>NodeAcls</c> granting their principals
/// permissions (#520, stage 4). See <see cref="ParsedDeploymentArtifact.ParseDataPlaneAuthority"/>
/// permissions. See <see cref="ParsedDeploymentArtifact.ParseDataPlaneAuthority"/>
/// for the scoping + leniency contract.
/// </summary>
/// <param name="blob">The deployment artifact blob to parse.</param>
@@ -859,7 +859,7 @@ internal sealed class ParsedDeploymentArtifact : IDisposable
/// <summary>
/// The data-plane authorization inputs a node needs to authenticate OPC UA sessions:
/// the <c>ApiKeys</c> the artifact carries and the <c>NodeAcls</c> granting their principals
/// permissions (#520, stage 4).
/// permissions.
/// </summary>
/// <remarks>
/// <para>
@@ -876,7 +876,7 @@ internal sealed class ParsedDeploymentArtifact : IDisposable
/// <para>
/// Lenient like every other parser here: an artifact carrying neither section yields empty
/// lists. The caller must NOT treat that as "no keys are valid" and install it — see issue
/// #485; the apply paths only reach this with bytes that already passed their own guard.
/// the apply paths only reach this with bytes that already passed their own guard.
/// </para>
/// </remarks>
/// <param name="nodeId">The node's identity, used to resolve cluster scope for the grants.</param>