docs(comments): strip internal task/milestone/bundle bookkeeping from code comments
Remove project bookkeeping citations from shipped code comments across the solution: hyphenated task IDs (WP-14, StoreAndForward-025), milestone/task/ issue refs (M3, Task 4, Audit Log #23, #21), Bundle X task-bundle labels, and C/D/K/S/T phase labels. Comment text only — no code logic, string/log literals, or XML-doc structure changed. Genuine descriptions are preserved (only the citation is stripped), and technical lookalikes are retained (UTF-8, SHA-256, T00:00:00, M365, UTC-5, pre-C4/pre-C5 schema versions). Flagged by the new CommentChecker TaskReferenceInComment / TrackingReferenceInComment checks plus targeted grep passes; full solution builds clean, append-only guard tests pass.
This commit is contained in:
@@ -6,7 +6,7 @@ namespace ZB.MOM.WW.ScadaBridge.Security;
|
||||
/// Translates the shared <see cref="LdapAuthFailure"/> enum returned by
|
||||
/// <c>ZB.MOM.WW.Auth.Ldap</c>'s <see cref="ILdapAuthService"/> into the
|
||||
/// user-facing error strings ScadaBridge surfaced from its bespoke
|
||||
/// <c>LdapAuthService</c> before the Task 1.2 cutover.
|
||||
/// <c>LdapAuthService</c> before the cutover.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
@@ -31,14 +31,14 @@ namespace ZB.MOM.WW.ScadaBridge.Security;
|
||||
/// library rejects it outright. Surfaced as the misconfiguration message so
|
||||
/// the operator — not the user — is pointed at the cause.</item>
|
||||
/// <item><see cref="LdapAuthFailure.ServiceAccountBindFailed"/> keeps the
|
||||
/// donor's distinct "service is misconfigured" wording (Security-019) so a
|
||||
/// donor's distinct "service is misconfigured" wording so a
|
||||
/// system-side fault is not blamed on user input. NOTE: the library also maps
|
||||
/// connect/search infrastructure failures (directory unreachable) into this
|
||||
/// bucket, so this message now covers "directory unavailable at connect/search
|
||||
/// time" as well — see <see cref="LdapAuthFailure.GroupLookupFailed"/> for the
|
||||
/// post-bind directory-outage case.</item>
|
||||
/// <item><see cref="LdapAuthFailure.GroupLookupFailed"/> keeps the donor's
|
||||
/// "directory is temporarily unavailable" wording (Security-012): a post-bind
|
||||
/// "directory is temporarily unavailable" wording: a post-bind
|
||||
/// group-lookup failure means the directory is partially unavailable and the
|
||||
/// login is failed closed rather than admitting a roleless session. NOTE: the
|
||||
/// library additionally treats a successful-but-empty group set as
|
||||
|
||||
Reference in New Issue
Block a user