docs(src): fix CommentChecker findings across src/ — 1,032 → 5 (all false positives)
Comment/XML-doc changes only, no code logic: - strip project-tracking references (WP*, P*-*, row-NN, #NN, Task N) from comments, keeping the explanatory rationale - add missing summaries, <param>, <returns>, <typeparam> and <inheritdoc/> - replace misused <inheritdoc/> with real docs; where <inheritdoc/> was combined with useful remarks, move the rationale into // comments - drop stale replicationActor <param> on DeploymentManagerActor ctor Remaining 5 are false positives (CWE-1236 x2, failures-1, year-0001, M365). Build 0 errors / 0 warnings.
This commit is contained in:
@@ -116,7 +116,7 @@ public class SiteStorageService
|
||||
/// or <see langword="null"/> if no row exists for it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Register P1-4: <see cref="GetAllDeployedConfigsAsync"/> plus a <c>FirstOrDefault</c> was
|
||||
/// <see cref="GetAllDeployedConfigsAsync"/> plus a <c>FirstOrDefault</c> was
|
||||
/// materializing every deployed config — including every <c>ConfigJson</c> blob — just to find
|
||||
/// one row. A volume-restore reconcile healing hundreds of instances turned that into hundreds
|
||||
/// of full-table reads. Callers that need the full row (including <c>ConfigJson</c>) for exactly
|
||||
@@ -162,7 +162,7 @@ public class SiteStorageService
|
||||
/// <c>config_json</c> column, or <see langword="null"/> if no row exists for it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Register P1-4: for a caller that only needs staleness/identity metadata (e.g. the
|
||||
/// For a caller that only needs staleness/identity metadata (e.g. the
|
||||
/// central deployment-state query, which reports only <c>DeploymentId</c>/<c>RevisionHash</c>),
|
||||
/// reading the <c>config_json</c> blob is pure waste. This projection is that lighter read.
|
||||
/// </remarks>
|
||||
@@ -432,8 +432,8 @@ public class SiteStorageService
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Batch counterpart of <see cref="SetStaticOverrideAsync"/> (perf remediation,
|
||||
/// arch-review WP1.5): upserts a set of static attribute overrides for one instance
|
||||
/// Batch counterpart of <see cref="SetStaticOverrideAsync"/> (perf remediation):
|
||||
/// upserts a set of static attribute overrides for one instance
|
||||
/// in a SINGLE connection + transaction with one prepared command re-bound per row.
|
||||
/// Used by the InstanceActor's coalesced flush — mirrors NativeAlarmActor's
|
||||
/// MarkDirtyUpsert/FlushDirtyUpserts (P4) pattern — so a burst of rapid SetAttribute
|
||||
@@ -802,7 +802,7 @@ public class SiteStorageService
|
||||
/// Returns every row in <c>deployed_secrets</c> like <see cref="GetDeployedSecretsAsync"/>,
|
||||
/// but never throws for a single bad row: a row whose <c>row_json</c> does not deserialize
|
||||
/// is returned in <c>Unreadable</c> (name, removal flag and the parse error — never the
|
||||
/// row's content) instead of failing the whole read (final review M4, per-row isolation).
|
||||
/// row's content) instead of failing the whole read (per-row isolation).
|
||||
/// </summary>
|
||||
/// <returns>The parsed rows and the rows that could not be parsed.</returns>
|
||||
public async Task<(IReadOnlyList<DeployedSecretRow> Rows, IReadOnlyList<UnreadableDeployedSecretRow> Unreadable)>
|
||||
@@ -925,7 +925,7 @@ public class SiteStorageService
|
||||
await command.ExecuteNonQueryAsync();
|
||||
}
|
||||
|
||||
// ── Secret mirror status (review finding M1 — LocalDb-replicated, one row per node) ──
|
||||
// ── Secret mirror status (LocalDb-replicated, one row per node) ──
|
||||
|
||||
/// <summary>
|
||||
/// Records <paramref name="nodeName"/>'s current deployed-secrets mirror failures in the
|
||||
@@ -1418,7 +1418,7 @@ public class DeployedInstance
|
||||
/// Deployment-identity metadata for one deployed instance — the projection of
|
||||
/// <see cref="DeployedInstance"/> that omits <c>ConfigJson</c>. Returned by
|
||||
/// <see cref="SiteStorageService.GetDeployedConfigMetadataAsync"/> for callers that only need to
|
||||
/// answer "is this instance deployed, and at what revision" (register P1-4).
|
||||
/// answer "is this instance deployed, and at what revision".
|
||||
/// </summary>
|
||||
/// <param name="InstanceUniqueName">The unique name of the instance.</param>
|
||||
/// <param name="DeploymentId">The unique deployment identifier.</param>
|
||||
|
||||
Reference in New Issue
Block a user