dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(xml): fill missing XML doc comments + strip task-tracking refs across src (fixdocs)

Browse Source 
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:
Joseph Doherty
2026-07-10 08:23:56 -04:00
parent 75007b9edd
commit 5a878b78d4
106 changed files with 580 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ZB.MOM.WW.ScadaBridge.CLI/Commands/TemplateCommands.cs
+18
View File
@@ -365,6 +365,15 @@ public static class TemplateCommands
/// The raw <paramref name="value"/> string is forwarded unchanged — for a List attribute it
/// is a JSON array, which the API/codec parses; the CLI does not reshape it.
/// </summary>
/// <param name="templateId">The template to add the attribute to.</param>
/// <param name="name">The attribute name.</param>
/// <param name="dataType">The attribute's data type.</param>
/// <param name="value">The raw attribute value, forwarded unchanged.</param>
/// <param name="description">An optional human-readable description.</param>
/// <param name="dataSource">An optional data source binding for the attribute.</param>
/// <param name="isLocked">Whether the attribute is locked from override in derived templates.</param>
/// <param name="elementType">The element type for a List-typed attribute; otherwise null.</param>
/// <returns>The command payload to send to the Management API.</returns>
internal static AddTemplateAttributeCommand BuildAddAttributeCommand(
int templateId, string name, string dataType, string? value,
string? description, string? dataSource, bool isLocked, string? elementType)
@@ -375,6 +384,15 @@ public static class TemplateCommands
/// The raw <paramref name="value"/> string is forwarded unchanged — for a List attribute it
/// is a JSON array, which the API/codec parses; the CLI does not reshape it.
/// </summary>
/// <param name="attributeId">The attribute to update.</param>
/// <param name="name">The attribute name.</param>
/// <param name="dataType">The attribute's data type.</param>
/// <param name="value">The raw attribute value, forwarded unchanged.</param>
/// <param name="description">An optional human-readable description.</param>
/// <param name="dataSource">An optional data source binding for the attribute.</param>
/// <param name="isLocked">Whether the attribute is locked from override in derived templates.</param>
/// <param name="elementType">The element type for a List-typed attribute; otherwise null.</param>
/// <returns>The command payload to send to the Management API.</returns>
internal static UpdateTemplateAttributeCommand BuildUpdateAttributeCommand(
int attributeId, string name, string dataType, string? value,
string? description, string? dataSource, bool isLocked, string? elementType)