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
173
docs-fix-batch-6.md
Normal file
173
docs-fix-batch-6.md
Normal file
@@ -0,0 +1,173 @@
|
||||
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 6 OF 6 ===
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/OplogEntry.cs
|
||||
Issues:
|
||||
- Line 15, MissingDoc, Error, Method, ComputeHash(OplogEntry entry)
|
||||
-> Method 'ComputeHash(OplogEntry entry)' is missing XML documentation.
|
||||
- Line 45, MissingDoc, Error, Property, Collection
|
||||
-> Property 'Collection' is missing XML documentation
|
||||
- Line 46, MissingDoc, Error, Property, Key
|
||||
-> Property 'Key' is missing XML documentation
|
||||
- Line 47, MissingDoc, Error, Property, Operation
|
||||
-> Property 'Operation' is missing XML documentation
|
||||
- Line 48, MissingDoc, Error, Property, Payload
|
||||
-> Property 'Payload' is missing XML documentation
|
||||
- Line 49, MissingDoc, Error, Property, Timestamp
|
||||
-> Property 'Timestamp' is missing XML documentation
|
||||
- Line 50, MissingDoc, Error, Property, Hash
|
||||
-> Property 'Hash' is missing XML documentation
|
||||
- Line 51, MissingDoc, Error, Property, PreviousHash
|
||||
-> Property 'PreviousHash' is missing XML documentation
|
||||
- Line 53, MissingDoc, Error, Constructor, OplogEntry(string collection, string key, OperationType operation, JsonElement? payload, HlcTimestamp timestamp, string previousHash, string? hash)
|
||||
-> Constructor 'OplogEntry(string collection, string key, OperationType operation, JsonElement? payload, HlcTimestamp timestamp, string previousHash, string? hash)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
Issues:
|
||||
- Line 11, MissingDoc, Error, Method, DropAsync(CancellationToken cancellationToken)
|
||||
-> Method 'DropAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 13, MissingDoc, Error, Method, ExportAsync(CancellationToken cancellationToken)
|
||||
-> Method 'ExportAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 15, MissingDoc, Error, Method, GetSnapshotMetadataAsync(string nodeId, CancellationToken cancellationToken)
|
||||
-> Method 'GetSnapshotMetadataAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 17, MissingDoc, Error, Method, GetSnapshotHashAsync(string nodeId, CancellationToken cancellationToken)
|
||||
-> Method 'GetSnapshotHashAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 19, MissingDoc, Error, Method, ImportAsync(IEnumerable<SnapshotMetadata> items, CancellationToken cancellationToken)
|
||||
-> Method 'ImportAsync(IEnumerable<SnapshotMetadata> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 21, MissingDoc, Error, Method, InsertSnapshotMetadataAsync(SnapshotMetadata metadata, CancellationToken cancellationToken)
|
||||
-> Method 'InsertSnapshotMetadataAsync(SnapshotMetadata metadata, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 23, MissingDoc, Error, Method, MergeAsync(IEnumerable<SnapshotMetadata> items, CancellationToken cancellationToken)
|
||||
-> Method 'MergeAsync(IEnumerable<SnapshotMetadata> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 25, MissingDoc, Error, Method, UpdateSnapshotMetadataAsync(SnapshotMetadata existingMeta, CancellationToken cancellationToken)
|
||||
-> Method 'UpdateSnapshotMetadataAsync(SnapshotMetadata existingMeta, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 27, MissingDoc, Error, Method, GetAllSnapshotMetadataAsync(CancellationToken cancellationToken)
|
||||
-> Method 'GetAllSnapshotMetadataAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs
|
||||
Issues:
|
||||
- Line 32, MissingDoc, Error, Constructor, UdpDiscoveryService(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IDocumentStore documentStore, ILogger<UdpDiscoveryService> logger)
|
||||
-> Constructor 'UdpDiscoveryService(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IDocumentStore documentStore, ILogger<UdpDiscoveryService> logger)' is missing XML documentation.
|
||||
- Line 147, MissingDoc, Error, Method, Stop()
|
||||
-> Method 'Stop()' is missing XML documentation.
|
||||
- Line 179, MissingDoc, Error, Method, GetActivePeers()
|
||||
-> Method 'GetActivePeers()' is missing XML documentation.
|
||||
- Line 279, MissingDoc, Error, Property, NodeId
|
||||
-> Property 'NodeId' is missing XML documentation
|
||||
- Line 282, MissingDoc, Error, Property, TcpPort
|
||||
-> Property 'TcpPort' is missing XML documentation
|
||||
- Line 285, MissingDoc, Error, Property, ClusterHash
|
||||
-> Property 'ClusterHash' is missing XML documentation
|
||||
- Line 288, MissingDoc, Error, Property, InterestingCollections
|
||||
-> Property 'InterestingCollections' is missing XML documentation
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ICBDDCNode.cs
|
||||
Issues:
|
||||
- Line 7, MissingDoc, Error, Property, Address
|
||||
-> Property 'Address' is missing XML documentation
|
||||
- Line 8, MissingDoc, Error, Property, Discovery
|
||||
-> Property 'Discovery' is missing XML documentation
|
||||
- Line 9, MissingDoc, Error, Property, Orchestrator
|
||||
-> Property 'Orchestrator' is missing XML documentation
|
||||
- Line 10, MissingDoc, Error, Property, Server
|
||||
-> Property 'Server' is missing XML documentation
|
||||
- Line 12, MissingDoc, Error, Method, Start()
|
||||
-> Method 'Start()' is missing XML documentation.
|
||||
- Line 13, MissingDoc, Error, Method, Stop()
|
||||
-> Method 'Stop()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/OAuth2ClientCredentialsTokenProvider.cs
|
||||
Issues:
|
||||
- Line 47, MissingDoc, Error, Method, GetAccessTokenAsync(CancellationToken cancellationToken)
|
||||
-> Method 'GetAccessTokenAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 137, MissingDoc, Error, Method, Dispose()
|
||||
-> Method 'Dispose()' is missing XML documentation.
|
||||
- Line 144, MissingDoc, Error, Property, AccessToken
|
||||
-> Property 'AccessToken' is missing XML documentation
|
||||
- Line 147, MissingDoc, Error, Property, ExpiresIn
|
||||
-> Property 'ExpiresIn' is missing XML documentation
|
||||
- Line 150, MissingDoc, Error, Property, TokenType
|
||||
-> Property 'TokenType' is missing XML documentation
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNode.cs
|
||||
Issues:
|
||||
- Line 138, MissingDoc, Error, Property, Host
|
||||
-> Property 'Host' is missing XML documentation
|
||||
- Line 139, MissingDoc, Error, Property, Port
|
||||
-> Property 'Port' is missing XML documentation
|
||||
- Line 141, MissingDoc, Error, Constructor, NodeAddress(string host, int port)
|
||||
-> Constructor 'NodeAddress(string host, int port)' is missing XML documentation.
|
||||
- Line 147, MissingDoc, Error, Method, ToString()
|
||||
-> Method 'ToString()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompressionHelper.cs
|
||||
Issues:
|
||||
- Line 11, MissingDoc, Error, Property, IsBrotliSupported
|
||||
-> Property 'IsBrotliSupported' is missing XML documentation
|
||||
- Line 23, MissingDoc, Error, Method, Compress(byte[] data)
|
||||
-> Method 'Compress(byte[] data)' is missing XML documentation.
|
||||
- Line 39, MissingDoc, Error, Method, Decompress(byte[] compressedData)
|
||||
-> Method 'Decompress(byte[] compressedData)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/IRetryPolicy.cs
|
||||
Issues:
|
||||
- Line 9, MissingDoc, Error, Method, ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 10, MissingDoc, Error, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/CryptoHelper.cs
|
||||
Issues:
|
||||
- Line 13, MissingDoc, Error, Method, Encrypt(byte[] plaintext, byte[] key)
|
||||
-> Method 'Encrypt(byte[] plaintext, byte[] key)' is missing XML documentation.
|
||||
- Line 34, MissingDoc, Error, Method, Decrypt(byte[] ciphertext, byte[] iv, byte[] tag, byte[] key)
|
||||
-> Method 'Decrypt(byte[] ciphertext, byte[] iv, byte[] tag, byte[] key)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/CBDDCHealthCheck.cs
|
||||
Issues:
|
||||
- Line 21, MissingDoc, Error, Constructor, CBDDCHealthCheck(IOplogStore store, ISyncStatusTracker syncTracker, ILogger<CBDDCHealthCheck>? logger)
|
||||
-> Constructor 'CBDDCHealthCheck(IOplogStore store, ISyncStatusTracker syncTracker, ILogger<CBDDCHealthCheck>? logger)' is missing XML documentation.
|
||||
- Line 34, MissingParam, Warning, Method, CheckAsync(CancellationToken cancellationToken)
|
||||
-> Method 'CheckAsync(CancellationToken cancellationToken)' is missing <param name="cancellationToken"> documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/LastWriteWinsConflictResolver.cs
|
||||
Issues:
|
||||
- Line 8, MissingDoc, Error, Method, Resolve(Document? local, OplogEntry remote)
|
||||
-> Method 'Resolve(Document? local, OplogEntry remote)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs
|
||||
Issues:
|
||||
- Line 22, MissingParam, Warning, Method, Update(OplogEntry entry)
|
||||
-> Method 'Update(OplogEntry entry)' is missing <param name="entry"> documentation.
|
||||
- Line 27, MissingParam, Warning, Method, GetVectorClockAsync(CancellationToken cancellationToken)
|
||||
-> Method 'GetVectorClockAsync(CancellationToken cancellationToken)' is missing <param name="cancellationToken"> documentation.
|
||||
- Line 32, MissingParam, Warning, Method, GetLatestTimestampAsync(CancellationToken cancellationToken)
|
||||
-> Method 'GetLatestTimestampAsync(CancellationToken cancellationToken)' is missing <param name="cancellationToken"> documentation.
|
||||
- Line 38, MissingParam, Warning, Method, GetLastHash(string nodeId)
|
||||
-> Method 'GetLastHash(string nodeId)' is missing <param name="nodeId"> documentation.
|
||||
- Line 44, MissingParam, Warning, Method, UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)
|
||||
-> Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing <param name="hash"> documentation.
|
||||
- Line 44, MissingParam, Warning, Method, UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)
|
||||
-> Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing <param name="timestamp"> documentation.
|
||||
- Line 44, MissingParam, Warning, Method, UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)
|
||||
-> Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing <param name="nodeId"> 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