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:
@@ -34,6 +34,7 @@ public interface IAlarmCommandHandler : IDisposable
|
||||
/// <param name="operatorNode">The operator node name.</param>
|
||||
/// <param name="operatorDomain">The operator domain name.</param>
|
||||
/// <param name="operatorFullName">The operator full name.</param>
|
||||
/// <returns>AVEVA's native alarm status code (0 = success).</returns>
|
||||
int Acknowledge(
|
||||
Guid alarmGuid,
|
||||
string comment,
|
||||
@@ -54,6 +55,7 @@ public interface IAlarmCommandHandler : IDisposable
|
||||
/// <param name="operatorNode">The operator node name.</param>
|
||||
/// <param name="operatorDomain">The operator domain name.</param>
|
||||
/// <param name="operatorFullName">The operator full name.</param>
|
||||
/// <returns>AVEVA's native alarm status code (0 = success).</returns>
|
||||
int AcknowledgeByName(
|
||||
string alarmName,
|
||||
string providerName,
|
||||
@@ -69,6 +71,7 @@ public interface IAlarmCommandHandler : IDisposable
|
||||
/// prefix matched against <c>AlarmFullReference</c>.
|
||||
/// </summary>
|
||||
/// <param name="alarmFilterPrefix">Optional prefix to filter alarms by.</param>
|
||||
/// <returns>The currently active alarms matching the filter.</returns>
|
||||
IReadOnlyList<ActiveAlarmSnapshot> QueryActive(string? alarmFilterPrefix);
|
||||
|
||||
/// <summary>
|
||||
|
||||
Reference in New Issue
Block a user