docs: complete XML doc coverage (returns, summaries, inheritdoc)

Resolve all 622 issues flagged by the enhanced CommentChecker: add missing
<returns> tags (incl. the standard phrasing on non-generic Task methods),
add missing <summary> tags, and replace misused/redundant <inheritdoc/> on
members that override or implement nothing with real documentation.
Documentation-only — no behavior change; solution builds clean.
This commit is contained in:
Joseph Doherty
2026-06-03 11:39:32 -04:00
parent a050170414
commit eabf270d71
208 changed files with 867 additions and 114 deletions
@@ -9,6 +9,7 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.ScriptAnalysis;
public interface ISharedScriptCatalog
{
/// <summary>Returns the parameter and return shapes for all registered shared scripts.</summary>
/// <returns>A task that resolves to the list of all shared script shapes.</returns>
Task<IReadOnlyList<ScriptShape>> GetShapesAsync();
/// <summary>
@@ -18,6 +19,7 @@ public interface ISharedScriptCatalog
/// </summary>
/// <param name="name">Name of the shared script to retrieve.</param>
/// <param name="cancellationToken">Cancellation token for the async lookup.</param>
/// <returns>A task that resolves to the matching shared script source, or null if none exists.</returns>
Task<SharedScriptSource?> GetByNameAsync(string name, CancellationToken cancellationToken = default);
}