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:
+4
@@ -85,9 +85,11 @@ public sealed class AbLegacyServerFixture : IAsyncLifetime
|
||||
}
|
||||
|
||||
/// <summary>Initializes the fixture asynchronously.</summary>
|
||||
/// <returns>A completed value task.</returns>
|
||||
public ValueTask InitializeAsync() => ValueTask.CompletedTask;
|
||||
|
||||
/// <summary>Disposes the fixture asynchronously.</summary>
|
||||
/// <returns>A completed value task.</returns>
|
||||
public ValueTask DisposeAsync() => ValueTask.CompletedTask;
|
||||
|
||||
/// <summary>
|
||||
@@ -96,6 +98,7 @@ public sealed class AbLegacyServerFixture : IAsyncLifetime
|
||||
/// fixture logic because attribute ctors fire before the collection fixture instance
|
||||
/// exists.
|
||||
/// </summary>
|
||||
/// <returns><see langword="true"/> if the server endpoint is reachable; otherwise <see langword="false"/>.</returns>
|
||||
public static bool IsServerAvailable()
|
||||
{
|
||||
var (host, port) = ResolveEndpoint();
|
||||
@@ -169,6 +172,7 @@ public static class KnownProfiles
|
||||
|
||||
/// <summary>Gets the profile for the specified PLC family.</summary>
|
||||
/// <param name="family">The PLC family.</param>
|
||||
/// <returns>The server profile for the specified family.</returns>
|
||||
public static AbLegacyServerProfile ForFamily(AbLegacyPlcFamily family) =>
|
||||
All.FirstOrDefault(p => p.Family == family)
|
||||
?? throw new ArgumentOutOfRangeException(nameof(family), family, "No integration profile for this family.");
|
||||
|
||||
Reference in New Issue
Block a user