Clean up generated doc-fix artifacts and document E2E helper members
All checks were successful
CI / verify (push) Successful in 2m33s
All checks were successful
CI / verify (push) Successful in 2m33s
Remove temporary docs reports/batch files and add missing XML docs in ClusterCrudSyncE2ETests support types to keep the repo clean and CommentChecker-compliant.
This commit is contained in:
@@ -1,7 +0,0 @@
|
||||
# Documentation Analysis Report
|
||||
|
||||
Files Scanned: 138
|
||||
Files With Issues: 0
|
||||
Total Issues: 0
|
||||
|
||||
Status: No documentation issues found
|
||||
@@ -1,456 +0,0 @@
|
||||
# Documentation Analysis Report
|
||||
|
||||
Files Scanned: 138
|
||||
Files With Issues: 10
|
||||
Total Issues: 45
|
||||
|
||||
## Issues
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/OplogPruneCutoffDecision.cs
|
||||
LINE: 52
|
||||
CATEGORY: MissingParam
|
||||
SEVERITY: Warning
|
||||
MEMBER: Method
|
||||
SIGNATURE: WithCutoff(HlcTimestamp retentionCutoff, HlcTimestamp? confirmationCutoff, HlcTimestamp effectiveCutoff, string reason)
|
||||
MESSAGE: Method 'WithCutoff(HlcTimestamp retentionCutoff, HlcTimestamp? confirmationCutoff, HlcTimestamp effectiveCutoff, string reason)' is missing <param name="reason"> documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/OplogPruneCutoffDecision.cs
|
||||
LINE: 52
|
||||
CATEGORY: MissingParam
|
||||
SEVERITY: Warning
|
||||
MEMBER: Method
|
||||
SIGNATURE: WithCutoff(HlcTimestamp retentionCutoff, HlcTimestamp? confirmationCutoff, HlcTimestamp effectiveCutoff, string reason)
|
||||
MESSAGE: Method 'WithCutoff(HlcTimestamp retentionCutoff, HlcTimestamp? confirmationCutoff, HlcTimestamp effectiveCutoff, string reason)' is missing <param name="effectiveCutoff"> documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/OplogPruneCutoffDecision.cs
|
||||
LINE: 52
|
||||
CATEGORY: MissingParam
|
||||
SEVERITY: Warning
|
||||
MEMBER: Method
|
||||
SIGNATURE: WithCutoff(HlcTimestamp retentionCutoff, HlcTimestamp? confirmationCutoff, HlcTimestamp effectiveCutoff, string reason)
|
||||
MESSAGE: Method 'WithCutoff(HlcTimestamp retentionCutoff, HlcTimestamp? confirmationCutoff, HlcTimestamp effectiveCutoff, string reason)' is missing <param name="confirmationCutoff"> documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/OplogPruneCutoffDecision.cs
|
||||
LINE: 52
|
||||
CATEGORY: MissingParam
|
||||
SEVERITY: Warning
|
||||
MEMBER: Method
|
||||
SIGNATURE: WithCutoff(HlcTimestamp retentionCutoff, HlcTimestamp? confirmationCutoff, HlcTimestamp effectiveCutoff, string reason)
|
||||
MESSAGE: Method 'WithCutoff(HlcTimestamp retentionCutoff, HlcTimestamp? confirmationCutoff, HlcTimestamp effectiveCutoff, string reason)' is missing <param name="retentionCutoff"> documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/OplogPruneCutoffDecision.cs
|
||||
LINE: 69
|
||||
CATEGORY: MissingParam
|
||||
SEVERITY: Warning
|
||||
MEMBER: Method
|
||||
SIGNATURE: NoCutoff(HlcTimestamp retentionCutoff, string reason)
|
||||
MESSAGE: Method 'NoCutoff(HlcTimestamp retentionCutoff, string reason)' is missing <param name="reason"> documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/OplogPruneCutoffDecision.cs
|
||||
LINE: 69
|
||||
CATEGORY: MissingParam
|
||||
SEVERITY: Warning
|
||||
MEMBER: Method
|
||||
SIGNATURE: NoCutoff(HlcTimestamp retentionCutoff, string reason)
|
||||
MESSAGE: Method 'NoCutoff(HlcTimestamp retentionCutoff, string reason)' is missing <param name="retentionCutoff"> documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs
|
||||
LINE: 35
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Constructor
|
||||
SIGNATURE: ProtocolHandler(ILogger logger, INetworkTelemetryService? telemetry)
|
||||
MESSAGE: Constructor 'ProtocolHandler(ILogger logger, INetworkTelemetryService? telemetry)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs
|
||||
LINE: 221
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Constructor
|
||||
SIGNATURE: ForwardingLogger(ILogger inner)
|
||||
MESSAGE: Constructor 'ForwardingLogger(ILogger inner)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs
|
||||
LINE: 226
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: BeginScope(TState state)
|
||||
MESSAGE: Method 'BeginScope(TState state)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs
|
||||
LINE: 231
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: IsEnabled(LogLevel logLevel)
|
||||
MESSAGE: Method 'IsEnabled(LogLevel logLevel)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs
|
||||
LINE: 236
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
|
||||
MESSAGE: Method 'Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs
|
||||
LINE: 252
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RunMaintenanceIfDueAsync(PeerNodeConfiguration config, DateTime now, CancellationToken token)
|
||||
MESSAGE: Method 'RunMaintenanceIfDueAsync(PeerNodeConfiguration config, DateTime now, CancellationToken token)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs
|
||||
LINE: 529
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: BuildMergedPeerList(IEnumerable<PeerNode> discoveredPeers, IEnumerable<PeerNode> knownPeers, string localNodeId)
|
||||
MESSAGE: Method 'BuildMergedPeerList(IEnumerable<PeerNode> discoveredPeers, IEnumerable<PeerNode> knownPeers, string localNodeId)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs
|
||||
LINE: 542
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: EnsurePeersRegisteredAsync(IEnumerable<PeerNode> peers, string localNodeId, CancellationToken token)
|
||||
MESSAGE: Method 'EnsurePeersRegisteredAsync(IEnumerable<PeerNode> peers, string localNodeId, CancellationToken token)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs
|
||||
LINE: 571
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: AdvanceConfirmationsFromVectorClockAsync(string peerNodeId, VectorClock localVectorClock, VectorClock remoteVectorClock, CancellationToken token)
|
||||
MESSAGE: Method 'AdvanceConfirmationsFromVectorClockAsync(string peerNodeId, VectorClock localVectorClock, VectorClock remoteVectorClock, CancellationToken token)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs
|
||||
LINE: 606
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: AdvanceConfirmationForPushedBatchAsync(string peerNodeId, string sourceNodeId, IReadOnlyCollection<OplogEntry> pushedChanges, CancellationToken token)
|
||||
MESSAGE: Method 'AdvanceConfirmationForPushedBatchAsync(string peerNodeId, string sourceNodeId, IReadOnlyCollection<OplogEntry> pushedChanges, CancellationToken token)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/BLite/BLiteDocumentStore.cs
|
||||
LINE: 94
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Constructor
|
||||
SIGNATURE: ForwardingLogger(ILogger inner)
|
||||
MESSAGE: Constructor 'ForwardingLogger(ILogger inner)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/BLite/BLiteDocumentStore.cs
|
||||
LINE: 99
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: BeginScope(TState state)
|
||||
MESSAGE: Method 'BeginScope(TState state)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/BLite/BLiteDocumentStore.cs
|
||||
LINE: 104
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: IsEnabled(LogLevel logLevel)
|
||||
MESSAGE: Method 'IsEnabled(LogLevel logLevel)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/BLite/BLiteDocumentStore.cs
|
||||
LINE: 109
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
|
||||
MESSAGE: Method 'Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PeerManagementServiceTests.cs
|
||||
LINE: 8
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RemovePeerTrackingAsync_WhenRemoveRemoteConfigTrue_RemovesTrackingAndRemoteConfig()
|
||||
MESSAGE: Method 'RemovePeerTrackingAsync_WhenRemoveRemoteConfigTrue_RemovesTrackingAndRemoteConfig()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PeerManagementServiceTests.cs
|
||||
LINE: 22
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RemovePeerTrackingAsync_WhenRemoveRemoteConfigFalse_RemovesTrackingOnly()
|
||||
MESSAGE: Method 'RemovePeerTrackingAsync_WhenRemoveRemoteConfigFalse_RemovesTrackingOnly()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PeerManagementServiceTests.cs
|
||||
LINE: 35
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RemoveRemotePeerAsync_DelegatesToTrackingRemovalWithRemoteConfig()
|
||||
MESSAGE: Method 'RemoveRemotePeerAsync_DelegatesToTrackingRemovalWithRemoteConfig()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PeerManagementServiceTests.cs
|
||||
LINE: 49
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RemovePeerTrackingAsync_WhenNodeIdInvalid_ThrowsArgumentException()
|
||||
MESSAGE: Method 'RemovePeerTrackingAsync_WhenNodeIdInvalid_ThrowsArgumentException()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs
|
||||
LINE: 11
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: CheckHealthAsync_WhenPersistenceOkAndPeersWithinLagThreshold_ReturnsHealthyWithPayload()
|
||||
MESSAGE: Method 'CheckHealthAsync_WhenPersistenceOkAndPeersWithinLagThreshold_ReturnsHealthyWithPayload()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs
|
||||
LINE: 68
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: CheckHealthAsync_WhenPeersLaggingOrUnconfirmed_ReturnsDegradedWithPayload()
|
||||
MESSAGE: Method 'CheckHealthAsync_WhenPeersLaggingOrUnconfirmed_ReturnsDegradedWithPayload()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs
|
||||
LINE: 126
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: CheckHealthAsync_WhenCriticalLagBreached_ReturnsUnhealthyWithPayload()
|
||||
MESSAGE: Method 'CheckHealthAsync_WhenCriticalLagBreached_ReturnsUnhealthyWithPayload()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs
|
||||
LINE: 161
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: CheckHealthAsync_WhenPeerHasMultipleSourceConfirmations_UsesWorstCaseLag()
|
||||
MESSAGE: Method 'CheckHealthAsync_WhenPeerHasMultipleSourceConfirmations_UsesWorstCaseLag()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs
|
||||
LINE: 205
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: CheckHealthAsync_WhenStoreThrows_ReturnsUnhealthy()
|
||||
MESSAGE: Method 'CheckHealthAsync_WhenStoreThrows_ReturnsUnhealthy()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SnapshotReconnectRegressionTests.cs
|
||||
LINE: 32
|
||||
CATEGORY: MissingParam
|
||||
SEVERITY: Warning
|
||||
MEMBER: Constructor
|
||||
SIGNATURE: TestableSyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotMetadataStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IPeerOplogConfirmationStore peerOplogConfirmationStore)
|
||||
MESSAGE: Constructor 'TestableSyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotMetadataStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IPeerOplogConfirmationStore peerOplogConfirmationStore)' is missing <param name="peerOplogConfirmationStore"> documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorConfirmationTests.cs
|
||||
LINE: 15
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: EnsurePeersRegisteredAsync_ShouldRegisterMergedPeers_AndSkipLocalNode()
|
||||
MESSAGE: Method 'EnsurePeersRegisteredAsync_ShouldRegisterMergedPeers_AndSkipLocalNode()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorConfirmationTests.cs
|
||||
LINE: 59
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: EnsurePeersRegisteredAsync_WhenNewNodeJoins_ShouldAutoRegisterJoinedNode()
|
||||
MESSAGE: Method 'EnsurePeersRegisteredAsync_WhenNewNodeJoins_ShouldAutoRegisterJoinedNode()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorConfirmationTests.cs
|
||||
LINE: 94
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: AdvanceConfirmationsFromVectorClockAsync_ShouldAdvanceOnlyForRemoteAtOrAhead()
|
||||
MESSAGE: Method 'AdvanceConfirmationsFromVectorClockAsync_ShouldAdvanceOnlyForRemoteAtOrAhead()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorConfirmationTests.cs
|
||||
LINE: 156
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: AdvanceConfirmationForPushedBatchAsync_ShouldUseMaxTimestampAndHash()
|
||||
MESSAGE: Method 'AdvanceConfirmationForPushedBatchAsync_ShouldUseMaxTimestampAndHash()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorConfirmationTests.cs
|
||||
LINE: 180
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: AdvanceConfirmationForPushedBatchAsync_ShouldSkipEmptyBatch()
|
||||
MESSAGE: Method 'AdvanceConfirmationForPushedBatchAsync_ShouldSkipEmptyBatch()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorMaintenancePruningTests.cs
|
||||
LINE: 14
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: CalculateEffectiveCutoffAsync_MixedPeerStates_ShouldUseSafestConfirmationAcrossPeers()
|
||||
MESSAGE: Method 'CalculateEffectiveCutoffAsync_MixedPeerStates_ShouldUseSafestConfirmationAcrossPeers()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorMaintenancePruningTests.cs
|
||||
LINE: 62
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: CalculateEffectiveCutoffAsync_RemovingPeerFromTracking_ShouldImmediatelyRestoreEligibility()
|
||||
MESSAGE: Method 'CalculateEffectiveCutoffAsync_RemovingPeerFromTracking_ShouldImmediatelyRestoreEligibility()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorMaintenancePruningTests.cs
|
||||
LINE: 108
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RunMaintenanceIfDueAsync_TwoNode_ShouldNotPruneBeforePeerConfirmation()
|
||||
MESSAGE: Method 'RunMaintenanceIfDueAsync_TwoNode_ShouldNotPruneBeforePeerConfirmation()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorMaintenancePruningTests.cs
|
||||
LINE: 138
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RunMaintenanceIfDueAsync_TwoNode_ShouldPruneAfterPeerConfirmation()
|
||||
MESSAGE: Method 'RunMaintenanceIfDueAsync_TwoNode_ShouldPruneAfterPeerConfirmation()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SyncOrchestratorMaintenancePruningTests.cs
|
||||
LINE: 184
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RunMaintenanceIfDueAsync_DeprecatedNodeRemoval_ShouldUnblockPruning()
|
||||
MESSAGE: Method 'RunMaintenanceIfDueAsync_DeprecatedNodeRemoval_ShouldUnblockPruning()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/PeerOplogConfirmationStoreTests.cs
|
||||
LINE: 14
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Constructor
|
||||
SIGNATURE: PeerOplogConfirmationStoreTests()
|
||||
MESSAGE: Constructor 'PeerOplogConfirmationStoreTests()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/PeerOplogConfirmationStoreTests.cs
|
||||
LINE: 23
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: EnsurePeerRegisteredAsync_IsIdempotent()
|
||||
MESSAGE: Method 'EnsurePeerRegisteredAsync_IsIdempotent()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/PeerOplogConfirmationStoreTests.cs
|
||||
LINE: 37
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: ConfirmationStore_CrudFlow_Works()
|
||||
MESSAGE: Method 'ConfirmationStore_CrudFlow_Works()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/PeerOplogConfirmationStoreTests.cs
|
||||
LINE: 67
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: RemovePeerTrackingAsync_DeactivatesPeerTracking()
|
||||
MESSAGE: Method 'RemovePeerTrackingAsync_DeactivatesPeerTracking()' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/PeerOplogConfirmationStoreTests.cs
|
||||
LINE: 87
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: Dispose()
|
||||
MESSAGE: Method 'Dispose()' is missing XML documentation.
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
# Documentation Analysis Report
|
||||
|
||||
Files Scanned: 43
|
||||
Files With Issues: 0
|
||||
Total Issues: 0
|
||||
|
||||
Status: No documentation issues found
|
||||
1896
Core-docs-issues.md
1896
Core-docs-issues.md
File diff suppressed because it is too large
Load Diff
@@ -1,7 +0,0 @@
|
||||
# Documentation Analysis Report
|
||||
|
||||
Files Scanned: 29
|
||||
Files With Issues: 0
|
||||
Total Issues: 0
|
||||
|
||||
Status: No documentation issues found
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,7 +0,0 @@
|
||||
# Documentation Analysis Report
|
||||
|
||||
Files Scanned: 8
|
||||
Files With Issues: 0
|
||||
Total Issues: 0
|
||||
|
||||
Status: No documentation issues found
|
||||
@@ -1,546 +0,0 @@
|
||||
# Documentation Analysis Report
|
||||
|
||||
Files Scanned: 8
|
||||
Files With Issues: 5
|
||||
Total Issues: 54
|
||||
|
||||
## Issues
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/NodeCacheEntry.cs
|
||||
LINE: 7
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Timestamp
|
||||
MESSAGE: Property 'Timestamp' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/NodeCacheEntry.cs
|
||||
LINE: 8
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Hash
|
||||
MESSAGE: Property 'Hash' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs
|
||||
LINE: 22
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Event
|
||||
SIGNATURE: ChangesApplied
|
||||
MESSAGE: Event 'ChangesApplied' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs
|
||||
LINE: 24
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: OnChangesApplied(IEnumerable<OplogEntry> appliedEntries)
|
||||
MESSAGE: Method 'OnChangesApplied(IEnumerable<OplogEntry> appliedEntries)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs
|
||||
LINE: 29
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Constructor
|
||||
SIGNATURE: OplogStore(IDocumentStore documentStore, IConflictResolver conflictResolver, IVectorClockService vectorClockService, ISnapshotMetadataStore? snapshotMetadataStore)
|
||||
MESSAGE: Constructor 'OplogStore(IDocumentStore documentStore, IConflictResolver conflictResolver, IVectorClockService vectorClockService, ISnapshotMetadataStore? snapshotMetadataStore)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs
|
||||
LINE: 209
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: DropAsync(CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'DropAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs
|
||||
LINE: 211
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: ExportAsync(CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'ExportAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs
|
||||
LINE: 213
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: ImportAsync(IEnumerable<OplogEntry> items, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'ImportAsync(IEnumerable<OplogEntry> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs
|
||||
LINE: 215
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: MergeAsync(IEnumerable<OplogEntry> items, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'MergeAsync(IEnumerable<OplogEntry> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/PeerConfigurationStore.cs
|
||||
LINE: 23
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: DropAsync(CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'DropAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/PeerConfigurationStore.cs
|
||||
LINE: 25
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: ExportAsync(CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'ExportAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/PeerConfigurationStore.cs
|
||||
LINE: 27
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: ImportAsync(IEnumerable<RemotePeerConfiguration> items, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'ImportAsync(IEnumerable<RemotePeerConfiguration> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/PeerConfigurationStore.cs
|
||||
LINE: 35
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: MergeAsync(IEnumerable<RemotePeerConfiguration> items, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'MergeAsync(IEnumerable<RemotePeerConfiguration> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 10
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Version
|
||||
MESSAGE: Property 'Version' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 11
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: CreatedAt
|
||||
MESSAGE: Property 'CreatedAt' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 12
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: NodeId
|
||||
MESSAGE: Property 'NodeId' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 13
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Documents
|
||||
MESSAGE: Property 'Documents' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 14
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Oplog
|
||||
MESSAGE: Property 'Oplog' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 15
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: SnapshotMetadata
|
||||
MESSAGE: Property 'SnapshotMetadata' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 16
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: RemotePeers
|
||||
MESSAGE: Property 'RemotePeers' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 21
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Collection
|
||||
MESSAGE: Property 'Collection' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 22
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Key
|
||||
MESSAGE: Property 'Key' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 23
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: JsonData
|
||||
MESSAGE: Property 'JsonData' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 24
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: IsDeleted
|
||||
MESSAGE: Property 'IsDeleted' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 25
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: HlcWall
|
||||
MESSAGE: Property 'HlcWall' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 26
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: HlcLogic
|
||||
MESSAGE: Property 'HlcLogic' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 27
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: HlcNode
|
||||
MESSAGE: Property 'HlcNode' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 32
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Collection
|
||||
MESSAGE: Property 'Collection' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 33
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Key
|
||||
MESSAGE: Property 'Key' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 34
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Operation
|
||||
MESSAGE: Property 'Operation' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 35
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: JsonData
|
||||
MESSAGE: Property 'JsonData' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 36
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: HlcWall
|
||||
MESSAGE: Property 'HlcWall' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 37
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: HlcLogic
|
||||
MESSAGE: Property 'HlcLogic' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 38
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: HlcNode
|
||||
MESSAGE: Property 'HlcNode' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 39
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Hash
|
||||
MESSAGE: Property 'Hash' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 40
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: PreviousHash
|
||||
MESSAGE: Property 'PreviousHash' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 45
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: NodeId
|
||||
MESSAGE: Property 'NodeId' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 46
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: HlcWall
|
||||
MESSAGE: Property 'HlcWall' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 47
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: HlcLogic
|
||||
MESSAGE: Property 'HlcLogic' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 48
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Hash
|
||||
MESSAGE: Property 'Hash' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 53
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: NodeId
|
||||
MESSAGE: Property 'NodeId' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 54
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Address
|
||||
MESSAGE: Property 'Address' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 55
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: Type
|
||||
MESSAGE: Property 'Type' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 56
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: OAuth2Json
|
||||
MESSAGE: Property 'OAuth2Json' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs
|
||||
LINE: 57
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Property
|
||||
SIGNATURE: IsEnabled
|
||||
MESSAGE: Property 'IsEnabled' is missing XML documentation
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 11
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: DropAsync(CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'DropAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 13
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: ExportAsync(CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'ExportAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 15
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: GetSnapshotMetadataAsync(string nodeId, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'GetSnapshotMetadataAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 17
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: GetSnapshotHashAsync(string nodeId, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'GetSnapshotHashAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 19
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: ImportAsync(IEnumerable<SnapshotMetadata> items, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'ImportAsync(IEnumerable<SnapshotMetadata> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 21
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: InsertSnapshotMetadataAsync(SnapshotMetadata metadata, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'InsertSnapshotMetadataAsync(SnapshotMetadata metadata, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 23
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: MergeAsync(IEnumerable<SnapshotMetadata> items, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'MergeAsync(IEnumerable<SnapshotMetadata> items, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 25
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: UpdateSnapshotMetadataAsync(SnapshotMetadata existingMeta, CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'UpdateSnapshotMetadataAsync(SnapshotMetadata existingMeta, CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
---
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs
|
||||
LINE: 27
|
||||
CATEGORY: MissingDoc
|
||||
SEVERITY: Error
|
||||
MEMBER: Method
|
||||
SIGNATURE: GetAllSnapshotMetadataAsync(CancellationToken cancellationToken)
|
||||
MESSAGE: Method 'GetAllSnapshotMetadataAsync(CancellationToken cancellationToken)' is missing XML documentation.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,8 +0,0 @@
|
||||
Total files: 59
|
||||
Total issues: 360
|
||||
Batch 1: files=7, errors=46, warnings=16, total=62
|
||||
Batch 2: files=6, errors=47, warnings=12, total=59
|
||||
Batch 3: files=11, errors=47, warnings=12, total=59
|
||||
Batch 4: files=11, errors=43, warnings=29, total=72
|
||||
Batch 5: files=12, errors=50, warnings=1, total=51
|
||||
Batch 6: files=12, errors=49, warnings=8, total=57
|
||||
@@ -1,111 +0,0 @@
|
||||
{
|
||||
"batches": [
|
||||
{
|
||||
"batch": 1,
|
||||
"files": [
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/ChangesAppliedEventArgs.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentStore.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/ILeaderElectionService.cs"
|
||||
],
|
||||
"errors": 46,
|
||||
"warnings": 16,
|
||||
"total": 62
|
||||
},
|
||||
{
|
||||
"batch": 2,
|
||||
"files": [
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/PeerConfigurationStore.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/IDiscoveryService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentMetadataStore.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs"
|
||||
],
|
||||
"errors": 47,
|
||||
"warnings": 12,
|
||||
"total": 59
|
||||
},
|
||||
{
|
||||
"batch": 3,
|
||||
"files": [
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Document.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/StaticPeerNodeConfigurationProvider.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompositeDiscoveryService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/IPeerNodeConfigurationProvider.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncOrchestrator.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/OfflineQueue.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/RecursiveNodeMergeConflictResolver.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/PeerDbNetworkExtensions.cs"
|
||||
],
|
||||
"errors": 47,
|
||||
"warnings": 12,
|
||||
"total": 59
|
||||
},
|
||||
{
|
||||
"batch": 4,
|
||||
"files": [
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/PendingOperation.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/SnapshotMetadata.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/NodeCacheEntry.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ICBDDCHealthCheck.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IAuthenticator.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpSyncServer.cs"
|
||||
],
|
||||
"errors": 43,
|
||||
"warnings": 29,
|
||||
"total": 72
|
||||
},
|
||||
{
|
||||
"batch": 5,
|
||||
"files": [
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/IDocumentCache.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/BullyLeaderElectionService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IOfflineQueue.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNodeService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncServer.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/SecureHandshakeService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/CBDDCServiceCollectionExtensions.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/CorruptDatabaseException.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/JwtOAuth2Validator.cs"
|
||||
],
|
||||
"errors": 50,
|
||||
"warnings": 1,
|
||||
"total": 51
|
||||
},
|
||||
{
|
||||
"batch": 6,
|
||||
"files": [
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/OplogEntry.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ICBDDCNode.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/OAuth2ClientCredentialsTokenProvider.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNode.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompressionHelper.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/IRetryPolicy.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/CryptoHelper.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/CBDDCHealthCheck.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/LastWriteWinsConflictResolver.cs",
|
||||
"/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs"
|
||||
],
|
||||
"errors": 49,
|
||||
"warnings": 8,
|
||||
"total": 57
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,59 +0,0 @@
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs 33 0 33
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/Snapshot/SnapshotDto.cs 32 0 32
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs 16 0 16
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs 11 0 11
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs 10 1 11
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/OplogEntry.cs 9 0 9
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/SnapshotMetadataStore.cs 9 0 9
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs 8 0 8
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs 7 23 30
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Document.cs 7 0 7
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs 7 0 7
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/OplogStore.cs 7 0 7
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs 6 0 6
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs 6 0 6
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ICBDDCNode.cs 6 0 6
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/IDocumentCache.cs 5 0 5
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/StaticPeerNodeConfigurationProvider.cs 5 0 5
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/PendingOperation.cs 5 0 5
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/BullyLeaderElectionService.cs 5 0 5
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/OAuth2ClientCredentialsTokenProvider.cs 5 0 5
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs 5 0 5
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs 5 0 5
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs 4 7 11
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/SnapshotMetadata.cs 4 0 4
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IOfflineQueue.cs 4 0 4
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNode.cs 4 0 4
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/PeerConfigurationStore.cs 4 0 4
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs 3 7 10
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs 3 4 7
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNodeService.cs 3 0 3
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompositeDiscoveryService.cs 3 0 3
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompressionHelper.cs 3 0 3
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/IDiscoveryService.cs 3 0 3
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncServer.cs 3 0 3
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs 3 0 3
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/ChangesAppliedEventArgs.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/IPeerNodeConfigurationProvider.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/IRetryPolicy.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentMetadataStore.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentStore.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncOrchestrator.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/CryptoHelper.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/SecureHandshakeService.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence/NodeCacheEntry.cs 2 0 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs 1 12 13
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs 1 7 8
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/OfflineQueue.cs 1 3 4
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/CBDDCHealthCheck.cs 1 1 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/CBDDCServiceCollectionExtensions.cs 1 0 1
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ICBDDCHealthCheck.cs 1 0 1
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/CorruptDatabaseException.cs 1 0 1
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/LastWriteWinsConflictResolver.cs 1 0 1
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/RecursiveNodeMergeConflictResolver.cs 1 0 1
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IAuthenticator.cs 1 0 1
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/JwtOAuth2Validator.cs 1 0 1
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs 0 7 7
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/ILeaderElectionService.cs 0 2 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/PeerDbNetworkExtensions.cs 0 2 2
|
||||
/Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpSyncServer.cs 0 2 2
|
||||
|
@@ -1,168 +0,0 @@
|
||||
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 1 OF 6 ===
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs
|
||||
Issues:
|
||||
- Line 9, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 10, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 11, MissingDoc, Error, Constructor, Eq(string field, object value)
|
||||
-> Constructor 'Eq(string field, object value)' is missing XML documentation.
|
||||
- Line 16, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 17, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 18, MissingDoc, Error, Constructor, Gt(string field, object value)
|
||||
-> Constructor 'Gt(string field, object value)' is missing XML documentation.
|
||||
- Line 23, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 24, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 25, MissingDoc, Error, Constructor, Lt(string field, object value)
|
||||
-> Constructor 'Lt(string field, object value)' is missing XML documentation.
|
||||
- Line 30, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 31, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 32, MissingDoc, Error, Constructor, Gte(string field, object value)
|
||||
-> Constructor 'Gte(string field, object value)' is missing XML documentation.
|
||||
- Line 37, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 38, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 39, MissingDoc, Error, Constructor, Lte(string field, object value)
|
||||
-> Constructor 'Lte(string field, object value)' is missing XML documentation.
|
||||
- Line 44, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 45, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 46, MissingDoc, Error, Constructor, Neq(string field, object value)
|
||||
-> Constructor 'Neq(string field, object value)' is missing XML documentation.
|
||||
- Line 51, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 52, MissingDoc, Error, Property, Values
|
||||
-> Property 'Values' is missing XML documentation
|
||||
- Line 53, MissingDoc, Error, Constructor, In(string field, object[] values)
|
||||
-> Constructor 'In(string field, object[] values)' is missing XML documentation.
|
||||
- Line 58, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 59, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 60, MissingDoc, Error, Constructor, Contains(string field, string value)
|
||||
-> Constructor 'Contains(string field, string value)' is missing XML documentation.
|
||||
- Line 65, MissingDoc, Error, Property, Field
|
||||
-> Property 'Field' is missing XML documentation
|
||||
- Line 66, MissingDoc, Error, Property, Value
|
||||
-> Property 'Value' is missing XML documentation
|
||||
- Line 67, MissingDoc, Error, Constructor, NotContains(string field, string value)
|
||||
-> Constructor 'NotContains(string field, string value)' is missing XML documentation.
|
||||
- Line 72, MissingDoc, Error, Property, Left
|
||||
-> Property 'Left' is missing XML documentation
|
||||
- Line 73, MissingDoc, Error, Property, Right
|
||||
-> Property 'Right' is missing XML documentation
|
||||
- Line 74, MissingDoc, Error, Constructor, And(QueryNode left, QueryNode right)
|
||||
-> Constructor 'And(QueryNode left, QueryNode right)' is missing XML documentation.
|
||||
- Line 79, MissingDoc, Error, Property, Left
|
||||
-> Property 'Left' is missing XML documentation
|
||||
- Line 80, MissingDoc, Error, Property, Right
|
||||
-> Property 'Right' is missing XML documentation
|
||||
- Line 81, MissingDoc, Error, Constructor, Or(QueryNode left, QueryNode right)
|
||||
-> Constructor 'Or(QueryNode left, QueryNode right)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs
|
||||
Issues:
|
||||
- Line 8, MissingDoc, Error, Method, RecordValue(MetricType type, double value)
|
||||
-> Method 'RecordValue(MetricType type, double value)' is missing XML documentation.
|
||||
- Line 9, MissingDoc, Error, Method, StartMetric(MetricType type)
|
||||
-> Method 'StartMetric(MetricType type)' is missing XML documentation.
|
||||
- Line 10, MissingDoc, Error, Method, GetSnapshot()
|
||||
-> Method 'GetSnapshot()' is missing XML documentation.
|
||||
- Line 19, MissingDoc, Error, Constructor, MetricTimer(INetworkTelemetryService service, MetricType type)
|
||||
-> Constructor 'MetricTimer(INetworkTelemetryService service, MetricType type)' is missing XML documentation.
|
||||
- Line 26, MissingDoc, Error, Method, Dispose()
|
||||
-> Method 'Dispose()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs
|
||||
Issues:
|
||||
- Line 15, MissingDoc, Error, Constructor, VectorClock()
|
||||
-> Constructor 'VectorClock()' is missing XML documentation.
|
||||
- Line 20, MissingDoc, Error, Constructor, VectorClock(Dictionary<string, HlcTimestamp> clock)
|
||||
-> Constructor 'VectorClock(Dictionary<string, HlcTimestamp> clock)' is missing XML documentation.
|
||||
- Line 33, MissingParam, Warning, Method, GetTimestamp(string nodeId)
|
||||
-> Method 'GetTimestamp(string nodeId)' is missing <param name="nodeId"> documentation.
|
||||
- Line 41, MissingParam, Warning, Method, SetTimestamp(string nodeId, HlcTimestamp timestamp)
|
||||
-> Method 'SetTimestamp(string nodeId, HlcTimestamp timestamp)' is missing <param name="timestamp"> documentation.
|
||||
- Line 41, MissingParam, Warning, Method, SetTimestamp(string nodeId, HlcTimestamp timestamp)
|
||||
-> Method 'SetTimestamp(string nodeId, HlcTimestamp timestamp)' is missing <param name="nodeId"> documentation.
|
||||
- Line 49, MissingParam, Warning, Method, Merge(VectorClock other)
|
||||
-> Method 'Merge(VectorClock other)' is missing <param name="other"> documentation.
|
||||
- Line 68, MissingParam, Warning, Method, CompareTo(VectorClock other)
|
||||
-> Method 'CompareTo(VectorClock other)' is missing <param name="other"> documentation.
|
||||
- Line 110, MissingParam, Warning, Method, GetNodesWithUpdates(VectorClock other)
|
||||
-> Method 'GetNodesWithUpdates(VectorClock other)' is missing <param name="other"> documentation.
|
||||
- Line 134, MissingParam, Warning, Method, GetNodesToPush(VectorClock other)
|
||||
-> Method 'GetNodesToPush(VectorClock other)' is missing <param name="other"> documentation.
|
||||
- Line 158, MissingDoc, Error, Method, ToString()
|
||||
-> Method 'ToString()' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/ChangesAppliedEventArgs.cs
|
||||
Issues:
|
||||
- Line 11, MissingDoc, Error, Property, Changes
|
||||
-> Property 'Changes' is missing XML documentation
|
||||
- Line 12, MissingDoc, Error, Constructor, ChangesAppliedEventArgs(IEnumerable<OplogEntry> changes)
|
||||
-> Constructor 'ChangesAppliedEventArgs(IEnumerable<OplogEntry> changes)' is missing XML documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentStore.cs
|
||||
Issues:
|
||||
- Line 13, MissingDoc, Error, Property, InterestedCollection
|
||||
-> Property 'InterestedCollection' is missing XML documentation
|
||||
- Line 81, MalformedXml, Error, Method, DeleteBatchDocumentsAsync(IEnumerable<string> documentKeys, CancellationToken cancellationToken)
|
||||
-> Method 'DeleteBatchDocumentsAsync(IEnumerable<string> documentKeys, CancellationToken cancellationToken)' has malformed XML documentation that cannot be parsed.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs
|
||||
Issues:
|
||||
- Line 18, MissingDoc, Error, Constructor, RetryPolicy(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<RetryPolicy> logger)
|
||||
-> Constructor 'RetryPolicy(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger<RetryPolicy> logger)' is missing XML documentation.
|
||||
- Line 28, MissingTypeParam, Warning, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing <typeparam name="T"> documentation.
|
||||
- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="cancellationToken"> documentation.
|
||||
- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="operationName"> documentation.
|
||||
- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task<T>> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="operation"> documentation.
|
||||
- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="cancellationToken"> documentation.
|
||||
- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="operationName"> documentation.
|
||||
- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)
|
||||
-> Method 'ExecuteAsync(Func<Task> operation, string operationName, CancellationToken cancellationToken)' is missing <param name="operation"> documentation.
|
||||
|
||||
FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/ILeaderElectionService.cs
|
||||
Issues:
|
||||
- Line 25, MissingParam, Warning, Constructor, LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)
|
||||
-> Constructor 'LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)' is missing <param name="isLocalNodeGateway"> documentation.
|
||||
- Line 25, MissingParam, Warning, Constructor, LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)
|
||||
-> Constructor 'LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)' is missing <param name="currentGatewayNodeId"> 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.
|
||||
@@ -1,159 +0,0 @@
|
||||
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.
|
||||
@@ -1,174 +0,0 @@
|
||||
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.
|
||||
@@ -1,200 +0,0 @@
|
||||
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.
|
||||
@@ -1,161 +0,0 @@
|
||||
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.
|
||||
@@ -1,173 +0,0 @@
|
||||
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.
|
||||
@@ -1,7 +0,0 @@
|
||||
# Documentation Analysis Report
|
||||
|
||||
Files Scanned: 138
|
||||
Files With Issues: 0
|
||||
Total Issues: 0
|
||||
|
||||
Status: No documentation issues found
|
||||
115
fixplan.md
115
fixplan.md
@@ -1,115 +0,0 @@
|
||||
# CBDDC Fix Plan
|
||||
|
||||
## Goal
|
||||
Address all remaining issues identified in the architecture/quality audit after EntityFramework removal and persistence merge.
|
||||
|
||||
## Current State
|
||||
- All GitHub workflows/pipelines have been removed from this repository.
|
||||
- Build and tests pass locally on `CBDDC.slnx`.
|
||||
- Remaining issues are architecture, warning debt, style drift, dependency deprecations, security hardening, and missing automated fitness gates.
|
||||
|
||||
## Issue Inventory
|
||||
1. **Core framework coupling (CA-02)**
|
||||
- `Core` references `Microsoft.Extensions.*` and contains DI composition extension classes.
|
||||
2. **Static analysis and warning debt (BP-05)**
|
||||
- Nullable warnings in persistence (`CS8618`, `CS8604`).
|
||||
- `NU1510` warning in network (`System.Threading.Channels`).
|
||||
3. **Formatting drift (BP-06)**
|
||||
- `dotnet format --verify-no-changes` fails with widespread whitespace issues (mostly test files).
|
||||
4. **Dependency deprecations (BP-07)**
|
||||
- Deprecated `Microsoft.AspNetCore.Http.Abstractions` `2.2.0`.
|
||||
- Legacy `xunit` `2.9.3` in test projects.
|
||||
5. **Security baseline gaps (BP-08)**
|
||||
- Insecure default auth token in default node config.
|
||||
- `JwtOAuth2Validator` is explicitly demo/basic and does not perform signature/JWKS verification.
|
||||
6. **No architecture fitness enforcement (BP-09)**
|
||||
- No architecture rule tests.
|
||||
- No active pipeline to enforce build/test/format/package/security checks.
|
||||
|
||||
## Execution Plan
|
||||
|
||||
### Phase 1: Stabilize and Clean Baseline
|
||||
1. Fix nullable/event warnings in persistence:
|
||||
- Make `ChangesApplied` nullable or initialize safely.
|
||||
- Guard null snapshot values before constructing `OplogEntry`.
|
||||
2. Resolve `NU1510`:
|
||||
- Remove `System.Threading.Channels` if unused; otherwise document explicit need.
|
||||
3. Apply formatting once repo-wide:
|
||||
- Run `dotnet format CBDDC.slnx`.
|
||||
- Commit mechanical formatting separately.
|
||||
|
||||
**Exit criteria**
|
||||
- `dotnet build CBDDC.slnx` has zero warnings (or only documented, explicitly accepted warnings).
|
||||
- `dotnet format CBDDC.slnx --verify-no-changes` passes.
|
||||
|
||||
### Phase 2: Dependency and Package Modernization
|
||||
1. Replace deprecated AspNet package:
|
||||
- Remove `Microsoft.AspNetCore.Http.Abstractions 2.2.0`.
|
||||
- Use current ASP.NET shared framework-compatible references.
|
||||
2. Upgrade tests from xUnit 2 to xUnit 3 (or pin with explicit temporary rationale).
|
||||
3. Re-run package audits:
|
||||
- `dotnet package list --project CBDDC.slnx --deprecated`
|
||||
- `dotnet package list --project CBDDC.slnx --include-transitive --vulnerable --format json`
|
||||
|
||||
**Exit criteria**
|
||||
- No unapproved deprecated packages.
|
||||
- No known vulnerabilities.
|
||||
|
||||
### Phase 3: Security Hardening
|
||||
1. Remove insecure token default behavior:
|
||||
- Require explicit token provisioning for production paths.
|
||||
- Keep development fallback only behind clear dev-only opt-in.
|
||||
2. Replace `JwtOAuth2Validator` with production-grade validator:
|
||||
- Signature validation (JWKS retrieval/rotation).
|
||||
- Issuer/audience/lifetime validation.
|
||||
- Clock skew handling and structured failure reasons.
|
||||
3. Add unit and integration tests for auth failure/success paths.
|
||||
|
||||
**Exit criteria**
|
||||
- Auth path rejects unsigned/invalid JWTs.
|
||||
- No default cluster token in production defaults.
|
||||
|
||||
### Phase 4: Architecture Boundary Cleanup
|
||||
1. Move DI composition out of `Core` into outer adapters/host packages.
|
||||
2. Keep `Core` limited to domain/application contracts and logic.
|
||||
3. Validate no framework namespace leakage into `Core`.
|
||||
|
||||
**Exit criteria**
|
||||
- `Core` no longer references DI/logging framework packages except where explicitly approved.
|
||||
- Architecture tests enforce the boundary.
|
||||
|
||||
### Phase 5: Fitness Functions and Automation Reintroduction
|
||||
1. Add architecture tests:
|
||||
- Rule: `Core` must not depend on `Network`, `Persistence`, `AspNet`, or host frameworks.
|
||||
- Rule: layer graph must remain acyclic.
|
||||
2. Reintroduce a **new** minimal CI workflow (after review/approval):
|
||||
- `dotnet restore`, `dotnet build`, `dotnet test`
|
||||
- `dotnet format --verify-no-changes`
|
||||
- package vulnerable/deprecated checks
|
||||
3. Add fail-fast quality gates on pull requests.
|
||||
|
||||
**Exit criteria**
|
||||
- Every architecture/quality rule is automatically enforced on PRs.
|
||||
|
||||
## Verification Commands
|
||||
Run from `/Users/dohertj2/Desktop/CBDDC`:
|
||||
|
||||
```bash
|
||||
dotnet restore CBDDC.slnx
|
||||
dotnet build CBDDC.slnx
|
||||
dotnet test CBDDC.slnx
|
||||
dotnet format CBDDC.slnx --verify-no-changes
|
||||
dotnet package list --project CBDDC.slnx --include-transitive --vulnerable --format json
|
||||
dotnet package list --project CBDDC.slnx --deprecated
|
||||
```
|
||||
|
||||
## Suggested Order of Delivery
|
||||
1. Phase 1 (stability/style baseline)
|
||||
2. Phase 2 (dependencies)
|
||||
3. Phase 3 (security)
|
||||
4. Phase 4 (architecture cleanup)
|
||||
5. Phase 5 (fitness automation)
|
||||
|
||||
## Notes for Review
|
||||
- I split mechanical formatting from behavioral/security changes to keep diffs reviewable.
|
||||
- Reintroducing CI is intentionally deferred to Phase 5 so it enforces the cleaned baseline, not current debt.
|
||||
@@ -240,6 +240,9 @@ public class ClusterCrudSyncE2ETests
|
||||
private long _lastPhysicalTime = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();
|
||||
private int _logicalCounter;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the LiteDB-backed context used by this test peer.
|
||||
/// </summary>
|
||||
public SampleDbContext Context { get; }
|
||||
|
||||
private TestPeerNode(
|
||||
@@ -260,6 +263,14 @@ public class ClusterCrudSyncE2ETests
|
||||
_nodeId = nodeId;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a test peer node and wires all required services.
|
||||
/// </summary>
|
||||
/// <param name="nodeId">The unique node identifier.</param>
|
||||
/// <param name="tcpPort">The TCP port used by the node listener.</param>
|
||||
/// <param name="authToken">The cluster authentication token.</param>
|
||||
/// <param name="knownPeers">The known peers this node can connect to.</param>
|
||||
/// <returns>A configured <see cref="TestPeerNode"/> instance.</returns>
|
||||
public static TestPeerNode Create(
|
||||
string nodeId,
|
||||
int tcpPort,
|
||||
@@ -300,6 +311,10 @@ public class ClusterCrudSyncE2ETests
|
||||
return new TestPeerNode(provider, node, oplogStore, context, logSink, workDir, nodeId);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts the underlying node when it has not been started yet.
|
||||
/// </summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task StartAsync()
|
||||
{
|
||||
if (_started)
|
||||
@@ -311,6 +326,10 @@ public class ClusterCrudSyncE2ETests
|
||||
_started = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Stops the underlying node when it is currently running.
|
||||
/// </summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task StopAsync()
|
||||
{
|
||||
if (!_started)
|
||||
@@ -322,6 +341,7 @@ public class ClusterCrudSyncE2ETests
|
||||
_started = false;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async ValueTask DisposeAsync()
|
||||
{
|
||||
try
|
||||
@@ -336,11 +356,21 @@ public class ClusterCrudSyncE2ETests
|
||||
TryDeleteDirectory(_workDir);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads a user document by identifier.
|
||||
/// </summary>
|
||||
/// <param name="userId">The identifier of the user to read.</param>
|
||||
/// <returns>The matching user when found; otherwise <see langword="null"/>.</returns>
|
||||
public User? ReadUser(string userId)
|
||||
{
|
||||
return Context.Users.Find(u => u.Id == userId).FirstOrDefault();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Inserts or updates a user and persists the matching oplog entry.
|
||||
/// </summary>
|
||||
/// <param name="user">The user payload to upsert.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task UpsertUserAsync(User user)
|
||||
{
|
||||
await PersistUserMutationWithOplogFallbackAsync(
|
||||
@@ -363,6 +393,11 @@ public class ClusterCrudSyncE2ETests
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Deletes a user and persists the matching oplog entry.
|
||||
/// </summary>
|
||||
/// <param name="userId">The identifier of the user to delete.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task DeleteUserAsync(string userId)
|
||||
{
|
||||
await PersistUserMutationWithOplogFallbackAsync(
|
||||
@@ -376,6 +411,11 @@ public class ClusterCrudSyncE2ETests
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets recent in-memory logs captured for this node.
|
||||
/// </summary>
|
||||
/// <param name="max">The maximum number of log entries to return.</param>
|
||||
/// <returns>A newline-delimited string of recent log entries.</returns>
|
||||
public string GetRecentLogs(int max = 50)
|
||||
{
|
||||
return _logSink.GetRecent(max);
|
||||
@@ -450,16 +490,19 @@ public class ClusterCrudSyncE2ETests
|
||||
|
||||
private sealed class PassiveDiscoveryService : IDiscoveryService
|
||||
{
|
||||
/// <inheritdoc />
|
||||
public IEnumerable<PeerNode> GetActivePeers()
|
||||
{
|
||||
return Array.Empty<PeerNode>();
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task Start()
|
||||
{
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task Stop()
|
||||
{
|
||||
return Task.CompletedTask;
|
||||
@@ -470,18 +513,25 @@ public class ClusterCrudSyncE2ETests
|
||||
{
|
||||
private PeerNodeConfiguration _configuration;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="StaticPeerNodeConfigurationProvider"/> class.
|
||||
/// </summary>
|
||||
/// <param name="configuration">The initial peer node configuration.</param>
|
||||
public StaticPeerNodeConfigurationProvider(PeerNodeConfiguration configuration)
|
||||
{
|
||||
_configuration = configuration;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public event PeerNodeConfigurationChangedEventHandler? ConfigurationChanged;
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<PeerNodeConfiguration> GetConfiguration()
|
||||
{
|
||||
return Task.FromResult(_configuration);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public void Update(PeerNodeConfiguration configuration)
|
||||
{
|
||||
_configuration = configuration;
|
||||
@@ -494,11 +544,22 @@ public class ClusterCrudSyncE2ETests
|
||||
private readonly ConcurrentQueue<string> _entries = new();
|
||||
private readonly string _nodeId;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="InMemoryLogSink"/> class.
|
||||
/// </summary>
|
||||
/// <param name="nodeId">The node identifier associated with emitted logs.</param>
|
||||
public InMemoryLogSink(string nodeId)
|
||||
{
|
||||
_nodeId = nodeId;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds a log entry to the in-memory sink.
|
||||
/// </summary>
|
||||
/// <param name="category">The log category.</param>
|
||||
/// <param name="level">The log level.</param>
|
||||
/// <param name="message">The formatted log message.</param>
|
||||
/// <param name="exception">The optional exception associated with the log entry.</param>
|
||||
public void Add(string category, LogLevel level, string message, Exception? exception)
|
||||
{
|
||||
var text = $"[{DateTime.UtcNow:O}] {_nodeId} {level} {category}: {message}";
|
||||
@@ -513,6 +574,11 @@ public class ClusterCrudSyncE2ETests
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the most recent log entries from the sink.
|
||||
/// </summary>
|
||||
/// <param name="max">The maximum number of entries to return.</param>
|
||||
/// <returns>A newline-delimited string of recent log entries, or a placeholder when none exist.</returns>
|
||||
public string GetRecent(int max)
|
||||
{
|
||||
var entries = _entries.ToArray();
|
||||
@@ -529,16 +595,22 @@ public class ClusterCrudSyncE2ETests
|
||||
{
|
||||
private readonly InMemoryLogSink _sink;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="InMemoryLoggerProvider"/> class.
|
||||
/// </summary>
|
||||
/// <param name="sink">The shared sink used to capture log messages.</param>
|
||||
public InMemoryLoggerProvider(InMemoryLogSink sink)
|
||||
{
|
||||
_sink = sink;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public ILogger CreateLogger(string categoryName)
|
||||
{
|
||||
return new InMemoryLogger(categoryName, _sink);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public void Dispose()
|
||||
{
|
||||
}
|
||||
@@ -549,22 +621,30 @@ public class ClusterCrudSyncE2ETests
|
||||
private readonly string _categoryName;
|
||||
private readonly InMemoryLogSink _sink;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="InMemoryLogger"/> class.
|
||||
/// </summary>
|
||||
/// <param name="categoryName">The logger category name.</param>
|
||||
/// <param name="sink">The sink that stores emitted log messages.</param>
|
||||
public InMemoryLogger(string categoryName, InMemoryLogSink sink)
|
||||
{
|
||||
_categoryName = categoryName;
|
||||
_sink = sink;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public IDisposable BeginScope<TState>(TState state) where TState : notnull
|
||||
{
|
||||
return NullScope.Instance;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public bool IsEnabled(LogLevel logLevel)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public void Log<TState>(
|
||||
LogLevel logLevel,
|
||||
EventId eventId,
|
||||
@@ -580,6 +660,7 @@ public class ClusterCrudSyncE2ETests
|
||||
{
|
||||
public static readonly NullScope Instance = new();
|
||||
|
||||
/// <inheritdoc />
|
||||
public void Dispose()
|
||||
{
|
||||
}
|
||||
|
||||
166
twonode.md
166
twonode.md
@@ -1,166 +0,0 @@
|
||||
# Plan: Peer-Confirmed Oplog Retention and Peer Sync Health
|
||||
|
||||
## Objective
|
||||
Move from time-only oplog pruning to peer-confirmed pruning so entries are not removed until peers have confirmed them, while also adding peer lifecycle management and health visibility.
|
||||
|
||||
## Requested Outcomes
|
||||
- Oplogs are not cleared until confirmed by peers.
|
||||
- Each node tracks latest oplog confirmation per peer.
|
||||
- New peers are automatically registered when they join.
|
||||
- Deprecated peers can be explicitly removed from tracking.
|
||||
- Hosting health checks report peer sync status, not only store availability.
|
||||
|
||||
## Current Baseline (Codebase)
|
||||
- Pruning is retention-time based in `SyncOrchestrator` + `IOplogStore.PruneOplogAsync(...)`.
|
||||
- Push ACK is binary success/fail (`AckResponse`) and does not persist peer confirmation state.
|
||||
- Peer discovery exists (`IDiscoveryService`, `UdpDiscoveryService`, `CompositeDiscoveryService`).
|
||||
- Persistent remote peer config exists (`IPeerConfigurationStore`, `PeerManagementService`).
|
||||
- Hosting health check only validates oplog access (`CBDDCHealthCheck` in Hosting project).
|
||||
|
||||
## Design Decisions
|
||||
- Track confirmation as a persisted watermark per `(peerNodeId, sourceNodeId)` using HLC and hash.
|
||||
- Use existing vector-clock exchange and successful push results to advance confirmations (no mandatory wire protocol break required).
|
||||
- Treat tracked peers as pruning blockers until explicitly removed.
|
||||
- Keep peer registration idempotent and safe for repeated discovery events.
|
||||
|
||||
## Data Model and Persistence Plan
|
||||
### 1. Add peer confirmation tracking model
|
||||
Create a new persisted model (example name: `PeerOplogConfirmation`) with fields:
|
||||
- `PeerNodeId`
|
||||
- `SourceNodeId`
|
||||
- `ConfirmedWall`
|
||||
- `ConfirmedLogic`
|
||||
- `ConfirmedHash`
|
||||
- `LastConfirmedUtc`
|
||||
- `IsActive`
|
||||
|
||||
### 2. Add store abstraction
|
||||
Add `IPeerOplogConfirmationStore` with operations:
|
||||
- `EnsurePeerRegisteredAsync(peerNodeId, address, type)`
|
||||
- `UpdateConfirmationAsync(peerNodeId, sourceNodeId, timestamp, hash)`
|
||||
- `GetConfirmationsAsync()` and `GetConfirmationsForPeerAsync(peerNodeId)`
|
||||
- `RemovePeerTrackingAsync(peerNodeId)`
|
||||
- `GetActiveTrackedPeersAsync()`
|
||||
|
||||
### 3. BLite implementation
|
||||
- Add entity, mapper, and indexed collection to `CBDDCDocumentDbContext`.
|
||||
- Index strategy:
|
||||
- unique `(PeerNodeId, SourceNodeId)`
|
||||
- index `IsActive`
|
||||
- index `(SourceNodeId, ConfirmedWall, ConfirmedLogic)` for cutoff scans
|
||||
|
||||
### 4. Snapshot support
|
||||
Include peer-confirmation state in snapshot export/import/merge so pruning safety state survives backup/restore.
|
||||
|
||||
## Sync and Pruning Behavior Plan
|
||||
### 5. Auto-register peers when discovered
|
||||
On each orchestrator loop, before sync attempts:
|
||||
- collect merged peer list (discovered + known peers)
|
||||
- call `EnsurePeerRegisteredAsync(...)` for each peer
|
||||
- skip local node
|
||||
|
||||
### 6. Advance confirmation watermarks
|
||||
During sync session with a peer:
|
||||
- after vector-clock exchange, advance watermark for nodes where remote is already ahead/equal
|
||||
- after successful push batch, advance watermark to max pushed timestamp/hash per source node
|
||||
- persist updates atomically per peer when possible
|
||||
|
||||
### 7. Gate oplog pruning by peer confirmation
|
||||
Replace retention-only prune trigger with a safe cutoff computation:
|
||||
- compute retention cutoff from `OplogRetentionHours` (existing behavior)
|
||||
- compute confirmation cutoff as the minimum confirmed point across active tracked peers
|
||||
- effective cutoff = minimum(retention cutoff, confirmation cutoff)
|
||||
- prune only to effective cutoff
|
||||
|
||||
If any active tracked peer has no confirmation for relevant source nodes, do not prune those ranges.
|
||||
|
||||
### 8. Deprecated peer removal path
|
||||
Provide explicit management operation to unblock pruning for decommissioned peers:
|
||||
- add method in management service (example: `RemovePeerTrackingAsync(nodeId, removeRemoteConfig = true)`)
|
||||
- remove from confirmation tracking store
|
||||
- optionally remove static peer configuration
|
||||
- document operator workflow for node deprecation
|
||||
|
||||
## Hosting Health Check Plan
|
||||
### 9. Extend hosting health check payload
|
||||
Update Hosting `CBDDCHealthCheck` to include peer sync status data:
|
||||
- tracked peer count
|
||||
- peers with no confirmation
|
||||
- max lag (ms) between local head and peer confirmation
|
||||
- lagging peer list (node IDs)
|
||||
- last successful confirmation update per peer
|
||||
|
||||
### 10. Health status policy
|
||||
- `Healthy`: persistence OK and all active tracked peers within lag threshold
|
||||
- `Degraded`: persistence OK but one or more peers lagging/unconfirmed
|
||||
- `Unhealthy`: persistence unavailable, or critical lag breach (configurable)
|
||||
|
||||
Add configurable thresholds in hosting options/cluster options.
|
||||
|
||||
## Implementation Phases
|
||||
### Phase 1: Persistence and contracts
|
||||
- Add model + store interface + BLite implementation + DI wiring.
|
||||
- Add tests for CRUD, idempotent register, and explicit remove.
|
||||
|
||||
### Phase 2: Sync integration
|
||||
- Register peers from discovery.
|
||||
- Update confirmations from vector clock + push success.
|
||||
- Add sync tests validating watermark advancement.
|
||||
|
||||
### Phase 3: Safe pruning
|
||||
- Implement cutoff calculator service.
|
||||
- Integrate with orchestrator maintenance path.
|
||||
- Add two-node tests proving no prune before peer confirmation.
|
||||
|
||||
### Phase 4: Management and health
|
||||
- Expose remove-tracking operation in peer management API.
|
||||
- Extend hosting healthcheck output and status policy.
|
||||
- Add hosting healthcheck tests for Healthy/Degraded/Unhealthy.
|
||||
|
||||
### Phase 5: Docs and rollout
|
||||
- Update docs for peer lifecycle and pruning semantics.
|
||||
- Add upgrade notes and operational runbook for peer deprecation.
|
||||
|
||||
## Safe Subagent Usage
|
||||
- Use subagents only for isolated, low-coupling tasks with clear file ownership boundaries.
|
||||
- Assign each subagent a narrow scope (one component or one test suite at a time).
|
||||
- Require explicit task contracts for each subagent including input files/components, expected output, and forbidden operations.
|
||||
- Prohibit destructive repository actions by subagents (`reset --hard`, force-push, history rewrite, broad file deletion).
|
||||
- Require subagents to report what changed, why, and which tests were run.
|
||||
- Do not accept subagent-authored changes directly into final output without primary-agent review.
|
||||
|
||||
## Mandatory Verification After Subagent Work
|
||||
- Enforce a verification gate after every subagent-delivered change before integration.
|
||||
- Verification gate checklist: independently review the produced diff; run targeted unit/integration tests for touched behavior; validate impacted acceptance criteria; confirm no regressions in pruning safety, peer lifecycle handling, or healthcheck output.
|
||||
- Reject or rework any subagent output that fails verification.
|
||||
- Only merge/integrate subagent output after verification evidence is documented.
|
||||
|
||||
## Test Plan (Minimum)
|
||||
- Unit:
|
||||
- confirmation store upsert/get/remove behavior
|
||||
- auto-register is idempotent
|
||||
- safe cutoff computation with mixed peer states
|
||||
- removing a peer from tracking immediately changes cutoff eligibility
|
||||
- healthcheck classification rules
|
||||
|
||||
- Integration (two-node focus):
|
||||
- Node B offline: Node A does not prune confirmed-required range
|
||||
- Node B catches up: Node A prunes once confirmed
|
||||
- New node join auto-registers without manual call
|
||||
- Deprecated node removal unblocks pruning
|
||||
|
||||
## Risks and Mitigations
|
||||
- Risk: indefinite growth if a peer never confirms.
|
||||
- Mitigation: explicit removal workflow and degraded health visibility.
|
||||
|
||||
- Risk: confirmation drift after restore/restart.
|
||||
- Mitigation: snapshot persistence of confirmation records.
|
||||
|
||||
- Risk: mixed-version cluster behavior.
|
||||
- Mitigation: rely on existing vector clock exchange first; keep protocol additions backward compatible if introduced later.
|
||||
|
||||
## Acceptance Criteria
|
||||
- Oplog entries are not pruned while any active tracked peer has not confirmed required ranges.
|
||||
- Newly discovered peers are automatically present in tracking without operator action.
|
||||
- Operators can explicitly remove a deprecated peer from tracking and pruning resumes accordingly.
|
||||
- Hosting health endpoint exposes peer sync lag/confirmation status and returns degraded/unhealthy when appropriate.
|
||||
Reference in New Issue
Block a user