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
@@ -28,7 +28,14 @@ public sealed class ScadaBridgeGroupRoleMapper : IGroupRoleMapper<string>
_roleMapper = roleMapper ?? throw new ArgumentNullException(nameof(roleMapper));
}
/// <inheritdoc />
/// <summary>
/// Maps a list of LDAP/AD group names to ScadaBridge roles using the wrapped
/// <see cref="RoleMapper"/> and returns the resulting role mapping with site-scope
/// information carried in the opaque <c>Scope</c> field.
/// </summary>
/// <param name="groups">The AD/LDAP group names to resolve into roles.</param>
/// <param name="ct">Cancellation token.</param>
/// <returns>A task that resolves to the group-to-role mapping including permitted site identifiers.</returns>
public async Task<GroupRoleMapping<string>> MapAsync(IReadOnlyList<string> groups, CancellationToken ct)
{
var result = await _roleMapper.MapGroupsToRolesAsync(groups, ct);