docs: complete XML doc coverage (returns, summaries, inheritdoc)

Resolve all 622 issues flagged by the enhanced CommentChecker: add missing
<returns> tags (incl. the standard phrasing on non-generic Task methods),
add missing <summary> tags, and replace misused/redundant <inheritdoc/> on
members that override or implement nothing with real documentation.
Documentation-only — no behavior change; solution builds clean.
This commit is contained in:
Joseph Doherty
2026-06-03 11:39:32 -04:00
parent a050170414
commit eabf270d71
208 changed files with 867 additions and 114 deletions
@@ -89,17 +89,7 @@ public class SiteEventLogger : ISiteEventLogger, IDisposable
_writerLoop = Task.Run(ProcessWriteQueueAsync);
}
/// <summary>
/// SiteEventLogging-018: number of event writes that have failed (SQLite
/// error, disk full, bounded-queue overflow drop, etc.) since this logger
/// was created. Available for future Health Monitoring integration — the
/// counter is correct and observable, but the central health-metric
/// pipeline does not yet poll it, so a sustained non-zero value currently
/// goes unnoticed in production beyond the per-failure log line. Wiring
/// the metric into the 30-second site-metric publish is tracked
/// separately; promoted to <see cref="ISiteEventLogger"/> so the eventual
/// consumer reads it without a concrete-type downcast.
/// </summary>
/// <inheritdoc />
public long FailedWriteCount => Interlocked.Read(ref _failedWriteCount);
/// <summary>
@@ -110,6 +100,7 @@ public class SiteEventLogger : ISiteEventLogger, IDisposable
/// been disposed.
/// </summary>
/// <param name="action">The action to run against the shared connection.</param>
/// <returns><see langword="true"/> if the action was executed; <see langword="false"/> if the logger is disposed.</returns>
internal bool WithConnection(Action<SqliteConnection> action)
{
ArgumentNullException.ThrowIfNull(action);
@@ -128,6 +119,7 @@ public class SiteEventLogger : ISiteEventLogger, IDisposable
/// </summary>
/// <typeparam name="T">The return type of the function.</typeparam>
/// <param name="func">The function to run against the shared connection.</param>
/// <returns>The value returned by <paramref name="func"/>.</returns>
internal T WithConnection<T>(Func<SqliteConnection, T> func)
{
ArgumentNullException.ThrowIfNull(func);