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
@@ -17,6 +17,7 @@ namespace ZB.MOM.WW.MxGateway.Worker.Tests.MxAccess;
/// </summary>
public sealed class MxAccessValueCacheTests
{
/// <summary>Verifies that cache returns the last value with incrementing versions.</summary>
[Fact]
public void Set_ThenTryGet_ReturnsLastValueWithIncrementingVersion()
{
@@ -45,6 +46,7 @@ public sealed class MxAccessValueCacheTests
Assert.Equal(999, other.Value.Int32Value);
}
/// <summary>Verifies that TryGet returns false for unknown handles.</summary>
[Fact]
public void TryGet_WithUnknownHandle_ReturnsFalse()
{
@@ -53,6 +55,7 @@ public sealed class MxAccessValueCacheTests
Assert.False(cache.TryGet(serverHandle: 7, itemHandle: 21, out _));
}
/// <summary>Verifies that Remove drops entries and resets versions.</summary>
[Fact]
public void Remove_DropsEntryAndResetsVersion()
{
@@ -71,6 +74,7 @@ public sealed class MxAccessValueCacheTests
Assert.Equal(1UL, reset.Version);
}
/// <summary>Verifies that CurrentVersion returns zero for unknown handles and the latest for known ones.</summary>
[Fact]
public void CurrentVersion_ReturnsZeroForUnknown_AndLatestForKnown()
{
@@ -83,23 +87,7 @@ public sealed class MxAccessValueCacheTests
Assert.Equal(2UL, cache.CurrentVersion(7, 21));
}
/// <summary>
/// Worker.Tests-020: pins the contract that <c>TryWaitForUpdate</c>
/// returns <c>false</c> when the deadline has elapsed with no
/// <c>Set</c>, yields a default <c>CachedValue</c>, and invokes
/// <c>pumpStep</c> at least once so MXAccess Windows messages can
/// be dispatched. Earlier revisions of this test asserted both an
/// elapsed-time floor (<c>stopwatch.ElapsedMilliseconds &gt;= 60</c>)
/// and <c>pumpCalls &gt; 1</c> — the same wall-clock-floor race
/// pattern Worker.Tests-003/004/013 corrected. To eliminate the
/// timing dependency entirely (the equivalent of a manual time
/// source for a <c>DateTime.UtcNow</c>-based deadline), the test
/// now supplies a deadline already in the past: the loop pumps
/// once, observes the passed deadline, and returns false
/// deterministically without any <c>Thread.Sleep</c>. The
/// deadline-honouring contract is what this test exists to pin;
/// elapsed time and pump-iteration count are incidental.
/// </summary>
/// <summary>Verifies that TryWaitForUpdate returns false after the deadline expires.</summary>
[Fact]
public void TryWaitForUpdate_ReturnsFalseAfterDeadline_WhenNoSetOccurs()
{
@@ -126,6 +114,7 @@ public sealed class MxAccessValueCacheTests
Assert.Equal(1, pumpCalls);
}
/// <summary>Verifies that TryWaitForUpdate returns true when the cache is updated after the baseline.</summary>
[Fact]
public async Task TryWaitForUpdate_ReturnsTrue_WhenSetFiresAfterBaselineVersion()
{