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:
Joseph Doherty
2026-10-07 14:12:25 -04:00
parent 3a217b9484
commit 0ffd4bdbea
217 changed files with 1224 additions and 695 deletions
@@ -10,7 +10,15 @@ public sealed class DataConnectionSecretConverter(IDataProtector protector) : Va
{
internal const string Prefix = "dp:protocol:v1:";
internal const string Purpose = EncryptedStringConverter.ProtectorPurpose + ".DataConnection";
/// <summary>Encrypts plaintext protocol JSON and tags it with the versioned prefix.</summary>
/// <param name="protector">The data protector to encrypt with.</param>
/// <param name="plaintext">The plaintext to protect.</param>
/// <returns>The prefixed protected string.</returns>
internal static string Protect(IDataProtector protector, string plaintext) => Prefix + protector.Protect(plaintext);
/// <summary>Decrypts a stored, versioned protected value.</summary>
/// <param name="protector">The data protector to decrypt with.</param>
/// <param name="stored">The stored value, which must carry the versioned prefix.</param>
/// <returns>The decrypted plaintext.</returns>
internal static string Unprotect(IDataProtector protector, string stored)
=> stored.StartsWith(Prefix, StringComparison.Ordinal)
? protector.Unprotect(stored[Prefix.Length..])