docs(comments): strip internal task/milestone/bundle bookkeeping from code comments
Remove project bookkeeping citations from shipped code comments across the solution: hyphenated task IDs (WP-14, StoreAndForward-025), milestone/task/ issue refs (M3, Task 4, Audit Log #23, #21), Bundle X task-bundle labels, and C/D/K/S/T phase labels. Comment text only — no code logic, string/log literals, or XML-doc structure changed. Genuine descriptions are preserved (only the citation is stripped), and technical lookalikes are retained (UTF-8, SHA-256, T00:00:00, M365, UTC-5, pre-C4/pre-C5 schema versions). Flagged by the new CommentChecker TaskReferenceInComment / TrackingReferenceInComment checks plus targeted grep passes; full solution builds clean, append-only guard tests pass.
This commit is contained in:
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.InboundApi;
|
||||
namespace ZB.MOM.WW.ScadaBridge.InboundAPI;
|
||||
|
||||
/// <summary>
|
||||
/// InboundAPI-014: validates a method script's return value against the method's
|
||||
/// Validates a method script's return value against the method's
|
||||
/// declared <c>ReturnDefinition</c>. <c>Component-InboundAPI.md</c> ("Return Value
|
||||
/// Definition" / "Response Format") states the success body has "fields matching
|
||||
/// the return value definition"; this is the response-side mirror of
|
||||
@@ -18,7 +18,7 @@ namespace ZB.MOM.WW.ScadaBridge.InboundAPI;
|
||||
/// </para>
|
||||
///
|
||||
/// <para>
|
||||
/// InboundAPI-M2.6: validation is RECURSIVE and type-aware — declared object
|
||||
/// Validation is RECURSIVE and type-aware — declared object
|
||||
/// fields are validated against their declared (nested) types, list elements
|
||||
/// against the declared element type, and scalars at any depth — with
|
||||
/// path-qualified errors. The recursion is shared with
|
||||
@@ -37,7 +37,7 @@ public static class ReturnValueValidator
|
||||
/// <param name="resultJson">The JSON-serialized script return value to validate.</param>
|
||||
/// <param name="returnDefinition">JSON Schema describing the method's return value, or null/empty to skip validation. The legacy flat-array form is also accepted.</param>
|
||||
/// <param name="resolveRef">
|
||||
/// M9-T32b: optional JSON-Schema <c>$ref</c> resolution seam mapping a
|
||||
/// Optional JSON-Schema <c>$ref</c> resolution seam mapping a
|
||||
/// <c>{"$ref":"lib:Name"}</c> reference target's name to the referenced schema JSON
|
||||
/// (or <c>null</c> when the library entry does not exist). The executor pre-loads the
|
||||
/// shared-schema library (backed by <c>ISharedSchemaRepository</c>) and supplies it
|
||||
@@ -58,7 +58,7 @@ public static class ReturnValueValidator
|
||||
return ReturnValidationResult.Valid();
|
||||
}
|
||||
|
||||
// M9-T32b: parse through the ref-COLLECTING path so a {"$ref":"lib:Name"} the
|
||||
// Parse through the ref-COLLECTING path so a {"$ref":"lib:Name"} the
|
||||
// resolver can satisfy is resolved inline, and a dangling/cyclic/over-depth ref is
|
||||
// surfaced as a descriptive "could not be resolved" message rather than an opaque
|
||||
// "Invalid return definition" from a swallowed JsonException.
|
||||
|
||||
Reference in New Issue
Block a user