docs: complete XML doc coverage (returns, summaries, inheritdoc)

Resolve all 622 issues flagged by the enhanced CommentChecker: add missing
<returns> tags (incl. the standard phrasing on non-generic Task methods),
add missing <summary> tags, and replace misused/redundant <inheritdoc/> on
members that override or implement nothing with real documentation.
Documentation-only — no behavior change; solution builds clean.
This commit is contained in:
Joseph Doherty
2026-06-03 11:39:32 -04:00
parent a050170414
commit eabf270d71
208 changed files with 867 additions and 114 deletions
@@ -156,18 +156,7 @@ public class SiteCallAuditActor : ReceiveActor
Receive<DiscardSiteCallRequest>(HandleDiscardSiteCall);
}
/// <summary>
/// SiteCallAudit-001: child supervision strategy — governs children, not this
/// actor. The actor has no children today, so this override is inert; it
/// returns a one-for-one strategy with the framework
/// <see cref="Akka.Actor.SupervisorStrategy.DefaultDecider"/> (Restart on
/// most exceptions; Stop on <see cref="ActorInitializationException"/> /
/// <see cref="ActorKilledException"/>) and <c>maxNrOfRetries: 0</c>, so any
/// future child that throws is Stopped on the first failure. The actor's
/// own resilience comes from the <c>try/catch</c> in <see cref="OnUpsertAsync"/>
/// plus the parent <see cref="Akka.Cluster.Tools.Singleton.ClusterSingletonManager"/>'s
/// supervision — not from this override.
/// </summary>
/// <inheritdoc />
protected override SupervisorStrategy SupervisorStrategy()
{
return new OneForOneStrategy(maxNrOfRetries: 0, withinTimeRange: TimeSpan.Zero, decider: