docs(src): add missing XML docs and strip tracking-ID comments
Sweep of 203 source files resolving CommentChecker findings: add <summary>/<param>/<returns>/<inheritdoc> where missing, and remove resolved task/issue tracking markers (Tests-NNN, Worker-NNN, Server-NNN, Task N) from code comments. Comment/doc-only — no logic changes. Server+Tests build clean under TreatWarningsAsErrors.
This commit is contained in:
@@ -19,12 +19,14 @@ public interface IWorkerClient : IAsyncDisposable
|
||||
|
||||
/// <summary>Initiates the handshake and enters ready state.</summary>
|
||||
/// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
Task StartAsync(CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>Sends a command to the worker and waits for a reply.</summary>
|
||||
/// <param name="command">Worker command to invoke.</param>
|
||||
/// <param name="timeout">Timeout for waiting for the reply.</param>
|
||||
/// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
|
||||
/// <returns>The worker's reply to the command.</returns>
|
||||
Task<WorkerCommandReply> InvokeAsync(
|
||||
WorkerCommand command,
|
||||
TimeSpan timeout,
|
||||
@@ -32,11 +34,13 @@ public interface IWorkerClient : IAsyncDisposable
|
||||
|
||||
/// <summary>Reads events from the worker as they arrive.</summary>
|
||||
/// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
|
||||
/// <returns>An asynchronous stream of worker events.</returns>
|
||||
IAsyncEnumerable<WorkerEvent> ReadEventsAsync(CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>Gracefully shuts down the worker by closing the connection.</summary>
|
||||
/// <param name="timeout">Timeout for shutdown.</param>
|
||||
/// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
Task ShutdownAsync(TimeSpan timeout, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>Terminates the worker process immediately with a diagnostic reason.</summary>
|
||||
|
||||
Reference in New Issue
Block a user