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
@@ -27,6 +27,7 @@ public class ArchitecturalConstraintTests
return Path.GetDirectoryName(csproj)!;
}
/// <summary>Verifies that the Commons project file declares none of the forbidden package references.</summary>
[Fact]
public void Csproj_ShouldNotHaveForbiddenPackageReferences()
{
@@ -51,6 +52,7 @@ public class ArchitecturalConstraintTests
}
}
/// <summary>Verifies that the Commons assembly references none of the forbidden assemblies.</summary>
[Fact]
public void Assembly_ShouldNotReferenceForbiddenAssemblies()
{
@@ -68,6 +70,7 @@ public class ArchitecturalConstraintTests
}
}
/// <summary>Verifies that Commons contains no service or actor implementations.</summary>
[Fact]
public void Commons_ShouldNotContainServiceOrActorImplementations()
{
@@ -99,6 +102,7 @@ public class ArchitecturalConstraintTests
}
}
/// <summary>Verifies that no source file calls <c>ToLocalTime</c>, since all timestamps are UTC.</summary>
[Fact]
public void SourceFiles_ShouldNotContainToLocalTime()
{
@@ -112,6 +116,7 @@ public class ArchitecturalConstraintTests
}
}
/// <summary>Verifies that no entity class carries Entity Framework attributes.</summary>
[Fact]
public void AllEntities_ShouldHaveNoEfAttributes()
{
@@ -145,6 +150,7 @@ public class ArchitecturalConstraintTests
}
}
/// <summary>Verifies that the retired <c>DebugStreamEvent</c> type does not exist.</summary>
[Fact]
public void DebugStreamEvent_ShouldNotExist()
{
@@ -154,6 +160,7 @@ public class ArchitecturalConstraintTests
Assert.Null(type);
}
/// <summary>Verifies that every enum has a singular name.</summary>
[Fact]
public void AllEnums_ShouldBeSingularNamed()
{
@@ -168,6 +175,7 @@ public class ArchitecturalConstraintTests
}
}
/// <summary>Verifies that every message type is a record.</summary>
[Fact]
public void AllMessageTypes_ShouldBeRecords()
{
@@ -187,6 +195,7 @@ public class ArchitecturalConstraintTests
}
}
/// <summary>Verifies that the key entities use <see cref="DateTimeOffset"/> for their timestamp properties.</summary>
[Fact]
public void KeyEntities_ShouldHaveDateTimeOffsetTimestamps()
{