docs: complete XML doc comments via fixdocs (2757 to 131 findings)
Add missing <returns>/<param>/<summary>/<typeparam> tags and clean up misused inheritdoc across 481 files so the documented API surface is complete. Documentation-only (zero code lines changed). The 131 remaining findings are inheritdoc-style warnings deliberately left to preserve hand-written implementation rationale (plan-decision notes, race-condition explanations).
This commit is contained in:
@@ -6,6 +6,11 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Tests.Pickers;
|
||||
|
||||
public sealed class AbLegacyAddressBuilderTests
|
||||
{
|
||||
/// <summary>Verifies that Build_Canonical returns the expected canonical address string for each file type.</summary>
|
||||
/// <param name="fileType">The file type letter (e.g., N, B, F).</param>
|
||||
/// <param name="fileNumber">The file number.</param>
|
||||
/// <param name="element">The element index within the file.</param>
|
||||
/// <param name="expected">The expected canonical address string.</param>
|
||||
[Theory]
|
||||
[InlineData("N", 7, 0, "N7:0")]
|
||||
[InlineData("B", 3, 1, "B3:1")]
|
||||
|
||||
@@ -6,6 +6,10 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Tests.Pickers;
|
||||
|
||||
public sealed class FocasAddressBuilderTests
|
||||
{
|
||||
/// <summary>Verifies that Build produces the canonical group:parameterId address string.</summary>
|
||||
/// <param name="group">The FOCAS parameter group name.</param>
|
||||
/// <param name="parameterId">The FOCAS parameter ID.</param>
|
||||
/// <param name="expected">The expected canonical address string.</param>
|
||||
[Theory]
|
||||
[InlineData("axis", 5, "axis:5")]
|
||||
[InlineData("spindle", 0, "spindle:0")]
|
||||
|
||||
+5
@@ -6,6 +6,11 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Tests.Pickers;
|
||||
|
||||
public sealed class HistorianWonderwareAddressBuilderTests
|
||||
{
|
||||
/// <summary>Verifies that Build produces the canonical address query string for various tag/mode/interval combinations.</summary>
|
||||
/// <param name="tag">The tag name input.</param>
|
||||
/// <param name="mode">The retrieval mode input.</param>
|
||||
/// <param name="interval">The interval input.</param>
|
||||
/// <param name="expected">The expected canonical address string.</param>
|
||||
[Theory]
|
||||
[InlineData("SysTimeHour", "Cyclic", 60, "SysTimeHour?mode=Cyclic&interval=60")]
|
||||
[InlineData("ReactorTemp", "Last", 1, "ReactorTemp?mode=Last&interval=1")]
|
||||
|
||||
@@ -6,6 +6,11 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Tests.Pickers;
|
||||
|
||||
public sealed class ModbusAddressBuilderTests
|
||||
{
|
||||
/// <summary>Verifies that Build produces canonical Modbus address strings for all supported register types.</summary>
|
||||
/// <param name="type">The Modbus register type.</param>
|
||||
/// <param name="offset">The register offset.</param>
|
||||
/// <param name="length">The data length.</param>
|
||||
/// <param name="expected">The expected canonical address string.</param>
|
||||
[Theory]
|
||||
[InlineData("Holding", 1, 1, "4x00001-1")]
|
||||
[InlineData("Coil", 0, 1, "0x00000-1")]
|
||||
@@ -15,6 +20,7 @@ public sealed class ModbusAddressBuilderTests
|
||||
public void Build_Canonical(string type, int offset, int length, string expected)
|
||||
=> ModbusAddressBuilder.Build(type, offset, length).ShouldBe(expected);
|
||||
|
||||
/// <summary>Verifies that Build falls back to the Holding register type for unknown type strings.</summary>
|
||||
[Fact]
|
||||
public void Build_UnknownType_FallsBackToHolding()
|
||||
=> ModbusAddressBuilder.Build("Unknown", 1, 1).ShouldBe("4x00001-1");
|
||||
|
||||
@@ -6,6 +6,12 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Tests.Pickers;
|
||||
|
||||
public sealed class S7AddressBuilderTests
|
||||
{
|
||||
/// <summary>Verifies that Build produces the canonical S7 address string for all supported areas and types.</summary>
|
||||
/// <param name="area">The S7 memory area (DB / M / I / Q).</param>
|
||||
/// <param name="dbNumber">The DB number (relevant only for the DB area).</param>
|
||||
/// <param name="offset">The byte offset within the area.</param>
|
||||
/// <param name="s7Type">The S7 data type qualifier (X / B / W / D / REAL).</param>
|
||||
/// <param name="expected">The expected canonical address string.</param>
|
||||
[Theory]
|
||||
[InlineData("DB", 10, 20, "REAL", "DB10.DBD20:REAL")]
|
||||
[InlineData("DB", 1, 0, "X", "DB1.DBX0.0:X")]
|
||||
|
||||
Reference in New Issue
Block a user