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
161
docs-fix-batch-5.md
Normal file
161
docs-fix-batch-5.md
Normal file
@@ -0,0 +1,161 @@
|
||||
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 5 OF 6 ===
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs
|
||||
Issues:
|
||||
- Line 12, MissingDoc, Error, Property, PhysicalTime
|
||||
-> Property 'PhysicalTime' is missing XML documentation
|
||||
- Line 13, MissingDoc, Error, Property, LogicalCounter
|
||||
-> Property 'LogicalCounter' is missing XML documentation
|
||||
- Line 14, MissingDoc, Error, Property, NodeId
|
||||
-> Property 'NodeId' is missing XML documentation
|
||||
- Line 16, MissingDoc, Error, Constructor, HlcTimestamp(long physicalTime, int logicalCounter, string nodeId)
|
||||
-> Constructor 'HlcTimestamp(long physicalTime, int logicalCounter, string nodeId)' is missing XML documentation.
|
||||
- Line 27, MissingParam, Warning, Method, CompareTo(HlcTimestamp other)
|
||||
-> Method 'CompareTo(HlcTimestamp other)' is missing <param name="other"> documentation.
|
||||
- Line 39, MissingDoc, Error, Method, CompareTo(object? obj)
|
||||
-> Method 'CompareTo(object? obj)' is missing XML documentation.
|
||||
- Line 46, MissingDoc, Error, Method, Equals(HlcTimestamp other)
|
||||
-> Method 'Equals(HlcTimestamp other)' is missing XML documentation.
|
||||
- Line 53, MissingDoc, Error, Method, Equals(object? obj)
|
||||
-> Method 'Equals(object? obj)' is missing XML documentation.
|
||||
- Line 58, MissingDoc, Error, Method, GetHashCode()
|
||||
-> Method 'GetHashCode()' is missing XML documentation.
|
||||
- Line 80, MissingDoc, Error, Method, ToString()
|
||||
-> Method 'ToString()' is missing XML documentation.
|
||||
- Line 82, MissingDoc, Error, Method, Parse(string s)
|
||||
-> Method 'Parse(string s)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs
|
||||
Issues:
|
||||
- Line 7, MissingDoc, Error, Method, CleanupInactivePeers(TimeSpan inactiveThreshold)
|
||||
-> Method 'CleanupInactivePeers(TimeSpan inactiveThreshold)' is missing XML documentation.
|
||||
- Line 8, MissingDoc, Error, Method, GetStatus()
|
||||
-> Method 'GetStatus()' is missing XML documentation.
|
||||
- Line 9, MissingDoc, Error, Method, RecordError(string message, string? peerNodeId, string? errorCode)
|
||||
-> Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing XML documentation.
|
||||
- Line 10, MissingDoc, Error, Method, RecordPeerFailure(string nodeId)
|
||||
-> Method 'RecordPeerFailure(string nodeId)' is missing XML documentation.
|
||||
- Line 11, MissingDoc, Error, Method, RecordPeerSuccess(string nodeId)
|
||||
-> Method 'RecordPeerSuccess(string nodeId)' is missing XML documentation.
|
||||
- Line 12, MissingDoc, Error, Method, RecordSync(int documentCount, long bytesTransferred)
|
||||
-> Method 'RecordSync(int documentCount, long bytesTransferred)' is missing XML documentation.
|
||||
- Line 13, MissingDoc, Error, Method, SetOnlineStatus(bool isOnline)
|
||||
-> Method 'SetOnlineStatus(bool isOnline)' is missing XML documentation.
|
||||
- Line 14, MissingDoc, Error, Method, UpdatePeer(string nodeId, string address, bool isConnected)
|
||||
-> Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs
|
||||
Issues:
|
||||
- Line 22, MissingDoc, Error, Event, ChangesApplied
|
||||
-> Event 'ChangesApplied' is missing XML documentation.
|
||||
- Line 24, MissingDoc, Error, Method, OnChangesApplied(IEnumerable<OplogEntry> appliedEntries)
|
||||
-> Method 'OnChangesApplied(IEnumerable<OplogEntry> appliedEntries)' is missing XML documentation.
|
||||
- Line 29, MissingDoc, Error, Constructor, OplogStore(IDocumentStore documentStore, IConflictResolver conflictResolver, IVectorClockService vectorClockService, ISnapshotMetadataStore? snapshotMetadataStore)
|
||||
-> Constructor 'OplogStore(IDocumentStore documentStore, IConflictResolver conflictResolver, IVectorClockService vectorClockService, ISnapshotMetadataStore? snapshotMetadataStore)' is missing XML documentation.
|
||||
- Line 209, MissingDoc, Error, Method, DropAsync(CancellationToken cancellationToken)
|
||||
-> Method 'DropAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 211, MissingDoc, Error, Method, ExportAsync(CancellationToken cancellationToken)
|
||||
-> Method 'ExportAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 213, MissingDoc, Error, Method, ImportAsync(IEnumerable<OplogEntry> items, CancellationToken cancellationToken)
|
||||
-> Method 'ImportAsync(IEnumerable<OplogEntry> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 215, MissingDoc, Error, Method, MergeAsync(IEnumerable<OplogEntry> items, CancellationToken cancellationToken)
|
||||
-> Method 'MergeAsync(IEnumerable<OplogEntry> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/IDocumentCache.cs
|
||||
Issues:
|
||||
- Line 7, MissingDoc, Error, Method, Clear()
|
||||
-> Method 'Clear()' is missing XML documentation.
|
||||
- Line 8, MissingDoc, Error, Method, Get(string collection, string key)
|
||||
-> Method 'Get(string collection, string key)' is missing XML documentation.
|
||||
- Line 9, MissingDoc, Error, Method, GetStatistics()
|
||||
-> Method 'GetStatistics()' is missing XML documentation.
|
||||
- Line 10, MissingDoc, Error, Method, Remove(string collection, string key)
|
||||
-> Method 'Remove(string collection, string key)' is missing XML documentation.
|
||||
- Line 11, MissingDoc, Error, Method, Set(string collection, string key, Document document)
|
||||
-> Method 'Set(string collection, string key, Document document)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/BullyLeaderElectionService.cs
|
||||
Issues:
|
||||
- Line 29, MissingDoc, Error, Property, IsCloudGateway
|
||||
-> Property 'IsCloudGateway' is missing XML documentation
|
||||
- Line 30, MissingDoc, Error, Property, CurrentGatewayNodeId
|
||||
-> Property 'CurrentGatewayNodeId' is missing XML documentation
|
||||
- Line 32, MissingDoc, Error, Event, LeadershipChanged
|
||||
-> Event 'LeadershipChanged' is missing XML documentation.
|
||||
- Line 53, MissingDoc, Error, Method, Start()
|
||||
-> Method 'Start()' is missing XML documentation.
|
||||
- Line 70, MissingDoc, Error, Method, Stop()
|
||||
-> Method 'Stop()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IOfflineQueue.cs
|
||||
Issues:
|
||||
- Line 9, MissingDoc, Error, Property, Count
|
||||
-> Property 'Count' is missing XML documentation
|
||||
- Line 11, MissingDoc, Error, Method, Clear()
|
||||
-> Method 'Clear()' is missing XML documentation.
|
||||
- Line 12, MissingDoc, Error, Method, Enqueue(PendingOperation operation)
|
||||
-> Method 'Enqueue(PendingOperation operation)' is missing XML documentation.
|
||||
- Line 13, MissingDoc, Error, Method, FlushAsync(Func<PendingOperation, Task> executor, CancellationToken cancellationToken)
|
||||
-> Method 'FlushAsync(Func<PendingOperation, Task> executor, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNodeService.cs
|
||||
Issues:
|
||||
- Line 17, MissingDoc, Error, Constructor, CBDDCNodeService(ICBDDCNode node, ILogger<CBDDCNodeService> logger)
|
||||
-> Constructor 'CBDDCNodeService(ICBDDCNode node, ILogger<CBDDCNodeService> logger)' is missing XML documentation.
|
||||
- Line 23, MissingDoc, Error, Method, StartAsync(CancellationToken cancellationToken)
|
||||
-> Method 'StartAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
- Line 47, MissingDoc, Error, Method, StopAsync(CancellationToken cancellationToken)
|
||||
-> Method 'StopAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncServer.cs
|
||||
Issues:
|
||||
- Line 15, MissingDoc, Error, Method, Start()
|
||||
-> Method 'Start()' is missing XML documentation.
|
||||
- Line 17, MissingDoc, Error, Method, Stop()
|
||||
-> Method 'Stop()' is missing XML documentation.
|
||||
- Line 19, MissingDoc, Error, Property, ListeningEndpoint
|
||||
-> Property 'ListeningEndpoint' is missing XML documentation
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/SecureHandshakeService.cs
|
||||
Issues:
|
||||
- Line 14, MissingDoc, Error, Constructor, SecureHandshakeService(ILogger<SecureHandshakeService>? logger)
|
||||
-> Constructor 'SecureHandshakeService(ILogger<SecureHandshakeService>? logger)' is missing XML documentation.
|
||||
- Line 24, MissingDoc, Error, Method, HandshakeAsync(Stream stream, bool isInitiator, string myNodeId, CancellationToken token)
|
||||
-> Method 'HandshakeAsync(Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/CBDDCServiceCollectionExtensions.cs
|
||||
Issues:
|
||||
- Line 14, MissingDoc, Error, Method, AddCBDDCCore(IServiceCollection services)
|
||||
-> Method 'AddCBDDCCore(IServiceCollection services)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/CorruptDatabaseException.cs
|
||||
Issues:
|
||||
- Line 7, MissingDoc, Error, Constructor, CorruptDatabaseException(string message, Exception innerException)
|
||||
-> Constructor 'CorruptDatabaseException(string message, Exception innerException)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/JwtOAuth2Validator.cs
|
||||
Issues:
|
||||
- Line 41, MissingDoc, Error, Method, ValidateTokenAsync(string jwtToken, CancellationToken cancellationToken)
|
||||
-> Method 'ValidateTokenAsync(string jwtToken, CancellationToken cancellationToken)' is missing XML 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