docs: complete XML doc comments via fixdocs (2757 to 131 findings)

Add missing <returns>/<param>/<summary>/<typeparam> tags and clean up
misused inheritdoc across 481 files so the documented API surface is
complete. Documentation-only (zero code lines changed). The 131 remaining
findings are inheritdoc-style warnings deliberately left to preserve
hand-written implementation rationale (plan-decision notes, race-condition
explanations).
This commit is contained in:
Joseph Doherty
2026-06-03 12:34:34 -04:00
parent c6d9b20d9f
commit bd6c0b4d3d
481 changed files with 2550 additions and 1668 deletions
@@ -66,6 +66,7 @@ public sealed class CompiledScriptCacheTests
}
/// <summary>Verifies that a cached evaluator produces correct results when executed.</summary>
/// <returns>A task that represents the asynchronous test.</returns>
[Fact]
public async Task Cached_evaluator_still_runs_correctly()
{
@@ -27,6 +27,7 @@ public sealed class ScriptSandboxTests
}
/// <summary>Verifies that a script can compile, run, and read a seeded tag.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Happy_path_script_runs_and_reads_seeded_tag()
{
@@ -39,6 +40,7 @@ public sealed class ScriptSandboxTests
}
/// <summary>Verifies that SetVirtualTag records write operations.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task SetVirtualTag_records_the_write()
{
@@ -316,6 +318,7 @@ public sealed class ScriptSandboxTests
}
/// <summary>Verifies that an allowed generic type argument still compiles.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Allowed_generic_type_argument_still_compiles()
{
@@ -331,6 +334,7 @@ public sealed class ScriptSandboxTests
}
/// <summary>Verifies that typeof an allowed type still compiles.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Allowed_typeof_still_compiles()
{
@@ -342,6 +346,7 @@ public sealed class ScriptSandboxTests
}
/// <summary>Verifies that script exceptions propagate unwrapped.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Script_exception_propagates_unwrapped()
{
@@ -370,6 +375,7 @@ public sealed class ScriptSandboxTests
}
/// <summary>Verifies that LINQ Enumerable is available from scripts.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task Linq_Enumerable_is_available_from_scripts()
{
@@ -385,6 +391,7 @@ public sealed class ScriptSandboxTests
}
/// <summary>Verifies that DataValueSnapshot is usable in scripts.</summary>
/// <returns>A task that represents the asynchronous test operation.</returns>
[Fact]
public async Task DataValueSnapshot_is_usable_in_scripts()
{
@@ -14,6 +14,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Scripting.Tests;
public sealed class TimedScriptEvaluatorTests
{
/// <summary>Verifies that fast scripts complete under timeout and return value.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Fast_script_completes_under_timeout_and_returns_value()
{
@@ -28,6 +29,7 @@ public sealed class TimedScriptEvaluatorTests
}
/// <summary>Verifies that scripts longer than timeout throw ScriptTimeoutException.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Script_longer_than_timeout_throws_ScriptTimeoutException()
{
@@ -50,6 +52,7 @@ public sealed class TimedScriptEvaluatorTests
}
/// <summary>Verifies that caller cancellation takes precedence over timeout.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Caller_cancellation_takes_precedence_over_timeout()
{
@@ -108,6 +111,7 @@ public sealed class TimedScriptEvaluatorTests
}
/// <summary>Verifies that script exceptions propagate unwrapped.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Script_exception_propagates_unwrapped()
{
@@ -124,6 +128,7 @@ public sealed class TimedScriptEvaluatorTests
}
/// <summary>Verifies that ScriptTimeoutException message points at diagnostic path.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ScriptTimeoutException_message_points_at_diagnostic_path()
{
@@ -143,6 +148,7 @@ public sealed class TimedScriptEvaluatorTests
}
/// <summary>Verifies that caller cancellation wins even when timeout fires first.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Caller_cancellation_wins_even_when_timeout_fires_first()
{