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
200
docs-fix-batch-4.md
Normal file
200
docs-fix-batch-4.md
Normal file
@@ -0,0 +1,200 @@
|
||||
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 4 OF 6 ===
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs
|
||||
Issues:
|
||||
- Line 33, MissingDoc, Error, Constructor, NetworkTelemetryService(ILogger<NetworkTelemetryService> logger, string persistencePath)
|
||||
-> Constructor 'NetworkTelemetryService(ILogger<NetworkTelemetryService> logger, string persistencePath)' is missing XML documentation.
|
||||
- Line 53, MissingDoc, Error, Method, RecordValue(MetricType type, double value)
|
||||
-> Method 'RecordValue(MetricType type, double value)' is missing XML documentation.
|
||||
- Line 58, MissingDoc, Error, Method, StartMetric(MetricType type)
|
||||
-> Method 'StartMetric(MetricType type)' is missing XML documentation.
|
||||
- Line 63, MissingDoc, Error, Method, GetSnapshot()
|
||||
-> Method 'GetSnapshot()' is missing XML documentation.
|
||||
- Line 173, MissingDoc, Error, Method, ForcePersist()
|
||||
-> Method 'ForcePersist()' is missing XML documentation.
|
||||
- Line 201, MissingDoc, Error, Method, Dispose()
|
||||
-> Method 'Dispose()' is missing XML documentation.
|
||||
- Line 215, MissingDoc, Error, Constructor, MetricBucket()
|
||||
-> Constructor 'MetricBucket()' is missing XML documentation.
|
||||
- Line 222, MissingDoc, Error, Method, Reset()
|
||||
-> Method 'Reset()' is missing XML documentation.
|
||||
- Line 228, MissingDoc, Error, Method, Add(MetricType type, double value)
|
||||
-> Method 'Add(MetricType type, double value)' is missing XML documentation.
|
||||
- Line 235, MissingDoc, Error, Method, GetSum(MetricType type)
|
||||
-> Method 'GetSum(MetricType type)' is missing XML documentation.
|
||||
- Line 236, MissingDoc, Error, Method, GetCount(MetricType type)
|
||||
-> Method 'GetCount(MetricType type)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs
|
||||
Issues:
|
||||
- Line 37, MissingDoc, Error, Property, IsConnected
|
||||
-> Property 'IsConnected' is missing XML documentation
|
||||
- Line 48, MissingDoc, Error, Property, HasHandshaked
|
||||
-> Property 'HasHandshaked' is missing XML documentation
|
||||
- Line 52, MissingDoc, Error, Constructor, TcpPeerClient(string peerAddress, ILogger logger, IPeerHandshakeService? handshakeService, INetworkTelemetryService? telemetry)
|
||||
-> Constructor 'TcpPeerClient(string peerAddress, ILogger logger, IPeerHandshakeService? handshakeService, INetworkTelemetryService? telemetry)' is missing XML documentation.
|
||||
- Line 62, MissingDoc, Error, Method, ConnectAsync(CancellationToken token)
|
||||
-> Method 'ConnectAsync(CancellationToken token)' is missing XML documentation.
|
||||
- Line 143, MissingParam, Warning, Method, HandshakeAsync(string myNodeId, string authToken, IEnumerable<string>? interestingCollections, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable<string>? interestingCollections, CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 143, MissingParam, Warning, Method, HandshakeAsync(string myNodeId, string authToken, IEnumerable<string>? interestingCollections, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable<string>? interestingCollections, CancellationToken token)' is missing <param name="interestingCollections"> documentation.
|
||||
- Line 143, MissingParam, Warning, Method, HandshakeAsync(string myNodeId, string authToken, IEnumerable<string>? interestingCollections, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable<string>? interestingCollections, CancellationToken token)' is missing <param name="authToken"> documentation.
|
||||
- Line 143, MissingParam, Warning, Method, HandshakeAsync(string myNodeId, string authToken, IEnumerable<string>? interestingCollections, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable<string>? interestingCollections, CancellationToken token)' is missing <param name="myNodeId"> documentation.
|
||||
- Line 196, MissingParam, Warning, Method, GetClockAsync(CancellationToken token)
|
||||
-> Method 'GetClockAsync(CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 213, MissingParam, Warning, Method, GetVectorClockAsync(CancellationToken token)
|
||||
-> Method 'GetVectorClockAsync(CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 237, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, CancellationToken token)
|
||||
-> Method 'PullChangesAsync(HlcTimestamp since, CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 237, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, CancellationToken token)
|
||||
-> Method 'PullChangesAsync(HlcTimestamp since, CancellationToken token)' is missing <param name="since"> documentation.
|
||||
- Line 245, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)
|
||||
-> Method 'PullChangesAsync(HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 245, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)
|
||||
-> Method 'PullChangesAsync(HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)' is missing <param name="collections"> documentation.
|
||||
- Line 245, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)
|
||||
-> Method 'PullChangesAsync(HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)' is missing <param name="since"> documentation.
|
||||
- Line 281, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)
|
||||
-> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 281, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)
|
||||
-> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing <param name="since"> documentation.
|
||||
- Line 281, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)
|
||||
-> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing <param name="nodeId"> documentation.
|
||||
- Line 289, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)
|
||||
-> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 289, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)
|
||||
-> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)' is missing <param name="collections"> documentation.
|
||||
- Line 289, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)
|
||||
-> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)' is missing <param name="since"> documentation.
|
||||
- Line 289, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)
|
||||
-> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable<string>? collections, CancellationToken token)' is missing <param name="nodeId"> documentation.
|
||||
- Line 325, MissingParam, Warning, Method, GetChainRangeAsync(string startHash, string endHash, CancellationToken token)
|
||||
-> Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 325, MissingParam, Warning, Method, GetChainRangeAsync(string startHash, string endHash, CancellationToken token)
|
||||
-> Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing <param name="endHash"> documentation.
|
||||
- Line 325, MissingParam, Warning, Method, GetChainRangeAsync(string startHash, string endHash, CancellationToken token)
|
||||
-> Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing <param name="startHash"> documentation.
|
||||
- Line 351, MissingParam, Warning, Method, PushChangesAsync(IEnumerable<OplogEntry> entries, CancellationToken token)
|
||||
-> Method 'PushChangesAsync(IEnumerable<OplogEntry> entries, CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 351, MissingParam, Warning, Method, PushChangesAsync(IEnumerable<OplogEntry> entries, CancellationToken token)
|
||||
-> Method 'PushChangesAsync(IEnumerable<OplogEntry> entries, CancellationToken token)' is missing <param name="entries"> documentation.
|
||||
- Line 387, MissingDoc, Error, Method, GetSnapshotAsync(Stream destination, CancellationToken token)
|
||||
-> Method 'GetSnapshotAsync(Stream destination, CancellationToken token)' is missing XML documentation.
|
||||
- Line 406, MissingDoc, Error, Method, Dispose()
|
||||
-> Method 'Dispose()' is missing XML documentation.
|
||||
- Line 438, MissingDoc, Error, Constructor, SnapshotRequiredException()
|
||||
-> Constructor 'SnapshotRequiredException()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs
|
||||
Issues:
|
||||
- Line 8, MissingDoc, Error, Property, ShouldApply
|
||||
-> Property 'ShouldApply' is missing XML documentation
|
||||
- Line 9, MissingDoc, Error, Property, MergedDocument
|
||||
-> Property 'MergedDocument' is missing XML documentation
|
||||
- Line 11, MissingDoc, Error, Constructor, ConflictResolutionResult(bool shouldApply, Document? mergedDocument)
|
||||
-> Constructor 'ConflictResolutionResult(bool shouldApply, Document? mergedDocument)' is missing XML documentation.
|
||||
- Line 17, MissingDoc, Error, Method, Apply(Document document)
|
||||
-> Method 'Apply(Document document)' is missing XML documentation.
|
||||
- Line 18, MissingDoc, Error, Method, Ignore()
|
||||
-> Method 'Ignore()' is missing XML documentation.
|
||||
- Line 23, 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/Sync/PendingOperation.cs
|
||||
Issues:
|
||||
- Line 12, MissingDoc, Error, Property, Type
|
||||
-> Property 'Type' is missing XML documentation
|
||||
- Line 13, MissingDoc, Error, Property, Collection
|
||||
-> Property 'Collection' is missing XML documentation
|
||||
- Line 14, MissingDoc, Error, Property, Key
|
||||
-> Property 'Key' is missing XML documentation
|
||||
- Line 15, MissingDoc, Error, Property, Data
|
||||
-> Property 'Data' is missing XML documentation
|
||||
- Line 16, MissingDoc, Error, Property, QueuedAt
|
||||
-> Property 'QueuedAt' is missing XML documentation
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/SnapshotMetadata.cs
|
||||
Issues:
|
||||
- Line 5, MissingDoc, Error, Property, NodeId
|
||||
-> Property 'NodeId' is missing XML documentation
|
||||
- Line 6, MissingDoc, Error, Property, TimestampPhysicalTime
|
||||
-> Property 'TimestampPhysicalTime' is missing XML documentation
|
||||
- Line 7, MissingDoc, Error, Property, TimestampLogicalCounter
|
||||
-> Property 'TimestampLogicalCounter' is missing XML documentation
|
||||
- Line 8, MissingDoc, Error, Property, Hash
|
||||
-> Property 'Hash' is missing XML documentation
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs
|
||||
Issues:
|
||||
- Line 12, MissingParam, Warning, Method, HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing <param name="token"> documentation.
|
||||
- Line 12, MissingParam, Warning, Method, HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing <param name="myNodeId"> documentation.
|
||||
- Line 12, MissingParam, Warning, Method, HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing <param name="isInitiator"> documentation.
|
||||
- Line 12, MissingParam, Warning, Method, HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing <param name="stream"> documentation.
|
||||
- Line 17, MissingDoc, Error, Property, EncryptKey
|
||||
-> Property 'EncryptKey' is missing XML documentation
|
||||
- Line 18, MissingDoc, Error, Property, DecryptKey
|
||||
-> Property 'DecryptKey' is missing XML documentation
|
||||
- Line 22, MissingDoc, Error, Constructor, CipherState(byte[] encryptKey, byte[] decryptKey)
|
||||
-> Constructor 'CipherState(byte[] encryptKey, byte[] decryptKey)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs
|
||||
Issues:
|
||||
- Line 24, MissingDoc, Error, Constructor, ProtocolHandler(ILogger logger, INetworkTelemetryService? telemetry)
|
||||
-> Constructor 'ProtocolHandler(ILogger logger, INetworkTelemetryService? telemetry)' is missing XML documentation.
|
||||
- Line 30, MissingDoc, Error, Method, SendMessageAsync(Stream stream, MessageType type, IMessage message, bool useCompression, CipherState? cipherState, CancellationToken token)
|
||||
-> Method 'SendMessageAsync(Stream stream, MessageType type, IMessage message, bool useCompression, CipherState? cipherState, CancellationToken token)' is missing XML documentation.
|
||||
- Line 109, MissingDoc, Error, Method, ReadMessageAsync(Stream stream, CipherState? cipherState, CancellationToken token)
|
||||
-> Method 'ReadMessageAsync(Stream stream, CipherState? cipherState, CancellationToken token)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/NodeCacheEntry.cs
|
||||
Issues:
|
||||
- Line 7, MissingDoc, Error, Property, Timestamp
|
||||
-> Property 'Timestamp' is missing XML documentation
|
||||
- Line 8, MissingDoc, Error, Property, Hash
|
||||
-> Property 'Hash' is missing XML documentation
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ICBDDCHealthCheck.cs
|
||||
Issues:
|
||||
- Line 8, MissingDoc, Error, Method, CheckAsync(CancellationToken cancellationToken)
|
||||
-> Method 'CheckAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IAuthenticator.cs
|
||||
Issues:
|
||||
- Line 7, MissingDoc, Error, Method, ValidateAsync(string nodeId, string token)
|
||||
-> Method 'ValidateAsync(string nodeId, string token)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpSyncServer.cs
|
||||
Issues:
|
||||
- Line 58, MissingParam, Warning, Constructor, TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<TcpSyncServer> logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry)
|
||||
-> Constructor 'TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<TcpSyncServer> logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry)' is missing <param name="telemetry"> documentation.
|
||||
- Line 58, MissingParam, Warning, Constructor, TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<TcpSyncServer> logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry)
|
||||
-> Constructor 'TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<TcpSyncServer> logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry)' is missing <param name="documentStore"> 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