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

docs: complete XML doc comments via fixdocs (2757 to 131 findings)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
tests/Tooling/ZB.MOM.WW.OtOpcUa.Analyzers.Tests/UnwrappedCapabilityCallAnalyzerTests.cs
+26
View File
@@ -83,6 +83,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Resilience {
""";
/// <summary>Verifies that a direct ReadAsync call in the Server namespace trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_ReadAsync_Call_InServerNamespace_TripsDiagnostic()
{
@@ -107,6 +108,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a wrapped ReadAsync call inside a CapabilityInvoker lambda passes cleanly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Wrapped_ReadAsync_InsideCapabilityInvokerLambda_PassesCleanly()
{
@@ -131,6 +133,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a direct write without wrapper trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DirectWrite_WithoutWrapper_TripsDiagnostic()
{
@@ -154,6 +157,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a discovery call without wrapper trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Discovery_Call_WithoutWrapper_TripsDiagnostic()
{
@@ -176,6 +180,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a call outside of a lambda but inside an invoker call still trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Call_OutsideOfLambda_ButInsideInvokerCall_StillTripsDiagnostic()
{
@@ -210,6 +215,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// -----------------------------------------------------------------------
/// <summary>Verifies that a direct SubscribeAsync call trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_SubscribeAsync_Call_TripsDiagnostic()
{
@@ -234,6 +240,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a wrapped SubscribeAsync call inside a CapabilityInvoker lambda passes cleanly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Wrapped_SubscribeAsync_InsideCapabilityInvokerLambda_PassesCleanly()
{
@@ -264,6 +271,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// -----------------------------------------------------------------------
/// <summary>Verifies that a direct SubscribeAlarmsAsync call trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_SubscribeAlarmsAsync_Call_TripsDiagnostic()
{
@@ -287,6 +295,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a wrapped SubscribeAlarmsAsync call inside a CapabilityInvoker lambda passes cleanly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Wrapped_SubscribeAlarmsAsync_InsideCapabilityInvokerLambda_PassesCleanly()
{
@@ -316,6 +325,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// -----------------------------------------------------------------------
/// <summary>Verifies that a direct ReadRawAsync call on an interface trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_ReadRawAsync_OnInterface_TripsDiagnostic()
{
@@ -339,6 +349,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a direct ReadProcessedAsync call on an interface trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_ReadProcessedAsync_OnInterface_TripsDiagnostic()
{
@@ -362,6 +373,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a direct ReadAtTimeAsync call on an interface trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_ReadAtTimeAsync_OnInterface_TripsDiagnostic()
{
@@ -388,6 +400,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a wrapped ReadRawAsync call inside a CapabilityInvoker lambda passes cleanly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Wrapped_ReadRawAsync_InsideCapabilityInvokerLambda_PassesCleanly()
{
@@ -417,6 +430,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// -----------------------------------------------------------------------
/// <summary>Verifies that a direct HistoryRead call on a concrete driver trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_HistoryRead_OnConcreteDriver_TripsDiagnostic()
{
@@ -451,6 +465,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// -----------------------------------------------------------------------
/// <summary>Verifies that a synchronous GetHostStatuses call is not flagged.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Synchronous_GetHostStatuses_IsNotFlagged()
{
@@ -475,6 +490,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// -----------------------------------------------------------------------
/// <summary>Verifies that a concrete driver with a renamed read method still trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConcreteDriver_RenamedReadMethod_StillTripsDiagnostic()
{
@@ -520,6 +536,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// -----------------------------------------------------------------------
/// <summary>Verifies that a wrapped WriteAsync call inside ExecuteWriteAsync passes cleanly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Wrapped_WriteAsync_InsideExecuteWriteAsync_PassesCleanly()
{
@@ -549,6 +566,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// -----------------------------------------------------------------------
/// <summary>Verifies that a guarded call inside a nested non-wrapper lambda trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GuardedCall_InsideNestedNonWrapperLambda_TripsDiagnostic()
{
@@ -578,6 +596,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a guarded call inside a wrapper lambda inside a non-wrapper lambda passes cleanly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GuardedCall_InsideWrapperLambda_InsideNonWrapperLambda_PassesCleanly()
{
@@ -615,6 +634,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// =======================================================================
/// <summary>Verifies that a guarded call inside an alarm surface invoker method wrapped by CapabilityInvoker passes cleanly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task GuardedCall_InsideAlarmSurfaceInvokerMethod_WrappedByCapabilityInvoker_PassesCleanly()
{
@@ -653,6 +673,7 @@ namespace ZB.MOM.WW.OtOpcUa.Core.Resilience.Test {
// =======================================================================
/// <summary>Verifies that a non-guarded async call does not trip the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NonGuardedAsyncCall_DoesNotTrip()
{
@@ -681,6 +702,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
// =======================================================================
/// <summary>Verifies that a compilation without guarded interface references emits no diagnostics.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Compilation_WithoutGuardedInterfaceReferences_EmitsNoDiagnostics()
{
@@ -709,6 +731,7 @@ namespace SomeOther {
// =======================================================================
/// <summary>Verifies that a direct ReadAtTimeAsync call on a concrete driver inheriting the DIM trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_ReadAtTimeAsync_OnConcreteDriverInheritingDIM_TripsDiagnostic()
{
@@ -745,6 +768,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a direct ReadEventsAsync call on a concrete driver inheriting the DIM trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_ReadEventsAsync_OnConcreteDriverInheritingDIM_TripsDiagnostic()
{
@@ -775,6 +799,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a direct ReadAtTimeAsync call on a concrete driver overriding the DIM trips the diagnostic.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Direct_ReadAtTimeAsync_OnConcreteDriverOverridingDIM_TripsDiagnostic()
{
@@ -807,6 +832,7 @@ namespace ZB.MOM.WW.OtOpcUa.Server {
}
/// <summary>Verifies that a wrapped ReadAtTimeAsync DIM call inside a CapabilityInvoker lambda passes cleanly.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Wrapped_ReadAtTimeAsync_DIM_InsideCapabilityInvokerLambda_PassesCleanly()
{