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:
+24
-28
@@ -91,27 +91,25 @@ public class TemplateEngineRepository : ITemplateEngineRepository
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <remarks>
|
||||
/// Two deliberate departures from <see cref="GetAllTemplatesAsync"/>:
|
||||
/// <list type="number">
|
||||
/// <item>
|
||||
/// <c>AsNoTracking</c> — the analysis walks (cycle detection, collision
|
||||
/// detection, canonical-name resolution) never write through the loaded
|
||||
/// graph, so paying for a change-tracker snapshot of every attribute,
|
||||
/// alarm, script and composition in the database is pure waste.
|
||||
/// </item>
|
||||
/// <item>
|
||||
/// <c>TemplateScript.Code</c> is projected away (left empty). Script
|
||||
/// bodies are by far the largest column in the graph and NONE of the
|
||||
/// analysis consumers read them — <c>CycleDetector</c> reads only ids and
|
||||
/// edges, <c>CollisionDetector</c> and <c>TemplateResolver</c> read only
|
||||
/// member names and lock flags.
|
||||
/// </item>
|
||||
/// </list>
|
||||
/// Callers that DO need bodies or tracked entities — the inheritance
|
||||
/// reconciler and the flattener — must keep using
|
||||
/// <see cref="GetAllTemplatesAsync"/> / <see cref="GetTemplateWithChildrenAsync"/>.
|
||||
/// </remarks>
|
||||
// Two deliberate departures from <see cref="GetAllTemplatesAsync"/>:
|
||||
// <list type="number">
|
||||
// <item>
|
||||
// <c>AsNoTracking</c> — the analysis walks (cycle detection, collision
|
||||
// detection, canonical-name resolution) never write through the loaded
|
||||
// graph, so paying for a change-tracker snapshot of every attribute,
|
||||
// alarm, script and composition in the database is pure waste.
|
||||
// </item>
|
||||
// <item>
|
||||
// <c>TemplateScript.Code</c> is projected away (left empty). Script
|
||||
// bodies are by far the largest column in the graph and NONE of the
|
||||
// analysis consumers read them — <c>CycleDetector</c> reads only ids and
|
||||
// edges, <c>CollisionDetector</c> and <c>TemplateResolver</c> read only
|
||||
// member names and lock flags.
|
||||
// </item>
|
||||
// </list>
|
||||
// Callers that DO need bodies or tracked entities — the inheritance
|
||||
// reconciler and the flattener — must keep using
|
||||
// <see cref="GetAllTemplatesAsync"/> / <see cref="GetTemplateWithChildrenAsync"/>.
|
||||
public async Task<IReadOnlyList<Template>> GetAllTemplatesForAnalysisAsync(CancellationToken cancellationToken = default)
|
||||
{
|
||||
return await _context.Templates
|
||||
@@ -772,13 +770,11 @@ public class TemplateEngineRepository : ITemplateEngineRepository
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <remarks>
|
||||
/// Inspects the change tracker BEFORE committing (afterwards every entry is
|
||||
/// <see cref="EntityState.Unchanged"/> and the attribution is lost) and bumps
|
||||
/// the <see cref="ITemplateGraphWatermark"/> for each affected template /
|
||||
/// instance. The bump is applied only AFTER a successful commit, so a failed
|
||||
/// save does not invalidate caches for a change that never landed.
|
||||
/// </remarks>
|
||||
// Inspects the change tracker BEFORE committing (afterwards every entry is
|
||||
// <see cref="EntityState.Unchanged"/> and the attribution is lost) and bumps
|
||||
// the <see cref="ITemplateGraphWatermark"/> for each affected template /
|
||||
// instance. The bump is applied only AFTER a successful commit, so a failed
|
||||
// save does not invalidate caches for a change that never landed.
|
||||
public async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
|
||||
{
|
||||
var pending = CollectWatermarkBumps();
|
||||
|
||||
Reference in New Issue
Block a user