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/Client/ZB.MOM.WW.OtOpcUa.Client.UI.Tests/MainWindowViewModelTests.cs
+27
View File
@@ -76,6 +76,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that a successful connect command updates the shell into the connected state.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_TransitionsToConnected()
{
@@ -89,6 +90,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that the initial browse tree is loaded after a successful connect.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_LoadsRootNodes()
{
@@ -101,6 +103,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that redundancy details are fetched and exposed after connecting.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_FetchesRedundancyInfo()
{
@@ -114,6 +117,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that the session label shows the connected server and session identity.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_SetsSessionLabel()
{
@@ -126,6 +130,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that disconnect returns the shell to the disconnected state.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DisconnectCommand_TransitionsToDisconnected()
{
@@ -140,6 +145,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that disconnect clears session-specific UI state such as browse data and redundancy details.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Disconnect_ClearsStateAndChildren()
{
@@ -155,6 +161,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that connection-state events from the client update the shell status text and state.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectionStateChangedEvent_UpdatesState()
{
@@ -171,6 +178,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that selecting a tree node updates the dependent read/write and history panels.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SelectedTreeNode_PropagatesToChildViewModels()
{
@@ -186,6 +194,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that a successful connect propagates connected state into the child tabs.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_PropagatesIsConnectedToChildViewModels()
{
@@ -200,6 +209,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that disconnect propagates disconnected state into the child tabs.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DisconnectCommand_PropagatesIsConnectedFalseToChildViewModels()
{
@@ -215,6 +225,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that failed connection attempts restore the disconnected shell state and surface the error text.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectFailure_RevertsToDisconnected()
{
@@ -229,6 +240,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that connection-state transitions raise property-changed notifications for UI binding updates.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task PropertyChanged_FiredForConnectionState()
{
@@ -260,6 +272,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that failover endpoint text is parsed into connection settings on connect.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_MapsFailoverUrlsToSettings()
{
@@ -276,6 +289,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that empty failover text is normalized to no configured failover endpoints.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_MapsEmptyFailoverUrlsToNull()
{
@@ -289,6 +303,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that the configured session timeout is passed into the connection settings.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_MapsSessionTimeoutToSettings()
{
@@ -302,6 +317,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that the auto-accept certificate toggle is passed into the connection settings.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_MapsAutoAcceptCertificatesToSettings()
{
@@ -315,6 +331,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that a custom certificate store path is passed into the connection settings.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_MapsCertificateStorePathToSettings()
{
@@ -328,6 +345,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that subscribing selected nodes adds subscriptions and switches the shell to the subscriptions tab.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SubscribeSelectedNodesCommand_SubscribesAndSwitchesToTab()
{
@@ -348,6 +366,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that subscribing selected nodes is a no-op when nothing is selected.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SubscribeSelectedNodesCommand_DoesNothing_WhenNoSelection()
{
@@ -361,6 +380,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that the history command targets the selected node and switches the shell to the history tab.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ViewHistoryForSelectedNodeCommand_SetsNodeAndSwitchesToTab()
{
@@ -378,6 +398,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that history actions are enabled when a variable node is selected.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UpdateHistoryEnabledForSelection_TrueForVariableNode()
{
@@ -395,6 +416,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that history actions stay disabled when an object node rather than a variable is selected.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UpdateHistoryEnabledForSelection_FalseForObjectNode()
{
@@ -470,6 +492,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that successful connections persist the current connection settings.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_SavesSettingsOnSuccess()
{
@@ -487,6 +510,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that failed connection attempts do not overwrite saved settings.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_DoesNotSaveOnFailure()
{
@@ -500,6 +524,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that active subscriptions are persisted when the shell disconnects.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_SavesSubscribedNodes()
{
@@ -522,6 +547,7 @@ public class MainWindowViewModelTests
/// view model must leave RedundancyInfo null without crashing or hiding the diagnostic.
/// The Status text is expected to remain "Connected" (redundancy is optional).
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_RedundancyFailure_DoesNotBreakConnection()
{
@@ -538,6 +564,7 @@ public class MainWindowViewModelTests
/// <summary>
/// Verifies that saved subscriptions are restored after reconnecting the shell.
/// </summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ConnectCommand_RestoresSavedSubscriptions()
{