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:
Joseph Doherty
2026-06-03 12:34:34 -04:00
parent c6d9b20d9f
commit bd6c0b4d3d
481 changed files with 2550 additions and 1668 deletions
@@ -21,6 +21,7 @@ public sealed class AbCipDriverPageFormSerializationTests
UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip,
};
/// <summary>Verifies that serializing and deserializing an <see cref="AbCipDriverOptions"/> round-trip preserves all known fields.</summary>
[Fact]
public void RoundTrip_PreservesKnownFields()
{
@@ -71,6 +72,7 @@ public sealed class AbCipDriverPageFormSerializationTests
back.Tags[0].DataType.ShouldBe(AbCipDataType.Real);
}
/// <summary>Verifies that deserializing JSON with unknown fields drops them without error.</summary>
[Fact]
public void Deserialize_DropsUnknownFields()
{
@@ -86,6 +88,7 @@ public sealed class AbCipDriverPageFormSerializationTests
back.ProbeTimeoutSeconds.ShouldBe(10);
}
/// <summary>Verifies that a device row round-trips correctly through its definition.</summary>
[Fact]
public void DeviceRow_round_trips_through_definition()
{
@@ -101,6 +104,7 @@ public sealed class AbCipDriverPageFormSerializationTests
back.DeviceName.ShouldBe("PLC-A");
}
/// <summary>Verifies that editing one field of a device row preserves all other fields.</summary>
[Fact]
public void DeviceRow_preserves_unedited_fields()
{
@@ -116,6 +120,7 @@ public sealed class AbCipDriverPageFormSerializationTests
back.ConnectionSize.ShouldBe(4002);
}
/// <summary>Verifies that a tag row round-trips correctly through its definition.</summary>
[Fact]
public void TagRow_round_trips_through_definition()
{
@@ -134,6 +139,7 @@ public sealed class AbCipDriverPageFormSerializationTests
back.Writable.ShouldBeTrue();
}
/// <summary>Verifies that editing one field of a tag row preserves all other fields.</summary>
[Fact]
public void TagRow_preserves_unedited_fields()
{
@@ -154,6 +160,7 @@ public sealed class AbCipDriverPageFormSerializationTests
back.Members[0].Name.ShouldBe("Sub");
}
/// <summary>Verifies that device row validation rejects a duplicate host address.</summary>
[Fact]
public void ValidateDeviceRow_rejects_duplicate_host()
{
@@ -162,6 +169,7 @@ public sealed class AbCipDriverPageFormSerializationTests
.ShouldNotBeNull();
}
/// <summary>Verifies that tag row validation rejects a duplicate tag name.</summary>
[Fact]
public void ValidateTagRow_rejects_duplicate_name()
{
@@ -170,6 +178,7 @@ public sealed class AbCipDriverPageFormSerializationTests
.ShouldNotBeNull();
}
/// <summary>Verifies that device and tag lists survive a full options serialize/deserialize round-trip.</summary>
[Fact]
public void Device_and_tag_lists_survive_options_serialize_round_trip()
{