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:
+5
-5
@@ -3,10 +3,10 @@ using ZB.MOM.WW.ScadaBridge.Commons.Entities.SecuredWrites;
|
||||
namespace ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
||||
|
||||
/// <summary>
|
||||
/// Operational-state data access for the central <c>PendingSecuredWrites</c> table
|
||||
/// (M7 OPC UA / MxGateway UX, Task T14b). One row per pending two-person secured
|
||||
/// Operational-state data access for the central <c>PendingSecuredWrites</c> table.
|
||||
/// One row per pending two-person secured
|
||||
/// write; rows are inserted at submission and mutated as the request is decided and
|
||||
/// executed. Mirrors the <c>SiteCalls</c> (Site Call Audit #22) repository shape.
|
||||
/// executed. Mirrors the <c>SiteCalls</c> repository shape.
|
||||
/// </summary>
|
||||
public interface ISecuredWriteRepository
|
||||
{
|
||||
@@ -58,8 +58,8 @@ public interface ISecuredWriteRepository
|
||||
/// <summary>
|
||||
/// Atomically flips a row from <c>Pending</c> to <c>Approved</c>, stamping the
|
||||
/// verifier identity, comment, and decision time, but ONLY if the row is still
|
||||
/// <c>Pending</c>. This is the compare-and-swap guard for the two-verifier race
|
||||
/// (M7 / T14b): two verifiers may approve the same write concurrently, but the
|
||||
/// <c>Pending</c>. This is the compare-and-swap guard for the two-verifier race:
|
||||
/// two verifiers may approve the same write concurrently, but the
|
||||
/// conditional <c>WHERE Status='Pending'</c> guarantees exactly one wins. The
|
||||
/// loser observes <c>false</c> and must not relay the write.
|
||||
/// </summary>
|
||||
|
||||
Reference in New Issue
Block a user