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:
@@ -14,7 +14,7 @@ namespace ZB.MOM.WW.ScadaBridge.DeploymentManager;
|
||||
/// <param name="Missing">References that are absent or tombstoned in the store.</param>
|
||||
/// <param name="StoreError">
|
||||
/// <see langword="null"/> when every reference was looked up. Otherwise the store read failed
|
||||
/// (final review M5: e.g. the shared SQL Server secret store is unreachable), resolution stopped
|
||||
/// (e.g. the shared SQL Server secret store is unreachable), resolution stopped
|
||||
/// at the first failure, and <see cref="Secrets"/>/<see cref="Missing"/> are INCOMPLETE — the
|
||||
/// caller must treat this site as undeployable and its current hash as unknown. The message is
|
||||
/// the exception type and message only; it never contains secret material.
|
||||
@@ -43,7 +43,7 @@ public sealed class SiteSecretsCollector(ISecretStore store)
|
||||
/// The resolved rows (mapped field-for-field from <see cref="StoredSecret"/>) and the
|
||||
/// references that were absent or tombstoned in the store. A store read failure is
|
||||
/// returned as <see cref="SiteSecretsCollection.StoreError"/> rather than thrown, so one
|
||||
/// site's lookup failing never aborts a whole multi-site sweep (final review M5); only
|
||||
/// site's lookup failing never aborts a whole multi-site sweep; only
|
||||
/// cancellation of <paramref name="ct"/> propagates. A site whose connections reference no
|
||||
/// secret never touches the store at all.
|
||||
/// </returns>
|
||||
|
||||
Reference in New Issue
Block a user