docs(src): add missing XML docs and strip tracking-ID comments
Sweep of 203 source files resolving CommentChecker findings: add <summary>/<param>/<returns>/<inheritdoc> where missing, and remove resolved task/issue tracking markers (Tests-NNN, Worker-NNN, Server-NNN, Task N) from code comments. Comment/doc-only — no logic changes. Server+Tests build clean under TreatWarningsAsErrors.
This commit is contained in:
@@ -29,6 +29,7 @@ public sealed class GalaxyRepositoryHostWiringTests
|
||||
/// <see cref="GatewayBrowseScopeProvider"/> threads the constraint into the lib
|
||||
/// service → <c>BrowseChildren</c> returns empty children.
|
||||
/// </summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task BrowseChildren_BrowseSubtreesConstraintThroughHostWiring_FiltersChildren()
|
||||
{
|
||||
@@ -130,13 +131,17 @@ public sealed class GalaxyRepositoryHostWiringTests
|
||||
/// <summary>Immediately-ready stub: Current returns the seeded entry, loads are instant.</summary>
|
||||
private sealed class StubGalaxyHierarchyCache(GalaxyHierarchyCacheEntry current) : IGalaxyHierarchyCache
|
||||
{
|
||||
/// <inheritdoc />
|
||||
/// <summary>Gets the seeded cache entry passed to the stub's constructor.</summary>
|
||||
public GalaxyHierarchyCacheEntry Current { get; } = current;
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>No-op: the stub's entry is always considered already loaded.</summary>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public Task RefreshAsync(CancellationToken cancellationToken) => Task.CompletedTask;
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>No-op: the stub's entry is always considered already loaded.</summary>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public Task WaitForFirstLoadAsync(CancellationToken cancellationToken) => Task.CompletedTask;
|
||||
}
|
||||
|
||||
@@ -146,23 +151,33 @@ public sealed class GalaxyRepositoryHostWiringTests
|
||||
/// </summary>
|
||||
private sealed class StubGalaxyRepository : IGalaxyRepository
|
||||
{
|
||||
/// <inheritdoc />
|
||||
/// <summary>Always throws: <c>BrowseChildren</c> never calls the repository directly.</summary>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
/// <returns>Never returns; always throws.</returns>
|
||||
public Task<bool> TestConnectionAsync(CancellationToken ct = default) =>
|
||||
throw new NotSupportedException("Not called during BrowseChildren.");
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>Always throws: <c>BrowseChildren</c> never calls the repository directly.</summary>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
/// <returns>Never returns; always throws.</returns>
|
||||
public Task<DateTime?> GetLastDeployTimeAsync(CancellationToken ct = default) =>
|
||||
throw new NotSupportedException("Not called during BrowseChildren.");
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>Always throws: <c>BrowseChildren</c> never calls the repository directly.</summary>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
/// <returns>Never returns; always throws.</returns>
|
||||
public Task<List<GalaxyHierarchyRow>> GetHierarchyAsync(CancellationToken ct = default) =>
|
||||
throw new NotSupportedException("Not called during BrowseChildren.");
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>Always throws: <c>BrowseChildren</c> never calls the repository directly.</summary>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
/// <returns>Never returns; always throws.</returns>
|
||||
public Task<List<GalaxyAttributeRow>> GetAttributesAsync(CancellationToken ct = default) =>
|
||||
throw new NotSupportedException("Not called during BrowseChildren.");
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>Always throws: <c>BrowseChildren</c> never calls the repository directly.</summary>
|
||||
/// <param name="ct">Cancellation token.</param>
|
||||
/// <returns>Never returns; always throws.</returns>
|
||||
public Task<List<GalaxyAlarmAttributeRow>> GetAlarmAttributesAsync(CancellationToken ct = default) =>
|
||||
throw new NotSupportedException("Not called during BrowseChildren.");
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user