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
@@ -11,9 +11,13 @@ namespace ZB.MOM.WW.ScadaBridge.Communication.Grpc;
public static class AlarmShelveStateCodec
{
/// <summary>Returns the wire string for a shelve state (the enum member name).</summary>
/// <param name="state">The shelve state to encode as a wire string.</param>
/// <returns>The enum member name as a string (e.g., "Unshelved", "OneShotShelved").</returns>
public static string ToWire(AlarmShelveState state) => state.ToString();
/// <summary>Parses a wire string back to a shelve state; defaults to <see cref="AlarmShelveState.Unshelved"/>.</summary>
/// <param name="wire">The wire string to parse; empty or unrecognized values return <see cref="AlarmShelveState.Unshelved"/>.</param>
/// <returns>The matching <see cref="AlarmShelveState"/>, or <see cref="AlarmShelveState.Unshelved"/> for unrecognized input.</returns>
public static AlarmShelveState Parse(string? wire) =>
Enum.TryParse<AlarmShelveState>(wire, ignoreCase: true, out var state)
? state