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:
@@ -59,6 +59,8 @@ public sealed class FlowDebugService : IFlowDebugService
|
||||
/// the run itself at <c>timeoutSeconds + RunGrace</c> (see <c>FlowDebugRunner.RunMethodAsync</c>),
|
||||
/// so the client must wait at least that long or it cuts the run off before the server does.
|
||||
/// </summary>
|
||||
/// <param name="timeoutSeconds">The method's own timeout in seconds.</param>
|
||||
/// <returns>The Ask timeout to use for the run.</returns>
|
||||
public static TimeSpan RunAskTimeoutFor(int timeoutSeconds)
|
||||
{
|
||||
var t = TimeSpan.FromSeconds(Math.Max(1, timeoutSeconds)) + FlowDebugRunner.RunGrace + ClientSlack;
|
||||
@@ -69,6 +71,8 @@ public sealed class FlowDebugService : IFlowDebugService
|
||||
/// Client-side Ask wait for a WRITE-kind script run (<see cref="RunScriptAsync"/>): the
|
||||
/// trigger-wait window plus <see cref="ClientSlack"/>.
|
||||
/// </summary>
|
||||
/// <param name="waitSeconds">The trigger-wait window in seconds.</param>
|
||||
/// <returns>The Ask timeout to use for the run.</returns>
|
||||
public static TimeSpan ValueChangeAskTimeoutFor(int waitSeconds)
|
||||
=> TimeSpan.FromSeconds(Math.Max(1, waitSeconds)) + ClientSlack;
|
||||
|
||||
@@ -110,6 +114,14 @@ public sealed class FlowDebugService : IFlowDebugService
|
||||
IReadOnlyList<FlowScriptOption> Options);
|
||||
|
||||
/// <summary>Initializes the service.</summary>
|
||||
/// <param name="holder">Holder for the management actor reference.</param>
|
||||
/// <param name="auth">Provides the caller's authentication state.</param>
|
||||
/// <param name="inboundApi">Repository for inbound API methods.</param>
|
||||
/// <param name="templates">Repository for templates and instances.</param>
|
||||
/// <param name="pipeline">Flattening pipeline used to resolve instance scripts.</param>
|
||||
/// <param name="comms">Communication service for central-to-site requests.</param>
|
||||
/// <param name="logger">Logger for diagnostics.</param>
|
||||
/// <param name="sites">Repository for sites.</param>
|
||||
public FlowDebugService(
|
||||
ManagementActorHolder holder,
|
||||
AuthenticationStateProvider auth,
|
||||
|
||||
Reference in New Issue
Block a user