Initial import of the CBDDC codebase with docs and tests. Add a .NET-focused gitignore to keep generated artifacts out of source control.
Some checks failed
CI / verify (push) Has been cancelled
Some checks failed
CI / verify (push) Has been cancelled
This commit is contained in:
Joseph Doherty
168
docs-fix-batch-1.md
Normal file
168
docs-fix-batch-1.md
Normal file
@@ -0,0 +1,168 @@
|
||||
You are a C# documentation expert. Fix the following XML documentation issues in the listed files.
|
||||
|
||||
IMPORTANT: Make ONLY documentation changes. Do NOT modify code logic, behavior, signatures, or formatting unrelated to XML docs.
|
||||
|
||||
Model requirement: GPT-5.3-Codex-Spark
|
||||
Reasoning level: medium
|
||||
|
||||
Issue handling rules:
|
||||
- MissingDoc: add concise XML docs with <summary> (and <returns> where appropriate)
|
||||
- MissingInheritDoc: use /// <inheritdoc /> for overrides/interface implementations where appropriate
|
||||
- MissingParam: add missing <param name="...">...</param> tags
|
||||
- MissingTypeParam: add missing <typeparam name="...">...</typeparam> tags
|
||||
- MalformedXml: repair XML syntax and invalid tags
|
||||
|
||||
Preserve local style and keep descriptions concise.
|
||||
|
||||
=== BATCH 1 OF 6 ===
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs
|
||||
Issues:
|
||||
- Line 9, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 10, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 11, MissingDoc, Error, Constructor, Eq(string field, object value)
|
||||
-> Constructor 'Eq(string field, object value)' is missing XML documentation.
|
||||
- Line 16, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 17, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 18, MissingDoc, Error, Constructor, Gt(string field, object value)
|
||||
-> Constructor 'Gt(string field, object value)' is missing XML documentation.
|
||||
- Line 23, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 24, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 25, MissingDoc, Error, Constructor, Lt(string field, object value)
|
||||
-> Constructor 'Lt(string field, object value)' is missing XML documentation.
|
||||
- Line 30, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 31, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 32, MissingDoc, Error, Constructor, Gte(string field, object value)
|
||||
-> Constructor 'Gte(string field, object value)' is missing XML documentation.
|
||||
- Line 37, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 38, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 39, MissingDoc, Error, Constructor, Lte(string field, object value)
|
||||
-> Constructor 'Lte(string field, object value)' is missing XML documentation.
|
||||
- Line 44, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 45, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 46, MissingDoc, Error, Constructor, Neq(string field, object value)
|
||||
-> Constructor 'Neq(string field, object value)' is missing XML documentation.
|
||||
- Line 51, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 52, MissingDoc, Error, Property, Values
|
||||
-> Property 'Values' is missing XML documentation
|
||||
- Line 53, MissingDoc, Error, Constructor, In(string field, object[] values)
|
||||
-> Constructor 'In(string field, object[] values)' is missing XML documentation.
|
||||
- Line 58, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 59, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 60, MissingDoc, Error, Constructor, Contains(string field, string value)
|
||||
-> Constructor 'Contains(string field, string value)' is missing XML documentation.
|
||||
- Line 65, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 66, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 67, MissingDoc, Error, Constructor, NotContains(string field, string value)
|
||||
-> Constructor 'NotContains(string field, string value)' is missing XML documentation.
|
||||
- Line 72, MissingDoc, Error, Property, Left
|
||||
-> Property 'Left' is missing XML documentation
|
||||
- Line 73, MissingDoc, Error, Property, Right
|
||||
-> Property 'Right' is missing XML documentation
|
||||
- Line 74, MissingDoc, Error, Constructor, And(QueryNode left, QueryNode right)
|
||||
-> Constructor 'And(QueryNode left, QueryNode right)' is missing XML documentation.
|
||||
- Line 79, MissingDoc, Error, Property, Left
|
||||
-> Property 'Left' is missing XML documentation
|
||||
- Line 80, MissingDoc, Error, Property, Right
|
||||
-> Property 'Right' is missing XML documentation
|
||||
- Line 81, MissingDoc, Error, Constructor, Or(QueryNode left, QueryNode right)
|
||||
-> Constructor 'Or(QueryNode left, QueryNode right)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs
|
||||
Issues:
|
||||
- Line 8, MissingDoc, Error, Method, RecordValue(MetricType type, double value)
|
||||
-> Method 'RecordValue(MetricType type, double value)' is missing XML documentation.
|
||||
- Line 9, MissingDoc, Error, Method, StartMetric(MetricType type)
|
||||
-> Method 'StartMetric(MetricType type)' is missing XML documentation.
|
||||
- Line 10, MissingDoc, Error, Method, GetSnapshot()
|
||||
-> Method 'GetSnapshot()' is missing XML documentation.
|
||||
- Line 19, MissingDoc, Error, Constructor, MetricTimer(INetworkTelemetryService service, MetricType type)
|
||||
-> Constructor 'MetricTimer(INetworkTelemetryService service, MetricType type)' is missing XML documentation.
|
||||
- Line 26, MissingDoc, Error, Method, Dispose()
|
||||
-> Method 'Dispose()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs
|
||||
Issues:
|
||||
- Line 15, MissingDoc, Error, Constructor, VectorClock()
|
||||
-> Constructor 'VectorClock()' is missing XML documentation.
|
||||
- Line 20, MissingDoc, Error, Constructor, VectorClock(Dictionary<string, HlcTimestamp> clock)
|
||||
-> Constructor 'VectorClock(Dictionary<string, HlcTimestamp> clock)' is missing XML documentation.
|
||||
- Line 33, MissingParam, Warning, Method, GetTimestamp(string nodeId)
|
||||
-> Method 'GetTimestamp(string nodeId)' is missing <param name="nodeId"> documentation.
|
||||
- Line 41, MissingParam, Warning, Method, SetTimestamp(string nodeId, HlcTimestamp timestamp)
|
||||
-> Method 'SetTimestamp(string nodeId, HlcTimestamp timestamp)' is missing <param name="timestamp"> documentation.
|
||||
- Line 41, MissingParam, Warning, Method, SetTimestamp(string nodeId, HlcTimestamp timestamp)
|
||||
-> Method 'SetTimestamp(string nodeId, HlcTimestamp timestamp)' is missing <param name="nodeId"> documentation.
|
||||
- Line 49, MissingParam, Warning, Method, Merge(VectorClock other)
|
||||
-> Method 'Merge(VectorClock other)' is missing <param name="other"> documentation.
|
||||
- Line 68, MissingParam, Warning, Method, CompareTo(VectorClock other)
|
||||
-> Method 'CompareTo(VectorClock other)' is missing <param name="other"> documentation.
|
||||
- Line 110, MissingParam, Warning, Method, GetNodesWithUpdates(VectorClock other)
|
||||
-> Method 'GetNodesWithUpdates(VectorClock other)' is missing <param name="other"> documentation.
|
||||
- Line 134, MissingParam, Warning, Method, GetNodesToPush(VectorClock other)
|
||||
-> Method 'GetNodesToPush(VectorClock other)' is missing <param name="other"> documentation.
|
||||
- Line 158, MissingDoc, Error, Method, ToString()
|
||||
-> Method 'ToString()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/ChangesAppliedEventArgs.cs
|
||||
Issues:
|
||||
- Line 11, MissingDoc, Error, Property, Changes
|
||||
-> Property 'Changes' is missing XML documentation
|
||||
- Line 12, MissingDoc, Error, Constructor, ChangesAppliedEventArgs(IEnumerable<OplogEntry> changes)
|
||||
-> Constructor 'ChangesAppliedEventArgs(IEnumerable<OplogEntry> changes)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentStore.cs
|
||||
Issues:
|
||||
- Line 13, MissingDoc, Error, Property, InterestedCollection
|
||||
-> Property 'InterestedCollection' is missing XML documentation
|
||||
- Line 81, MalformedXml, Error, Method, DeleteBatchDocumentsAsync(IEnumerable<string> documentKeys, CancellationToken cancellationToken)
|
||||
-> Method 'DeleteBatchDocumentsAsync(IEnumerable<string> documentKeys, CancellationToken cancellationToken)' has malformed XML documentation that cannot be parsed.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs
|
||||
Issues:
|
||||
- Line 18, MissingDoc, Error, Constructor, RetryPolicy(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<RetryPolicy> logger)
|
||||
-> Constructor 'RetryPolicy(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<RetryPolicy> logger)' is missing XML documentation.
|
||||
- Line 28, MissingTypeParam, Warning, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing <typeparam name="T"> documentation.
|
||||
- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="cancellationToken"> documentation.
|
||||
- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="operationName"> documentation.
|
||||
- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="operation"> documentation.
|
||||
- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="cancellationToken"> documentation.
|
||||
- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="operationName"> documentation.
|
||||
- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="operation"> documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/ILeaderElectionService.cs
|
||||
Issues:
|
||||
- Line 25, MissingParam, Warning, Constructor, LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)
|
||||
-> Constructor 'LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)' is missing <param name="isLocalNodeGateway"> documentation.
|
||||
- Line 25, MissingParam, Warning, Constructor, LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)
|
||||
-> Constructor 'LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)' is missing <param name="currentGatewayNodeId"> documentation.
|
||||
|
||||
Execution rules:
|
||||
1. Read each file and apply all listed documentation fixes.
|
||||
2. Keep changes minimal and doc-focused.
|
||||
3. Avoid duplicate XML tags or malformed XML.
|
||||
4. Return a short summary: files modified, issue count fixed per file, and any unresolved items.
|
||||
Reference in New Issue
Block a user