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
@@ -74,6 +74,8 @@ public sealed class WnWrapAlarmConsumer : IMxAccessAlarmConsumer
/// <summary>
/// Test seam / explicit construction.
/// </summary>
/// <param name="client">The COM alarm consumer instance.</param>
/// <param name="maxAlarmsPerFetch">Maximum alarms per fetch call.</param>
public WnWrapAlarmConsumer(
wwAlarmConsumerClass client,
int maxAlarmsPerFetch)
@@ -393,6 +395,7 @@ public sealed class WnWrapAlarmConsumer : IMxAccessAlarmConsumer
/// silently dropped (no fault is recorded — the next poll will
/// resync).
/// </summary>
/// <param name="xml">The XML snapshot payload.</param>
public static Dictionary<Guid, MxAlarmSnapshotRecord> ParseSnapshotXml(string xml)
{
Dictionary<Guid, MxAlarmSnapshotRecord> records =
@@ -455,6 +458,8 @@ public sealed class WnWrapAlarmConsumer : IMxAccessAlarmConsumer
/// dashes (e.g. <c>"BCC4705395424D65BDAABCDEA6A32A73"</c>). Convert
/// to <see cref="Guid"/>'s canonical 8-4-4-4-12 layout.
/// </summary>
/// <param name="hex">The 32-character hex GUID string.</param>
/// <param name="guid">The parsed GUID, or Empty if parsing fails.</param>
public static bool TryParseHexGuid(string? hex, out Guid guid)
{
guid = Guid.Empty;
@@ -481,6 +486,7 @@ public sealed class WnWrapAlarmConsumer : IMxAccessAlarmConsumer
/// cleanly, fall back to a permissive ALL-priority/ALL-state form
/// so the worker doesn't fail to start.
/// </summary>
/// <param name="subscription">The subscription expression.</param>
internal static string ComposeXmlAlarmQuery(string subscription)
{
string node = Environment.MachineName;