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:
@@ -8,12 +8,16 @@ public sealed class HttpDeploymentConfigFetcher : IDeploymentConfigFetcher
|
||||
private readonly HttpClient _http;
|
||||
private readonly ILogger<HttpDeploymentConfigFetcher> _log;
|
||||
|
||||
/// <summary>Initializes the fetcher with its HTTP client and logger.</summary>
|
||||
/// <param name="http">The HTTP client used to call central's internal endpoint.</param>
|
||||
/// <param name="log">Logger for fetch diagnostics.</param>
|
||||
public HttpDeploymentConfigFetcher(HttpClient http, ILogger<HttpDeploymentConfigFetcher> log)
|
||||
{
|
||||
_http = http;
|
||||
_log = log;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<string> FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct)
|
||||
{
|
||||
var url = $"{centralFetchBaseUrl.TrimEnd('/')}/api/internal/deployments/{Uri.EscapeDataString(deploymentId)}/config";
|
||||
|
||||
@@ -12,13 +12,24 @@ public interface IDeploymentConfigFetcher
|
||||
/// in the X-Deployment-Token header. Throws <see cref="DeploymentConfigFetchException"/>
|
||||
/// on any non-success; a 404 (expired/superseded/unknown) sets IsSuperseded.
|
||||
/// </summary>
|
||||
/// <param name="centralFetchBaseUrl">Base URL of the central fetch endpoint.</param>
|
||||
/// <param name="deploymentId">Identifier of the deployment whose flattened config is being fetched.</param>
|
||||
/// <param name="token">Deployment token presented in the X-Deployment-Token header.</param>
|
||||
/// <param name="ct">Cancellation token for the request.</param>
|
||||
/// <returns>The flattened config JSON for the requested deployment.</returns>
|
||||
Task<string> FetchAsync(string centralFetchBaseUrl, string deploymentId, string token, CancellationToken ct);
|
||||
}
|
||||
|
||||
/// <summary>Raised when a deployment-config fetch fails. <see cref="IsSuperseded"/> is true on HTTP 404.</summary>
|
||||
public sealed class DeploymentConfigFetchException : Exception
|
||||
{
|
||||
/// <summary>Gets a value indicating whether the fetch failed because the deployment was expired, superseded, or unknown (HTTP 404).</summary>
|
||||
public bool IsSuperseded { get; }
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="DeploymentConfigFetchException"/> class.</summary>
|
||||
/// <param name="message">The error message.</param>
|
||||
/// <param name="isSuperseded">Whether the failure was caused by an expired, superseded, or unknown deployment (HTTP 404).</param>
|
||||
/// <param name="inner">The underlying exception, if any.</param>
|
||||
public DeploymentConfigFetchException(string message, bool isSuperseded, Exception? inner = null)
|
||||
: base(message, inner) => IsSuperseded = isSuperseded;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user