docs(xml): fill missing XML doc comments + strip task-tracking refs across src (fixdocs)
Add missing <summary>/<param>/<returns>/<typeparam> tags and switch interface implementations to <inheritdoc/> across 106 files; strip project bookkeeping identifiers (Task NN, #05-TNN, PLAN-04, StoreAndForward-0NN) from shipped code comments while preserving the descriptive rationale. Comment-only: zero code-logic lines changed; solution builds 0/0. Claude-Session: https://claude.ai/code/session_01MtdgwpEeCUn6cUA5f1LMPj
This commit is contained in:
@@ -3,7 +3,14 @@ namespace ZB.MOM.WW.ScadaBridge.DelmiaNotifier;
|
||||
/// <summary>Outcome of parsing the command line: success carries the payload, failure carries a human reason.</summary>
|
||||
internal sealed record ParseResult(bool Ok, RecipeDownload? Payload, string? Error)
|
||||
{
|
||||
/// <summary>Builds a successful parse result carrying the parsed payload.</summary>
|
||||
/// <param name="payload">The successfully parsed recipe download payload.</param>
|
||||
/// <returns>A <see cref="ParseResult"/> with <see cref="Ok"/> set to <c>true</c>.</returns>
|
||||
public static ParseResult Success(RecipeDownload payload) => new(true, payload, null);
|
||||
|
||||
/// <summary>Builds a failed parse result carrying a human-readable reason.</summary>
|
||||
/// <param name="error">The human-readable failure reason.</param>
|
||||
/// <returns>A <see cref="ParseResult"/> with <see cref="Ok"/> set to <c>false</c>.</returns>
|
||||
public static ParseResult Fail(string error) => new(false, null, error);
|
||||
}
|
||||
|
||||
@@ -13,6 +20,9 @@ internal sealed record ParseResult(bool Ok, RecipeDownload? Payload, string? Err
|
||||
/// </summary>
|
||||
internal static class ArgParser
|
||||
{
|
||||
/// <summary>Parses the legacy WWNotifier command-line flags into a <see cref="RecipeDownload"/> payload.</summary>
|
||||
/// <param name="args">The raw command-line arguments.</param>
|
||||
/// <returns>A successful <see cref="ParseResult"/> with the parsed payload, or a failed one with the reason.</returns>
|
||||
public static ParseResult Parse(string[] args)
|
||||
{
|
||||
var payload = new RecipeDownload();
|
||||
|
||||
Reference in New Issue
Block a user