docs(src): fix CommentChecker findings across src/ — 1,032 → 5 (all false positives)

Comment/XML-doc changes only, no code logic:
- strip project-tracking references (WP*, P*-*, row-NN, #NN, Task N) from
  comments, keeping the explanatory rationale
- add missing summaries, <param>, <returns>, <typeparam> and <inheritdoc/>
- replace misused <inheritdoc/> with real docs; where <inheritdoc/> was
  combined with useful remarks, move the rationale into // comments
- drop stale replicationActor <param> on DeploymentManagerActor ctor

Remaining 5 are false positives (CWE-1236 x2, failures-1, year-0001, M365).
Build 0 errors / 0 warnings.
This commit is contained in:
Joseph Doherty
2026-10-07 14:12:25 -04:00
parent 3a217b9484
commit 0ffd4bdbea
217 changed files with 1224 additions and 695 deletions
@@ -88,6 +88,7 @@ public static class EwsSoapEnvelope
/// </summary>
private sealed class Utf8StringWriter : StringWriter
{
/// <inheritdoc />
public override Encoding Encoding => Encoding.UTF8;
}
}
@@ -6,7 +6,7 @@ namespace ZB.MOM.WW.ScadaBridge.NotificationService;
/// <summary>
/// MailKit-based SMTP client wrapper.
/// Supports OAuth2 Client Credentials (M365) and Basic Auth.
/// Supports OAuth2 Client Credentials (Microsoft 365) and Basic Auth.
/// BCC delivery, plain text.
/// </summary>
/// <remarks>
@@ -110,7 +110,7 @@ public class MailKitSmtpClientWrapper : ISmtpClientWrapper, IDisposable
case "oauth2":
// The XOAUTH2 SASL initial response embeds a `user=<userName>`
// field that M365 (and most OAuth2-enabled SMTP relays) require to
// field that Microsoft 365 (and most OAuth2-enabled SMTP relays) require to
// match the mailbox identity the token was issued for. An empty user
// gets rejected with `535 5.7.3`. The token (credentials) is
// pre-fetched by OAuth2TokenService; the user identity is the SMTP