docs: fill missing XML docs and strip tracking IDs from src comments

Clears CommentChecker findings in src/ (3,280 -> 209, the remainder being false
positives like PLC-5/IEEE-754/M0.0) by adding missing summaries/params/returns,
normalising inheritdoc usage, and removing Gitea/review tracking IDs while keeping
the rationale they annotated. Comment-only: comment-stripped sources are identical
to the parent commit.
This commit is contained in:
Joseph Doherty
2026-10-15 06:14:58 -04:00
parent ebcbd81fca
commit 826312befe
430 changed files with 4434 additions and 3923 deletions
@@ -115,6 +115,7 @@ public sealed class TelemetryStreamClient : IDisposable
/// <param name="onEvent">Sink for each received raw <see cref="TelemetryEvent"/>.</param>
/// <param name="onError">Invoked once on an abnormal transport failure (the reconnect trigger).</param>
/// <param name="ct">Cancels the stream (normal shutdown).</param>
/// <returns>A task that represents the asynchronous operation.</returns>
/// <exception cref="ArgumentException"><paramref name="correlationId"/> is null or empty.</exception>
/// <exception cref="ArgumentNullException"><paramref name="onEvent"/> or <paramref name="onError"/> is null.</exception>
/// <exception cref="ObjectDisposedException">This client has been disposed.</exception>
@@ -171,7 +172,7 @@ public sealed class TelemetryStreamClient : IDisposable
}
}
/// <inheritdoc />
/// <summary>Marks the client disposed and releases the channel if this client created it.</summary>
public void Dispose()
{
_disposed = true;