docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Comment/XML-doc changes only:
- add summaries to ~10k test methods, fixtures, fakes and helpers
  (+ <param> on theories, <returns> on async Task methods,
  <inheritdoc/> on interface implementations the checker can resolve)
- strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N,
  #NN, Component-0NN) from comments, keeping the explanatory text;
  reword false positives in comments only
- real docs on fakes implementing BCL/library interfaces
  (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime)
- reword the last 5 src/ false positives (CWE-1236, failures-1,
  year-0001, M365)

Only non-comment edits: four one-line nested classes split across lines
so members can carry docs. Build 0 errors / 0 warnings.
This commit is contained in:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -15,6 +15,7 @@ public class InstanceTreeBuilderTests
private static Instance MakeInstance(int id, string uniqueName, int? areaId = null) =>
new(uniqueName) { Id = id, SiteId = 1, AreaId = areaId };
/// <summary>Verifies that areas are nested under their parents and root instances come after root areas.</summary>
[Fact]
public void Build_NestsAreasByParent_AndPutsRootInstancesAfterRootAreas()
{
@@ -54,6 +55,7 @@ public class InstanceTreeBuilderTests
Assert.Same(zulu, roots[2].Instance);
}
/// <summary>Verifies that areas and instances are sorted case-insensitively.</summary>
[Fact]
public void Build_SortsAreasAndInstancesCaseInsensitively()
{
@@ -67,6 +69,7 @@ public class InstanceTreeBuilderTests
Assert.Equal(new[] { "Alpha", "beta", "Apple", "zebra" }, roots.Select(n => n.Label));
}
/// <summary>Verifies that an area whose parent is missing becomes a root.</summary>
[Fact]
public void Build_OrphanedArea_BecomesARoot()
{
@@ -82,6 +85,7 @@ public class InstanceTreeBuilderTests
Assert.Equal("i:10", leaf.Key);
}
/// <summary>Verifies that an instance with an unknown area surfaces at the root.</summary>
[Fact]
public void Build_InstanceWithUnknownArea_SurfacesAtRoot()
{
@@ -96,6 +100,7 @@ public class InstanceTreeBuilderTests
Assert.Same(stranded, roots[1].Instance);
}
/// <summary>Verifies that an instance with an unknown area can still be found by the filter.</summary>
[Fact]
public void Build_InstanceWithUnknownArea_StaysFilterable()
{
@@ -108,6 +113,7 @@ public class InstanceTreeBuilderTests
Assert.Empty(InstanceTreeBuilder.Build([line1], [stranded], filter: "nomatch"));
}
/// <summary>Verifies that deeply nested areas wire their children at every level.</summary>
[Fact]
public void Build_DeepNesting_WiresChildrenAtEveryLevel()
{
@@ -129,6 +135,7 @@ public class InstanceTreeBuilderTests
Assert.False(leaf.HasChildren);
}
/// <summary>Verifies that cyclic parent area ids neither loop forever nor throw.</summary>
[Fact]
public void Build_CyclicParentAreaIds_DoNotLoopOrThrow()
{
@@ -144,6 +151,7 @@ public class InstanceTreeBuilderTests
Assert.Empty(roots);
}
/// <summary>Verifies that the filter matches instance names only, so an area name match alone is not enough.</summary>
[Fact]
public void Build_Filter_MatchesInstanceNamesOnly_AreaNameMatchIsNotEnough()
{
@@ -160,6 +168,7 @@ public class InstanceTreeBuilderTests
Assert.Equal("i:11", Assert.Single(root.Children).Key);
}
/// <summary>Verifies that the filter keeps matching instances with their ancestors and drops empty branches.</summary>
[Fact]
public void Build_Filter_KeepsMatchingInstancesWithAncestors_DropsEmptyBranches()
{
@@ -180,6 +189,7 @@ public class InstanceTreeBuilderTests
Assert.Equal("i:10", leaf.Key);
}
/// <summary>Verifies that a whitespace-only filter is treated as no filter.</summary>
[Fact]
public void Build_Filter_WhitespaceMeansNoFilter()
{
@@ -193,6 +203,7 @@ public class InstanceTreeBuilderTests
Assert.Single(roots[0].Children);
}
/// <summary>Verifies that null or empty inputs produce an empty tree.</summary>
[Fact]
public void Build_NullOrEmptyInputs_ReturnEmpty()
{
@@ -207,6 +218,7 @@ public class InstanceTreeBuilderTests
Assert.Equal("a:1", Assert.Single(areasOnly).Key);
}
/// <summary>Verifies that an area with no instances is still shown when no filter is applied.</summary>
[Fact]
public void Build_AreaWithNoInstancesAndNoFilter_IsStillShown()
{