175 lines
13 KiB
Markdown
175 lines
13 KiB
Markdown
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 3 OF 6 ===
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs
|
|
Issues:
|
|
- Line 15, MissingDoc, Error, Constructor, CBDDCException(string errorCode, string message)
|
|
-> Constructor 'CBDDCException(string errorCode, string message)' is missing XML documentation.
|
|
- Line 21, MissingDoc, Error, Constructor, CBDDCException(string errorCode, string message, Exception innerException)
|
|
-> Constructor 'CBDDCException(string errorCode, string message, Exception innerException)' is missing XML documentation.
|
|
- Line 33, MissingDoc, Error, Constructor, NetworkException(string message)
|
|
-> Constructor 'NetworkException(string message)' is missing XML documentation.
|
|
- Line 36, MissingDoc, Error, Constructor, NetworkException(string message, Exception innerException)
|
|
-> Constructor 'NetworkException(string message, Exception innerException)' is missing XML documentation.
|
|
- Line 45, MissingDoc, Error, Constructor, PersistenceException(string message)
|
|
-> Constructor 'PersistenceException(string message)' is missing XML documentation.
|
|
- Line 48, MissingDoc, Error, Constructor, PersistenceException(string message, Exception innerException)
|
|
-> Constructor 'PersistenceException(string message, Exception innerException)' is missing XML documentation.
|
|
- Line 57, MissingDoc, Error, Constructor, SyncException(string message)
|
|
-> Constructor 'SyncException(string message)' is missing XML documentation.
|
|
- Line 60, MissingDoc, Error, Constructor, SyncException(string message, Exception innerException)
|
|
-> Constructor 'SyncException(string message, Exception innerException)' is missing XML documentation.
|
|
- Line 69, MissingDoc, Error, Constructor, ConfigurationException(string message)
|
|
-> Constructor 'ConfigurationException(string message)' is missing XML documentation.
|
|
- Line 78, MissingDoc, Error, Constructor, DatabaseCorruptionException(string message)
|
|
-> Constructor 'DatabaseCorruptionException(string message)' is missing XML documentation.
|
|
- Line 81, MissingDoc, Error, Constructor, DatabaseCorruptionException(string message, Exception innerException)
|
|
-> Constructor 'DatabaseCorruptionException(string message, Exception innerException)' is missing XML documentation.
|
|
- Line 90, MissingDoc, Error, Constructor, TimeoutException(string operation, int timeoutMs)
|
|
-> Constructor 'TimeoutException(string operation, int timeoutMs)' is missing XML documentation.
|
|
- Line 97, MissingDoc, Error, Property, Key
|
|
-> Property 'Key' is missing XML documentation
|
|
- Line 98, MissingDoc, Error, Property, Collection
|
|
-> Property 'Collection' is missing XML documentation
|
|
- Line 100, MissingDoc, Error, Constructor, DocumentNotFoundException(string collection, string key)
|
|
-> Constructor 'DocumentNotFoundException(string collection, string key)' is missing XML documentation.
|
|
- Line 110, MissingDoc, Error, Constructor, CBDDCConcurrencyException(string message)
|
|
-> Constructor 'CBDDCConcurrencyException(string message)' is missing XML documentation.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Document.cs
|
|
Issues:
|
|
- Line 9, MissingDoc, Error, Property, Collection
|
|
-> Property 'Collection' is missing XML documentation
|
|
- Line 10, MissingDoc, Error, Property, Key
|
|
-> Property 'Key' is missing XML documentation
|
|
- Line 11, MissingDoc, Error, Property, Content
|
|
-> Property 'Content' is missing XML documentation
|
|
- Line 12, MissingDoc, Error, Property, UpdatedAt
|
|
-> Property 'UpdatedAt' is missing XML documentation
|
|
- Line 13, MissingDoc, Error, Property, IsDeleted
|
|
-> Property 'IsDeleted' is missing XML documentation
|
|
- Line 15, MissingDoc, Error, Constructor, Document(string collection, string key, JsonElement content, HlcTimestamp updatedAt, bool isDeleted)
|
|
-> Constructor 'Document(string collection, string key, JsonElement content, HlcTimestamp updatedAt, bool isDeleted)' is missing XML documentation.
|
|
- Line 24, MissingDoc, Error, Method, Merge(OplogEntry oplogEntry, IConflictResolver? resolver)
|
|
-> Method 'Merge(OplogEntry oplogEntry, IConflictResolver? resolver)' is missing XML documentation.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs
|
|
Issues:
|
|
- Line 39, MissingDoc, Error, Method, AddCloudPeerAsync(string nodeId, string address, OAuth2Configuration oauth2Config, CancellationToken cancellationToken)
|
|
-> Method 'AddCloudPeerAsync(string nodeId, string address, OAuth2Configuration oauth2Config, CancellationToken cancellationToken)' is missing XML documentation.
|
|
- Line 60, MissingDoc, Error, Method, AddStaticPeerAsync(string nodeId, string address, CancellationToken cancellationToken)
|
|
-> Method 'AddStaticPeerAsync(string nodeId, string address, CancellationToken cancellationToken)' is missing XML documentation.
|
|
- Line 78, MissingDoc, Error, Method, RemoveRemotePeerAsync(string nodeId, CancellationToken cancellationToken)
|
|
-> Method 'RemoveRemotePeerAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation.
|
|
- Line 86, MissingDoc, Error, Method, GetAllRemotePeersAsync(CancellationToken cancellationToken)
|
|
-> Method 'GetAllRemotePeersAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
|
- Line 91, MissingDoc, Error, Method, EnablePeerAsync(string nodeId, CancellationToken cancellationToken)
|
|
-> Method 'EnablePeerAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation.
|
|
- Line 110, MissingDoc, Error, Method, DisablePeerAsync(string nodeId, CancellationToken cancellationToken)
|
|
-> Method 'DisablePeerAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/StaticPeerNodeConfigurationProvider.cs
|
|
Issues:
|
|
- Line 8, MissingDoc, Error, Property, Configuration
|
|
-> Property 'Configuration' is missing XML documentation
|
|
- Line 21, MissingDoc, Error, Constructor, StaticPeerNodeConfigurationProvider(PeerNodeConfiguration configuration)
|
|
-> Constructor 'StaticPeerNodeConfigurationProvider(PeerNodeConfiguration configuration)' is missing XML documentation.
|
|
- Line 26, MissingDoc, Error, Event, ConfigurationChanged
|
|
-> Event 'ConfigurationChanged' is missing XML documentation.
|
|
- Line 28, MissingDoc, Error, Method, GetConfiguration()
|
|
-> Method 'GetConfiguration()' is missing XML documentation.
|
|
- Line 33, MissingDoc, Error, Method, OnConfigurationChanged(PeerNodeConfiguration newConfig)
|
|
-> Method 'OnConfigurationChanged(PeerNodeConfiguration newConfig)' is missing XML documentation.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs
|
|
Issues:
|
|
- Line 16, MissingDoc, Error, Property, Document
|
|
-> Property 'Document' is missing XML documentation
|
|
- Line 17, MissingDoc, Error, Property, Node
|
|
-> Property 'Node' is missing XML documentation
|
|
- Line 19, MissingDoc, Error, Constructor, CacheEntry(Document document, LinkedListNode<string> node)
|
|
-> Constructor 'CacheEntry(Document document, LinkedListNode<string> node)' is missing XML documentation.
|
|
- Line 41, MissingDoc, Error, Constructor, DocumentCache(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<DocumentCache>? logger)
|
|
-> Constructor 'DocumentCache(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<DocumentCache>? logger)' is missing XML documentation.
|
|
- Line 50, MissingParam, Warning, Method, Get(string collection, string key)
|
|
-> Method 'Get(string collection, string key)' is missing <param name="key"> documentation.
|
|
- Line 50, MissingParam, Warning, Method, Get(string collection, string key)
|
|
-> Method 'Get(string collection, string key)' is missing <param name="collection"> documentation.
|
|
- Line 76, MissingParam, Warning, Method, Set(string collection, string key, Document document)
|
|
-> Method 'Set(string collection, string key, Document document)' is missing <param name="document"> documentation.
|
|
- Line 76, MissingParam, Warning, Method, Set(string collection, string key, Document document)
|
|
-> Method 'Set(string collection, string key, Document document)' is missing <param name="key"> documentation.
|
|
- Line 76, MissingParam, Warning, Method, Set(string collection, string key, Document document)
|
|
-> Method 'Set(string collection, string key, Document document)' is missing <param name="collection"> documentation.
|
|
- Line 112, MissingParam, Warning, Method, Remove(string collection, string key)
|
|
-> Method 'Remove(string collection, string key)' is missing <param name="key"> documentation.
|
|
- Line 112, MissingParam, Warning, Method, Remove(string collection, string key)
|
|
-> Method 'Remove(string collection, string key)' is missing <param name="collection"> documentation.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompositeDiscoveryService.cs
|
|
Issues:
|
|
- Line 53, MissingDoc, Error, Method, GetActivePeers()
|
|
-> Method 'GetActivePeers()' is missing XML documentation.
|
|
- Line 62, MissingDoc, Error, Method, Start()
|
|
-> Method 'Start()' is missing XML documentation.
|
|
- Line 97, MissingDoc, Error, Method, Stop()
|
|
-> Method 'Stop()' is missing XML documentation.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/IPeerNodeConfigurationProvider.cs
|
|
Issues:
|
|
- Line 6, MissingDoc, Error, Delegate, PeerNodeConfigurationChangedEventHandler
|
|
-> Delegate 'PeerNodeConfigurationChangedEventHandler' is missing XML documentation.
|
|
- Line 21, MalformedXml, Error, Method, GetConfiguration()
|
|
-> Method 'GetConfiguration()' has malformed XML documentation that cannot be parsed.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncOrchestrator.cs
|
|
Issues:
|
|
- Line 7, MissingDoc, Error, Method, Start()
|
|
-> Method 'Start()' is missing XML documentation.
|
|
- Line 8, MissingDoc, Error, Method, Stop()
|
|
-> Method 'Stop()' is missing XML documentation.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/OfflineQueue.cs
|
|
Issues:
|
|
- Line 22, MissingDoc, Error, Constructor, OfflineQueue(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<OfflineQueue>? logger)
|
|
-> Constructor 'OfflineQueue(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<OfflineQueue>? logger)' is missing XML documentation.
|
|
- Line 45, MissingParam, Warning, Method, Enqueue(PendingOperation operation)
|
|
-> Method 'Enqueue(PendingOperation operation)' is missing <param name="operation"> documentation.
|
|
- Line 66, MissingParam, Warning, Method, FlushAsync(Func<PendingOperation, Task> executor, CancellationToken cancellationToken)
|
|
-> Method 'FlushAsync(Func<PendingOperation, Task> executor, CancellationToken cancellationToken)' is missing <param name="cancellationToken"> documentation.
|
|
- Line 66, MissingParam, Warning, Method, FlushAsync(Func<PendingOperation, Task> executor, CancellationToken cancellationToken)
|
|
-> Method 'FlushAsync(Func<PendingOperation, Task> executor, CancellationToken cancellationToken)' is missing <param name="executor"> documentation.
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/RecursiveNodeMergeConflictResolver.cs
|
|
Issues:
|
|
- Line 11, 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.Network/PeerDbNetworkExtensions.cs
|
|
Issues:
|
|
- Line 19, MissingTypeParam, Warning, Method, AddCBDDCNetwork(IServiceCollection services, bool useHostedService)
|
|
-> Method 'AddCBDDCNetwork(IServiceCollection services, bool useHostedService)' is missing <typeparam name="TPeerNodeConfigurationProvider"> documentation.
|
|
- Line 19, MissingParam, Warning, Method, AddCBDDCNetwork(IServiceCollection services, bool useHostedService)
|
|
-> Method 'AddCBDDCNetwork(IServiceCollection services, bool useHostedService)' is missing <param name="services"> 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.
|