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
@@ -154,6 +154,8 @@ public static class SiteLocalDbLegacyMigrator
/// falling back to the code default. Relative paths resolve against the process working
/// directory — NOT the data volume — because that is where the old code actually put them.
/// </summary>
/// <param name="config">The application configuration.</param>
/// <returns>The absolute path of the legacy tracking database.</returns>
internal static string ResolveTrackingPath(IConfiguration config)
{
var connectionString =
@@ -184,6 +186,8 @@ public static class SiteLocalDbLegacyMigrator
}
/// <summary>Resolves the legacy event-log path from the OLD key, falling back to the code default.</summary>
/// <param name="config">The application configuration.</param>
/// <returns>The absolute path of the legacy event-log database.</returns>
internal static string ResolveEventLogPath(IConfiguration config)
{
var path = config["ScadaBridge:SiteEventLog:DatabasePath"] ?? DefaultEventLogPath;
@@ -203,6 +207,8 @@ public static class SiteLocalDbLegacyMigrator
/// mounted data volume (<c>./data/</c>), so on the docker rig there is a real file here
/// with real buffered messages — this migration is not the usual no-op.
/// </summary>
/// <param name="config">The application configuration.</param>
/// <returns>The absolute path of the legacy store-and-forward database.</returns>
internal static string ResolveStoreAndForwardPath(IConfiguration config)
{
var path = config["ScadaBridge:StoreAndForward:SqliteDbPath"] ?? DefaultStoreAndForwardPath;
@@ -222,6 +228,8 @@ public static class SiteLocalDbLegacyMigrator
/// to the code default. Like store-and-forward — and unlike the two Phase 1 paths — this
/// default is inside the mounted data volume, so a real deployment has real config here.
/// </summary>
/// <param name="config">The application configuration.</param>
/// <returns>The absolute path of the legacy site configuration database.</returns>
internal static string ResolveSiteStoragePath(IConfiguration config)
{
var path = config["ScadaBridge:Database:SiteDbPath"] ?? DefaultSiteStoragePath;
@@ -471,10 +479,12 @@ public static class SiteLocalDbLegacyMigrator
/// <para>
/// This never shows up on Linux or macOS: POSIX rename does not care about open handles,
/// so the docker rig and developer machines migrate cleanly. It reproduces on the first
/// Windows site node that boots with a pre-Phase-2 database beside it — which is every
/// Windows site node that boots with a pre-consolidation database beside it — which is every
/// Windows install being upgraded, exactly once.
/// </para>
/// </remarks>
/// <param name="legacyPath">The path of the legacy SQLite file.</param>
/// <returns>A read-only, non-pooled SQLite connection string for the file.</returns>
internal static string LegacyReadOnlyConnectionString(string legacyPath)
=> $"Data Source={legacyPath};Mode=ReadOnly;Pooling=False";