docs+ui: backfill XML doc comments and finish dashboard layout pass

Adds missing <summary>/<param> XML docs across 99 server, worker, and test
files so CommentChecker reports zero issues (TreatWarningsAsErrors needs the
analyzer clean). Bundles in WIP dashboard work: NavSection extraction,
MainLayout/site.css/js styling alignment, and DashboardOptions/Auth tweaks.
This commit is contained in:
Joseph Doherty
2026-05-27 14:20:10 -04:00
parent 382861c602
commit 615b487a77
110 changed files with 1473 additions and 192 deletions
@@ -30,11 +30,15 @@ public sealed class MxAccessAlarmEventSink : IMxAccessEventSink
private string sessionId = string.Empty;
private bool attached;
/// <summary>Initializes a new instance of the MxAccessAlarmEventSink class with default dependencies.</summary>
public MxAccessAlarmEventSink()
: this(new MxAccessEventQueue(), new MxAccessEventMapper())
{
}
/// <summary>Initializes a new instance of the MxAccessAlarmEventSink class.</summary>
/// <param name="eventQueue">Queue for buffering converted alarm events.</param>
/// <param name="eventMapper">Converter for alarm transitions to protobuf format.</param>
public MxAccessAlarmEventSink(
MxAccessEventQueue eventQueue,
MxAccessEventMapper eventMapper)
@@ -71,6 +75,17 @@ public sealed class MxAccessAlarmEventSink : IMxAccessEventSink
/// tests can drive the proto build path without a real COM event
/// source.
/// </summary>
/// <param name="alarmFullReference">The fully qualified alarm object reference.</param>
/// <param name="sourceObjectReference">The object that sourced the alarm.</param>
/// <param name="alarmTypeName">The alarm type name.</param>
/// <param name="transitionKind">The kind of alarm transition.</param>
/// <param name="severity">The alarm severity level.</param>
/// <param name="originalRaiseTimestampUtc">The original alarm raise timestamp in UTC, if available.</param>
/// <param name="transitionTimestampUtc">The timestamp of this transition in UTC.</param>
/// <param name="operatorUser">The user who performed the operation, if applicable.</param>
/// <param name="operatorComment">The operator's comment, if any.</param>
/// <param name="category">The alarm category.</param>
/// <param name="description">The alarm description.</param>
internal void EnqueueTransition(
string alarmFullReference,
string sourceObjectReference,