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:
159
docs-fix-batch-2.md
Normal file
159
docs-fix-batch-2.md
Normal file
@@ -0,0 +1,159 @@
|
||||
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 2 OF 6 ===
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
Issues:
|
||||
- Line 10, MissingDoc, Error, Property, Version
|
||||
-> Property 'Version' is missing XML documentation
|
||||
- Line 11, MissingDoc, Error, Property, CreatedAt
|
||||
-> Property 'CreatedAt' is missing XML documentation
|
||||
- Line 12, MissingDoc, Error, Property, NodeId
|
||||
-> Property 'NodeId' is missing XML documentation
|
||||
- Line 13, MissingDoc, Error, Property, Documents
|
||||
-> Property 'Documents' is missing XML documentation
|
||||
- Line 14, MissingDoc, Error, Property, Oplog
|
||||
-> Property 'Oplog' is missing XML documentation
|
||||
- Line 15, MissingDoc, Error, Property, SnapshotMetadata
|
||||
-> Property 'SnapshotMetadata' is missing XML documentation
|
||||
- Line 16, MissingDoc, Error, Property, RemotePeers
|
||||
-> Property 'RemotePeers' is missing XML documentation
|
||||
- Line 21, MissingDoc, Error, Property, Collection
|
||||
-> Property 'Collection' is missing XML documentation
|
||||
- Line 22, MissingDoc, Error, Property, Key
|
||||
-> Property 'Key' is missing XML documentation
|
||||
- Line 23, MissingDoc, Error, Property, JsonData
|
||||
-> Property 'JsonData' is missing XML documentation
|
||||
- Line 24, MissingDoc, Error, Property, IsDeleted
|
||||
-> Property 'IsDeleted' is missing XML documentation
|
||||
- Line 25, MissingDoc, Error, Property, HlcWall
|
||||
-> Property 'HlcWall' is missing XML documentation
|
||||
- Line 26, MissingDoc, Error, Property, HlcLogic
|
||||
-> Property 'HlcLogic' is missing XML documentation
|
||||
- Line 27, MissingDoc, Error, Property, HlcNode
|
||||
-> Property 'HlcNode' is missing XML documentation
|
||||
- Line 32, MissingDoc, Error, Property, Collection
|
||||
-> Property 'Collection' is missing XML documentation
|
||||
- Line 33, MissingDoc, Error, Property, Key
|
||||
-> Property 'Key' is missing XML documentation
|
||||
- Line 34, MissingDoc, Error, Property, Operation
|
||||
-> Property 'Operation' is missing XML documentation
|
||||
- Line 35, MissingDoc, Error, Property, JsonData
|
||||
-> Property 'JsonData' is missing XML documentation
|
||||
- Line 36, MissingDoc, Error, Property, HlcWall
|
||||
-> Property 'HlcWall' is missing XML documentation
|
||||
- Line 37, MissingDoc, Error, Property, HlcLogic
|
||||
-> Property 'HlcLogic' is missing XML documentation
|
||||
- Line 38, MissingDoc, Error, Property, HlcNode
|
||||
-> Property 'HlcNode' is missing XML documentation
|
||||
- Line 39, MissingDoc, Error, Property, Hash
|
||||
-> Property 'Hash' is missing XML documentation
|
||||
- Line 40, MissingDoc, Error, Property, PreviousHash
|
||||
-> Property 'PreviousHash' is missing XML documentation
|
||||
- Line 45, MissingDoc, Error, Property, NodeId
|
||||
-> Property 'NodeId' is missing XML documentation
|
||||
- Line 46, MissingDoc, Error, Property, HlcWall
|
||||
-> Property 'HlcWall' is missing XML documentation
|
||||
- Line 47, MissingDoc, Error, Property, HlcLogic
|
||||
-> Property 'HlcLogic' is missing XML documentation
|
||||
- Line 48, MissingDoc, Error, Property, Hash
|
||||
-> Property 'Hash' is missing XML documentation
|
||||
- Line 53, MissingDoc, Error, Property, NodeId
|
||||
-> Property 'NodeId' is missing XML documentation
|
||||
- Line 54, MissingDoc, Error, Property, Address
|
||||
-> Property 'Address' is missing XML documentation
|
||||
- Line 55, MissingDoc, Error, Property, Type
|
||||
-> Property 'Type' is missing XML documentation
|
||||
- Line 56, MissingDoc, Error, Property, OAuth2Json
|
||||
-> Property 'OAuth2Json' is missing XML documentation
|
||||
- Line 57, MissingDoc, Error, Property, IsEnabled
|
||||
-> Property 'IsEnabled' is missing XML documentation
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs
|
||||
Issues:
|
||||
- Line 44, MissingDoc, Error, Property, FailureCount
|
||||
-> Property 'FailureCount' is missing XML documentation
|
||||
- Line 45, MissingDoc, Error, Property, NextRetryTime
|
||||
-> Property 'NextRetryTime' is missing XML documentation
|
||||
- Line 50, MissingDoc, Error, Constructor, SyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILoggerFactory loggerFactory, IPeerHandshakeService? handshakeService, INetworkTelemetryService? telemetry)
|
||||
-> Constructor 'SyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILoggerFactory loggerFactory, IPeerHandshakeService? handshakeService, INetworkTelemetryService? telemetry)' is missing XML documentation.
|
||||
- Line 73, MissingDoc, Error, Method, Start()
|
||||
-> Method 'Start()' is missing XML documentation.
|
||||
- Line 101, MissingDoc, Error, Method, Stop()
|
||||
-> Method 'Stop()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/PeerConfigurationStore.cs
|
||||
Issues:
|
||||
- Line 23, MissingDoc, Error, Method, DropAsync(CancellationToken cancellationToken)
|
||||
-> Method 'DropAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 25, MissingDoc, Error, Method, ExportAsync(CancellationToken cancellationToken)
|
||||
-> Method 'ExportAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 27, MissingDoc, Error, Method, ImportAsync(IEnumerable<RemotePeerConfiguration> items, CancellationToken cancellationToken)
|
||||
-> Method 'ImportAsync(IEnumerable<RemotePeerConfiguration> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 35, MissingDoc, Error, Method, MergeAsync(IEnumerable<RemotePeerConfiguration> items, CancellationToken cancellationToken)
|
||||
-> Method 'MergeAsync(IEnumerable<RemotePeerConfiguration> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/IDiscoveryService.cs
|
||||
Issues:
|
||||
- Line 9, MissingDoc, Error, Method, GetActivePeers()
|
||||
-> Method 'GetActivePeers()' is missing XML documentation.
|
||||
- Line 10, MissingDoc, Error, Method, Start()
|
||||
-> Method 'Start()' is missing XML documentation.
|
||||
- Line 11, MissingDoc, Error, Method, Stop()
|
||||
-> Method 'Stop()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentMetadataStore.cs
|
||||
Issues:
|
||||
- Line 89, MissingDoc, Error, Constructor, DocumentMetadata()
|
||||
-> Constructor 'DocumentMetadata()' is missing XML documentation.
|
||||
- Line 91, MissingDoc, Error, Constructor, DocumentMetadata(string collection, string key, HlcTimestamp updatedAt, bool isDeleted)
|
||||
-> Constructor 'DocumentMetadata(string collection, string key, HlcTimestamp updatedAt, bool isDeleted)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs
|
||||
Issues:
|
||||
- Line 25, MissingDoc, Error, Constructor, SyncStatusTracker(ILogger<SyncStatusTracker>? logger)
|
||||
-> Constructor 'SyncStatusTracker(ILogger<SyncStatusTracker>? logger)' is missing XML documentation.
|
||||
- Line 33, MissingParam, Warning, Method, SetOnlineStatus(bool isOnline)
|
||||
-> Method 'SetOnlineStatus(bool isOnline)' is missing <param name="isOnline"> documentation.
|
||||
- Line 48, MissingParam, Warning, Method, RecordSync(int documentCount, long bytesTransferred)
|
||||
-> Method 'RecordSync(int documentCount, long bytesTransferred)' is missing <param name="bytesTransferred"> documentation.
|
||||
- Line 48, MissingParam, Warning, Method, RecordSync(int documentCount, long bytesTransferred)
|
||||
-> Method 'RecordSync(int documentCount, long bytesTransferred)' is missing <param name="documentCount"> documentation.
|
||||
- Line 63, MissingParam, Warning, Method, RecordError(string message, string? peerNodeId, string? errorCode)
|
||||
-> Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing <param name="errorCode"> documentation.
|
||||
- Line 63, MissingParam, Warning, Method, RecordError(string message, string? peerNodeId, string? errorCode)
|
||||
-> Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing <param name="peerNodeId"> documentation.
|
||||
- Line 63, MissingParam, Warning, Method, RecordError(string message, string? peerNodeId, string? errorCode)
|
||||
-> Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing <param name="message"> documentation.
|
||||
- Line 89, MissingParam, Warning, Method, UpdatePeer(string nodeId, string address, bool isConnected)
|
||||
-> Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing <param name="isConnected"> documentation.
|
||||
- Line 89, MissingParam, Warning, Method, UpdatePeer(string nodeId, string address, bool isConnected)
|
||||
-> Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing <param name="address"> documentation.
|
||||
- Line 89, MissingParam, Warning, Method, UpdatePeer(string nodeId, string address, bool isConnected)
|
||||
-> Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing <param name="nodeId"> documentation.
|
||||
- Line 119, MissingParam, Warning, Method, RecordPeerSuccess(string nodeId)
|
||||
-> Method 'RecordPeerSuccess(string nodeId)' is missing <param name="nodeId"> documentation.
|
||||
- Line 134, MissingParam, Warning, Method, RecordPeerFailure(string nodeId)
|
||||
-> Method 'RecordPeerFailure(string nodeId)' is missing <param name="nodeId"> documentation.
|
||||
- Line 169, MissingParam, Warning, Method, CleanupInactivePeers(TimeSpan inactiveThreshold)
|
||||
-> Method 'CleanupInactivePeers(TimeSpan inactiveThreshold)' is missing <param name="inactiveThreshold"> 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