docs: complete XML-doc coverage and strip internal tracking IDs from code comments
Resolve all CommentChecker findings across the gateway server, worker, tests, and .NET client (314 -> 0 real issues): add missing <returns>/<summary>/<param> on public and test members, convert Stream/interface overrides to <inheritdoc/>, and remove internal task/issue tracking IDs (SEC-*, IPC-*, WRK-*, GWC-*, TST-*, Client.Dotnet-*) from shipped code documentation while preserving the design rationale prose. Shipped comments should not carry internal bookkeeping, and complete XML docs keep the analyzer/TreatWarningsAsErrors gate and generated API docs clean. The 6 remaining flags are heuristic false positives (MD5, UTC-4, capacity-1, near-1601) left intact so real documentation is not corrupted. Claude-Session: https://claude.ai/code/session_01DMXXvNuPekkkrTEyPNxEkW
This commit is contained in:
@@ -12,7 +12,7 @@ public sealed class WorkerFrameProtocolOptions
|
||||
|
||||
/// <summary>
|
||||
/// Upper ceiling the worker will accept for a gateway-negotiated frame maximum
|
||||
/// (<c>GatewayHello.max_frame_bytes</c>, IPC-02). Matches the gateway's own configuration ceiling
|
||||
/// (<c>GatewayHello.max_frame_bytes</c>). Matches the gateway's own configuration ceiling
|
||||
/// so a nonsensical negotiated value is rejected at the handshake rather than driving an absurd
|
||||
/// per-frame allocation. 256 MiB.
|
||||
/// </summary>
|
||||
@@ -109,15 +109,15 @@ public sealed class WorkerFrameProtocolOptions
|
||||
/// <summary>
|
||||
/// Gets the maximum worker-frame message size in bytes. Initialized from the constructor and
|
||||
/// then adopted once from the gateway-negotiated value during the startup handshake
|
||||
/// (<c>GatewayHello.max_frame_bytes</c>, IPC-02) via <see cref="AdoptNegotiatedMaxMessageBytes"/>,
|
||||
/// (<c>GatewayHello.max_frame_bytes</c>) via <see cref="AdoptNegotiatedMaxMessageBytes"/>,
|
||||
/// before the message loop starts. Not mutated afterwards, so the single-threaded handshake write
|
||||
/// is safe for the reader/writer that share this instance.
|
||||
/// </summary>
|
||||
public int MaxMessageBytes { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Adopts the gateway-negotiated frame maximum conveyed in <c>GatewayHello.max_frame_bytes</c>
|
||||
/// (IPC-02). A value of 0 (an older gateway that never set the field) is ignored and the
|
||||
/// Adopts the gateway-negotiated frame maximum conveyed in <c>GatewayHello.max_frame_bytes</c>.
|
||||
/// A value of 0 (an older gateway that never set the field) is ignored and the
|
||||
/// constructor default is kept. A value above <see cref="MaxNegotiableFrameBytes"/> is rejected.
|
||||
/// </summary>
|
||||
/// <param name="negotiatedMaxFrameBytes">The gateway-negotiated maximum, or 0 for "keep default".</param>
|
||||
|
||||
Reference in New Issue
Block a user