docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
This commit is contained in:
+13
-1
@@ -22,7 +22,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Templates;
|
||||
namespace ZB.MOM.WW.ScadaBridge.Transport.IntegrationTests.Import;
|
||||
|
||||
/// <summary>
|
||||
/// #05-T5: a template's <see cref="TemplateNativeAlarmSource"/> collection must
|
||||
/// A template's <see cref="TemplateNativeAlarmSource"/> collection must
|
||||
/// survive an export→import round-trip (Add + Overwrite sync), diff in Preview,
|
||||
/// and — crucially — carry across environments so an instance-level override of a
|
||||
/// native alarm source no longer dangles in the target. Before this fix the
|
||||
@@ -34,6 +34,7 @@ public sealed class NativeAlarmSourceImportTests : IDisposable
|
||||
{
|
||||
private readonly ServiceProvider _provider;
|
||||
|
||||
/// <summary>Initializes the in-memory host used by the import tests.</summary>
|
||||
public NativeAlarmSourceImportTests()
|
||||
{
|
||||
var services = new ServiceCollection();
|
||||
@@ -67,6 +68,7 @@ public sealed class NativeAlarmSourceImportTests : IDisposable
|
||||
_provider = services.BuildServiceProvider();
|
||||
}
|
||||
|
||||
/// <summary>Disposes the underlying service provider.</summary>
|
||||
public void Dispose() => _provider.Dispose();
|
||||
|
||||
private async Task<Guid> ExportAllTemplatesAndLoadAsync()
|
||||
@@ -118,6 +120,8 @@ public sealed class NativeAlarmSourceImportTests : IDisposable
|
||||
LockedInDerived = lockedInDerived,
|
||||
};
|
||||
|
||||
/// <summary>Verifies that an Add import carries the template's native alarm sources.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Import_Add_CarriesTemplateNativeAlarmSources()
|
||||
{
|
||||
@@ -165,6 +169,8 @@ public sealed class NativeAlarmSourceImportTests : IDisposable
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an Overwrite import with no change emits no native source audit.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Import_Overwrite_NoChange_EmitsNoNativeSourceAudit()
|
||||
{
|
||||
@@ -196,6 +202,8 @@ public sealed class NativeAlarmSourceImportTests : IDisposable
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an Overwrite import synchronizes the native alarm sources.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Import_Overwrite_SyncsNativeAlarmSources()
|
||||
{
|
||||
@@ -253,6 +261,8 @@ public sealed class NativeAlarmSourceImportTests : IDisposable
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Verifies that Preview diffs the native alarm sources.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Preview_DiffsNativeAlarmSources()
|
||||
{
|
||||
@@ -286,6 +296,8 @@ public sealed class NativeAlarmSourceImportTests : IDisposable
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an imported instance override no longer dangles.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Import_InstanceOverride_NoLongerDangles()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user