docs(xml): fill missing XML doc comments + strip task-tracking refs across src (fixdocs)
Add missing <summary>/<param>/<returns>/<typeparam> tags and switch interface implementations to <inheritdoc/> across 106 files; strip project bookkeeping identifiers (Task NN, #05-TNN, PLAN-04, StoreAndForward-0NN) from shipped code comments while preserving the descriptive rationale. Comment-only: zero code-logic lines changed; solution builds 0/0. Claude-Session: https://claude.ai/code/session_01MtdgwpEeCUn6cUA5f1LMPj
This commit is contained in:
@@ -154,6 +154,10 @@ public class DeploymentManagerActor : ReceiveActor, IWithTimers
|
||||
/// <see cref="RefreshDeploymentCommand"/> path; null on nodes/tests that never
|
||||
/// receive a refresh.
|
||||
/// </param>
|
||||
/// <param name="startupLoadRetryInterval">Optional retry interval used when loading
|
||||
/// deployed configuration at startup; defaults to 5 seconds when null.</param>
|
||||
/// <param name="configLoader">Optional override for loading all deployed configurations
|
||||
/// at startup; defaults to reading from <paramref name="storage"/>. Primarily for tests.</param>
|
||||
public DeploymentManagerActor(
|
||||
SiteStorageService storage,
|
||||
ScriptCompilationService compilationService,
|
||||
|
||||
@@ -478,6 +478,13 @@ public class ScriptActor : ReceiveActor, IWithTimers
|
||||
// internal (not private) so the culture-invariance of the non-numeric fallback
|
||||
// can be unit-tested directly on the test thread — the live path evaluates on a
|
||||
// dispatcher thread whose CurrentCulture the test cannot deterministically set.
|
||||
/// <summary>
|
||||
/// Evaluates a conditional trigger's operator/threshold against an attribute value,
|
||||
/// converting the value to a culture-invariant double before comparing.
|
||||
/// </summary>
|
||||
/// <param name="config">The trigger configuration specifying the operator and threshold.</param>
|
||||
/// <param name="value">The attribute value to evaluate, or null.</param>
|
||||
/// <returns><see langword="true"/> if the value satisfies the configured condition; otherwise <see langword="false"/>.</returns>
|
||||
internal static bool EvaluateCondition(ConditionalTriggerConfig config, object? value)
|
||||
{
|
||||
if (value == null) return false;
|
||||
|
||||
@@ -230,9 +230,17 @@ public sealed class SiteReconciliationActor : ReceiveActor, IWithTimers
|
||||
/// <summary>Summary of one reconcile pass, piped to <c>Self</c> for logging.</summary>
|
||||
private sealed record ReconcilePassResult(int Fetched, int Failed, int Orphans, Exception? Error)
|
||||
{
|
||||
/// <summary>Creates a result for a reconcile pass that ran to completion.</summary>
|
||||
/// <param name="fetched">Number of instances successfully fetched/reconciled.</param>
|
||||
/// <param name="failed">Number of instances that failed to reconcile.</param>
|
||||
/// <param name="orphans">Number of local instances no longer deployed at central.</param>
|
||||
/// <returns>A completed <see cref="ReconcilePassResult"/> with no error.</returns>
|
||||
public static ReconcilePassResult Completed(int fetched, int failed, int orphans)
|
||||
=> new(fetched, failed, orphans, null);
|
||||
|
||||
/// <summary>Creates a result for a reconcile pass that failed before completing.</summary>
|
||||
/// <param name="error">The exception that caused the pass to fail.</param>
|
||||
/// <returns>A faulted <see cref="ReconcilePassResult"/> carrying the error.</returns>
|
||||
public static ReconcilePassResult Faulted(Exception error)
|
||||
=> new(0, 0, 0, error);
|
||||
}
|
||||
|
||||
@@ -59,6 +59,8 @@ public class SiteReplicationActor : ReceiveActor
|
||||
/// the repo-standard leader+Up check via <see cref="Cluster"/> — swap point for
|
||||
/// plan 01's shared active-node helper.
|
||||
/// </param>
|
||||
/// <param name="options">Site runtime options, including the config-fetch retry count; production defaults apply when null.</param>
|
||||
/// <param name="configFetchRetryDelay">Delay between config-fetch retry attempts; defaults to 2 seconds when null.</param>
|
||||
public SiteReplicationActor(
|
||||
SiteStorageService storage,
|
||||
StoreAndForwardStorage sfStorage,
|
||||
@@ -217,6 +219,7 @@ public class SiteReplicationActor : ReceiveActor
|
||||
/// (fire-and-forget, dropped when no peer is tracked). <see langword="protected virtual"/>
|
||||
/// so tests can intercept the peer send without standing up a real two-node cluster.
|
||||
/// </summary>
|
||||
/// <param name="message">The replication message to forward to the peer.</param>
|
||||
protected virtual void SendToPeer(object message)
|
||||
{
|
||||
if (_peerAddress == null)
|
||||
@@ -410,7 +413,7 @@ public class SiteReplicationActor : ReceiveActor
|
||||
/// <summary>
|
||||
/// Standby-node side of the anti-entropy resync: replaces the local buffer
|
||||
/// wholesale with the active node's snapshot. Combined with the upsert-based
|
||||
/// replicated applies (arch review 02, Task 11), any replicated op that lands
|
||||
/// replicated applies (arch review 02), any replicated op that lands
|
||||
/// after this resync merges cleanly onto the resynced state. An active node
|
||||
/// ignores a snapshot — it is the source of truth, never a resync target.
|
||||
/// </summary>
|
||||
|
||||
Reference in New Issue
Block a user