docs: backfill XML documentation across 756 files
v2-ci / build (push) Failing after 1m43s
v2-ci / unit-tests (tests/Core/ZB.MOM.WW.OtOpcUa.Cluster.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.ControlPlane.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Security.Tests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Has been skipped

Adds <summary>, <param>, <typeparam>, and <inheritdoc/> tags to public
members surfaced by commentchecker — resolves 5,847 of 5,869 issues
(99.6%) across three /fixdocs passes.
This commit is contained in:
Joseph Doherty
2026-05-28 08:10:17 -04:00
parent f9fc7dd2e1
commit 64e3fbe035
756 changed files with 9876 additions and 96 deletions
@@ -18,6 +18,7 @@ public sealed class CompiledScriptCacheTests
public int Count;
}
/// <summary>Verifies that the first call to GetOrCompile compiles the script and caches the evaluator.</summary>
[Fact]
public void First_call_compiles_and_caches()
{
@@ -30,6 +31,7 @@ public sealed class CompiledScriptCacheTests
cache.Contains("""return 42;""").ShouldBeTrue();
}
/// <summary>Verifies that identical source code returns the same cached evaluator instance.</summary>
[Fact]
public void Identical_source_returns_the_same_compiled_evaluator()
{
@@ -40,6 +42,7 @@ public sealed class CompiledScriptCacheTests
cache.Count.ShouldBe(1);
}
/// <summary>Verifies that different source code produces different evaluator instances.</summary>
[Fact]
public void Different_source_produces_different_evaluator()
{
@@ -50,6 +53,7 @@ public sealed class CompiledScriptCacheTests
cache.Count.ShouldBe(2);
}
/// <summary>Verifies that whitespace differences in source code cause cache misses.</summary>
[Fact]
public void Whitespace_difference_misses_cache()
{
@@ -61,6 +65,7 @@ public sealed class CompiledScriptCacheTests
cache.Count.ShouldBe(2);
}
/// <summary>Verifies that a cached evaluator produces correct results when executed.</summary>
[Fact]
public async Task Cached_evaluator_still_runs_correctly()
{
@@ -76,6 +81,7 @@ public sealed class CompiledScriptCacheTests
second.ShouldBe(21.0);
}
/// <summary>Verifies that failed compiles are evicted so that retried source with corrections can succeed.</summary>
[Fact]
public void Failed_compile_is_evicted_so_retry_with_corrected_source_works()
{
@@ -90,6 +96,7 @@ public sealed class CompiledScriptCacheTests
cache.Count.ShouldBe(1);
}
/// <summary>Verifies that Clear removes all cached entries.</summary>
[Fact]
public void Clear_drops_every_entry()
{
@@ -103,6 +110,7 @@ public sealed class CompiledScriptCacheTests
cache.Contains("""return 1;""").ShouldBeFalse();
}
/// <summary>Verifies that concurrent compiles of the same source deduplicate to a single compilation.</summary>
[Fact]
public void Concurrent_compiles_of_the_same_source_deduplicate()
{
@@ -124,6 +132,7 @@ public sealed class CompiledScriptCacheTests
cache.Count.ShouldBe(1);
}
/// <summary>Verifies that different TContext and TResult type parameter pairs use separate cache instances.</summary>
[Fact]
public void Different_TContext_TResult_pairs_use_separate_cache_instances()
{
@@ -142,6 +151,7 @@ public sealed class CompiledScriptCacheTests
boolCache.Contains("""return 1;""").ShouldBeFalse();
}
/// <summary>Verifies that null source throws ArgumentNullException.</summary>
[Fact]
public void Null_source_throws_ArgumentNullException()
{
@@ -149,6 +159,7 @@ public sealed class CompiledScriptCacheTests
Should.Throw<ArgumentNullException>(() => cache.GetOrCompile(null!));
}
/// <summary>Verifies that failed compile eviction does not remove a concurrent retry entry (Core.Scripting-006).</summary>
[Fact]
public void Failed_compile_eviction_does_not_remove_a_concurrent_retry_entry()
{
@@ -211,6 +222,7 @@ public sealed class CompiledScriptCacheTests
"the entry under the key must still be the fresh Lazy — an unconditional TryRemove(key) would have evicted it");
}
/// <summary>Verifies that the failed compile path still evicts its own faulted entry.</summary>
[Fact]
public void Failed_compile_path_still_evicts_its_own_faulted_entry()
{
@@ -222,6 +234,7 @@ public sealed class CompiledScriptCacheTests
cache.Count.ShouldBe(0, "faulted Lazy must still be evicted after compile failure");
}
/// <summary>Verifies that Clear uses value-scoped TryRemove so a race-inserted entry survives (Core.Scripting-014).</summary>
[Fact]
public void Clear_uses_value_scoped_TryRemove_so_a_race_inserted_entry_survives()
{
@@ -290,6 +303,7 @@ public sealed class CompiledScriptCacheTests
// --- Core.Scripting-008: collectible AssemblyLoadContext unload ---
/// <summary>Verifies that Dispose unloads the compiled script assembly load context (Core.Scripting-008).</summary>
[Fact]
public void Dispose_unloads_compiled_script_assembly_load_context()
{
@@ -342,6 +356,7 @@ public sealed class CompiledScriptCacheTests
return del.Method.Module.Assembly;
}
/// <summary>Verifies that Clear disposes every materialised evaluator (Core.Scripting-008).</summary>
[Fact]
public void Clear_disposes_every_materialised_evaluator()
{
@@ -382,6 +397,7 @@ public sealed class CompiledScriptCacheTests
return weaks;
}
/// <summary>Verifies that GetOrCompile after Dispose throws ObjectDisposedException.</summary>
[Fact]
public void GetOrCompile_after_Dispose_throws_ObjectDisposedException()
{