diff --git a/CBDDC-docs-fixed.md b/CBDDC-docs-fixed.md deleted file mode 100644 index 8c857c4..0000000 --- a/CBDDC-docs-fixed.md +++ /dev/null @@ -1,7 +0,0 @@ -# Documentation Analysis Report - -Files Scanned: 138 -Files With Issues: 0 -Total Issues: 0 - -Status: No documentation issues found diff --git a/CBDDC-docs-issues.md b/CBDDC-docs-issues.md deleted file mode 100644 index e928d4a..0000000 --- a/CBDDC-docs-issues.md +++ /dev/null @@ -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 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 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 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 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 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 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 formatter) -MESSAGE: Method 'Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func 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 discoveredPeers, IEnumerable knownPeers, string localNodeId) -MESSAGE: Method 'BuildMergedPeerList(IEnumerable discoveredPeers, IEnumerable 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 peers, string localNodeId, CancellationToken token) -MESSAGE: Method 'EnsurePeersRegisteredAsync(IEnumerable 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 pushedChanges, CancellationToken token) -MESSAGE: Method 'AdvanceConfirmationForPushedBatchAsync(string peerNodeId, string sourceNodeId, IReadOnlyCollection 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 formatter) -MESSAGE: Method 'Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func 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 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. - diff --git a/Core-docs-fixed.md b/Core-docs-fixed.md deleted file mode 100644 index 380716e..0000000 --- a/Core-docs-fixed.md +++ /dev/null @@ -1,7 +0,0 @@ -# Documentation Analysis Report - -Files Scanned: 43 -Files With Issues: 0 -Total Issues: 0 - -Status: No documentation issues found diff --git a/Core-docs-issues.md b/Core-docs-issues.md deleted file mode 100644 index c7effc8..0000000 --- a/Core-docs-issues.md +++ /dev/null @@ -1,1896 +0,0 @@ -# Documentation Analysis Report - -Files Scanned: 43 -Files With Issues: 30 -Total Issues: 189 - -## Issues - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Document -MESSAGE: Property 'Document' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Node -MESSAGE: Property 'Node' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 19 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CacheEntry(Document document, LinkedListNode node) -MESSAGE: Constructor 'CacheEntry(Document document, LinkedListNode node)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 41 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: DocumentCache(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger? logger) -MESSAGE: Constructor 'DocumentCache(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 50 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Get(string collection, string key) -MESSAGE: Method 'Get(string collection, string key)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 50 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Get(string collection, string key) -MESSAGE: Method 'Get(string collection, string key)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 76 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Set(string collection, string key, Document document) -MESSAGE: Method 'Set(string collection, string key, Document document)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 76 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Set(string collection, string key, Document document) -MESSAGE: Method 'Set(string collection, string key, Document document)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 76 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Set(string collection, string key, Document document) -MESSAGE: Method 'Set(string collection, string key, Document document)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 112 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Remove(string collection, string key) -MESSAGE: Method 'Remove(string collection, string key)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/DocumentCache.cs -LINE: 112 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Remove(string collection, string key) -MESSAGE: Method 'Remove(string collection, string key)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/IDocumentCache.cs -LINE: 7 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Clear() -MESSAGE: Method 'Clear()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/IDocumentCache.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Get(string collection, string key) -MESSAGE: Method 'Get(string collection, string key)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/IDocumentCache.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetStatistics() -MESSAGE: Method 'GetStatistics()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/IDocumentCache.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Remove(string collection, string key) -MESSAGE: Method 'Remove(string collection, string key)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Cache/IDocumentCache.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Set(string collection, string key, Document document) -MESSAGE: Method 'Set(string collection, string key, Document document)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/CBDDCServiceCollectionExtensions.cs -LINE: 14 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: AddCBDDCCore(IServiceCollection services) -MESSAGE: Method 'AddCBDDCCore(IServiceCollection services)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/ChangesAppliedEventArgs.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Changes -MESSAGE: Property 'Changes' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/ChangesAppliedEventArgs.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: ChangesAppliedEventArgs(IEnumerable changes) -MESSAGE: Constructor 'ChangesAppliedEventArgs(IEnumerable changes)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/CBDDCHealthCheck.cs -LINE: 21 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CBDDCHealthCheck(IOplogStore store, ISyncStatusTracker syncTracker, ILogger? logger) -MESSAGE: Constructor 'CBDDCHealthCheck(IOplogStore store, ISyncStatusTracker syncTracker, ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/CBDDCHealthCheck.cs -LINE: 34 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: CheckAsync(CancellationToken cancellationToken) -MESSAGE: Method 'CheckAsync(CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ICBDDCHealthCheck.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CheckAsync(CancellationToken cancellationToken) -MESSAGE: Method 'CheckAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs -LINE: 7 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CleanupInactivePeers(TimeSpan inactiveThreshold) -MESSAGE: Method 'CleanupInactivePeers(TimeSpan inactiveThreshold)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetStatus() -MESSAGE: Method 'GetStatus()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RecordError(string message, string? peerNodeId, string? errorCode) -MESSAGE: Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RecordPeerFailure(string nodeId) -MESSAGE: Method 'RecordPeerFailure(string nodeId)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RecordPeerSuccess(string nodeId) -MESSAGE: Method 'RecordPeerSuccess(string nodeId)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RecordSync(int documentCount, long bytesTransferred) -MESSAGE: Method 'RecordSync(int documentCount, long bytesTransferred)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SetOnlineStatus(bool isOnline) -MESSAGE: Method 'SetOnlineStatus(bool isOnline)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/ISyncStatusTracker.cs -LINE: 14 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: UpdatePeer(string nodeId, string address, bool isConnected) -MESSAGE: Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 25 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SyncStatusTracker(ILogger? logger) -MESSAGE: Constructor 'SyncStatusTracker(ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 33 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: SetOnlineStatus(bool isOnline) -MESSAGE: Method 'SetOnlineStatus(bool isOnline)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 48 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RecordSync(int documentCount, long bytesTransferred) -MESSAGE: Method 'RecordSync(int documentCount, long bytesTransferred)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 48 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RecordSync(int documentCount, long bytesTransferred) -MESSAGE: Method 'RecordSync(int documentCount, long bytesTransferred)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 63 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RecordError(string message, string? peerNodeId, string? errorCode) -MESSAGE: Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 63 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RecordError(string message, string? peerNodeId, string? errorCode) -MESSAGE: Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 63 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RecordError(string message, string? peerNodeId, string? errorCode) -MESSAGE: Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 89 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: UpdatePeer(string nodeId, string address, bool isConnected) -MESSAGE: Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 89 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: UpdatePeer(string nodeId, string address, bool isConnected) -MESSAGE: Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 89 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: UpdatePeer(string nodeId, string address, bool isConnected) -MESSAGE: Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 119 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RecordPeerSuccess(string nodeId) -MESSAGE: Method 'RecordPeerSuccess(string nodeId)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 134 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RecordPeerFailure(string nodeId) -MESSAGE: Method 'RecordPeerFailure(string nodeId)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Diagnostics/SyncStatusTracker.cs -LINE: 169 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: CleanupInactivePeers(TimeSpan inactiveThreshold) -MESSAGE: Method 'CleanupInactivePeers(TimeSpan inactiveThreshold)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Document.cs -LINE: 9 -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.Core/Document.cs -LINE: 10 -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.Core/Document.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Content -MESSAGE: Property 'Content' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Document.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: UpdatedAt -MESSAGE: Property 'UpdatedAt' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Document.cs -LINE: 13 -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.Core/Document.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Document(string collection, string key, JsonElement content, HlcTimestamp updatedAt, bool isDeleted) -MESSAGE: Constructor 'Document(string collection, string key, JsonElement content, HlcTimestamp updatedAt, bool isDeleted)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Document.cs -LINE: 24 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Merge(OplogEntry oplogEntry, IConflictResolver? resolver) -MESSAGE: Method 'Merge(OplogEntry oplogEntry, IConflictResolver? resolver)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CBDDCException(string errorCode, string message) -MESSAGE: Constructor 'CBDDCException(string errorCode, string message)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 21 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CBDDCException(string errorCode, string message, Exception innerException) -MESSAGE: Constructor 'CBDDCException(string errorCode, string message, Exception innerException)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 33 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: NetworkException(string message) -MESSAGE: Constructor 'NetworkException(string message)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 36 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: NetworkException(string message, Exception innerException) -MESSAGE: Constructor 'NetworkException(string message, Exception innerException)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 45 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: PersistenceException(string message) -MESSAGE: Constructor 'PersistenceException(string message)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 48 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: PersistenceException(string message, Exception innerException) -MESSAGE: Constructor 'PersistenceException(string message, Exception innerException)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 57 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SyncException(string message) -MESSAGE: Constructor 'SyncException(string message)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 60 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SyncException(string message, Exception innerException) -MESSAGE: Constructor 'SyncException(string message, Exception innerException)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 69 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: ConfigurationException(string message) -MESSAGE: Constructor 'ConfigurationException(string message)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 78 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: DatabaseCorruptionException(string message) -MESSAGE: Constructor 'DatabaseCorruptionException(string message)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 81 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: DatabaseCorruptionException(string message, Exception innerException) -MESSAGE: Constructor 'DatabaseCorruptionException(string message, Exception innerException)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 90 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: TimeoutException(string operation, int timeoutMs) -MESSAGE: Constructor 'TimeoutException(string operation, int timeoutMs)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 97 -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.Core/Exceptions/CBDDCExceptions.cs -LINE: 98 -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.Core/Exceptions/CBDDCExceptions.cs -LINE: 100 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: DocumentNotFoundException(string collection, string key) -MESSAGE: Constructor 'DocumentNotFoundException(string collection, string key)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Exceptions/CBDDCExceptions.cs -LINE: 110 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CBDDCConcurrencyException(string message) -MESSAGE: Constructor 'CBDDCConcurrencyException(string message)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: PhysicalTime -MESSAGE: Property 'PhysicalTime' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: LogicalCounter -MESSAGE: Property 'LogicalCounter' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 14 -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.Core/HlcTimestamp.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: HlcTimestamp(long physicalTime, int logicalCounter, string nodeId) -MESSAGE: Constructor 'HlcTimestamp(long physicalTime, int logicalCounter, string nodeId)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 27 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: CompareTo(HlcTimestamp other) -MESSAGE: Method 'CompareTo(HlcTimestamp other)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 39 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CompareTo(object? obj) -MESSAGE: Method 'CompareTo(object? obj)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 46 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Equals(HlcTimestamp other) -MESSAGE: Method 'Equals(HlcTimestamp other)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 53 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Equals(object? obj) -MESSAGE: Method 'Equals(object? obj)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 58 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetHashCode() -MESSAGE: Method 'GetHashCode()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 80 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ToString() -MESSAGE: Method 'ToString()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/HlcTimestamp.cs -LINE: 82 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Parse(string s) -MESSAGE: Method 'Parse(string s)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs -LINE: 39 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: AddCloudPeerAsync(string nodeId, string address, OAuth2Configuration oauth2Config, CancellationToken cancellationToken) -MESSAGE: Method 'AddCloudPeerAsync(string nodeId, string address, OAuth2Configuration oauth2Config, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs -LINE: 60 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: AddStaticPeerAsync(string nodeId, string address, CancellationToken cancellationToken) -MESSAGE: Method 'AddStaticPeerAsync(string nodeId, string address, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs -LINE: 78 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RemoveRemotePeerAsync(string nodeId, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveRemotePeerAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs -LINE: 86 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetAllRemotePeersAsync(CancellationToken cancellationToken) -MESSAGE: Method 'GetAllRemotePeersAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs -LINE: 91 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: EnablePeerAsync(string nodeId, CancellationToken cancellationToken) -MESSAGE: Method 'EnablePeerAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Management/PeerManagementService.cs -LINE: 110 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DisablePeerAsync(string nodeId, CancellationToken cancellationToken) -MESSAGE: Method 'DisablePeerAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/IPeerNodeConfigurationProvider.cs -LINE: 6 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Delegate -SIGNATURE: PeerNodeConfigurationChangedEventHandler -MESSAGE: Delegate 'PeerNodeConfigurationChangedEventHandler' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/IPeerNodeConfigurationProvider.cs -LINE: 21 -CATEGORY: MalformedXml -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetConfiguration() -MESSAGE: Method 'GetConfiguration()' has malformed XML documentation that cannot be parsed. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/StaticPeerNodeConfigurationProvider.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Configuration -MESSAGE: Property 'Configuration' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/StaticPeerNodeConfigurationProvider.cs -LINE: 21 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: StaticPeerNodeConfigurationProvider(PeerNodeConfiguration configuration) -MESSAGE: Constructor 'StaticPeerNodeConfigurationProvider(PeerNodeConfiguration configuration)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/StaticPeerNodeConfigurationProvider.cs -LINE: 26 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Event -SIGNATURE: ConfigurationChanged -MESSAGE: Event 'ConfigurationChanged' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/StaticPeerNodeConfigurationProvider.cs -LINE: 28 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetConfiguration() -MESSAGE: Method 'GetConfiguration()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Network/StaticPeerNodeConfigurationProvider.cs -LINE: 33 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnConfigurationChanged(PeerNodeConfiguration newConfig) -MESSAGE: Method 'OnConfigurationChanged(PeerNodeConfiguration newConfig)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/OplogEntry.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ComputeHash(OplogEntry entry) -MESSAGE: Method 'ComputeHash(OplogEntry entry)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/OplogEntry.cs -LINE: 45 -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.Core/OplogEntry.cs -LINE: 46 -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.Core/OplogEntry.cs -LINE: 47 -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.Core/OplogEntry.cs -LINE: 48 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Payload -MESSAGE: Property 'Payload' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/OplogEntry.cs -LINE: 49 -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.Core/OplogEntry.cs -LINE: 50 -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.Core/OplogEntry.cs -LINE: 51 -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.Core/OplogEntry.cs -LINE: 53 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: OplogEntry(string collection, string key, OperationType operation, JsonElement? payload, HlcTimestamp timestamp, string previousHash, string? hash) -MESSAGE: 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.Core/QueryNode.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Value -MESSAGE: Property 'Value' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Eq(string field, object value) -MESSAGE: Constructor 'Eq(string field, object value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Value -MESSAGE: Property 'Value' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 18 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Gt(string field, object value) -MESSAGE: Constructor 'Gt(string field, object value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 24 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Value -MESSAGE: Property 'Value' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 25 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Lt(string field, object value) -MESSAGE: Constructor 'Lt(string field, object value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 30 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 31 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Value -MESSAGE: Property 'Value' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 32 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Gte(string field, object value) -MESSAGE: Constructor 'Gte(string field, object value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 37 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 38 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Value -MESSAGE: Property 'Value' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 39 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Lte(string field, object value) -MESSAGE: Constructor 'Lte(string field, object value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 44 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 45 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Value -MESSAGE: Property 'Value' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 46 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Neq(string field, object value) -MESSAGE: Constructor 'Neq(string field, object value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 51 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 52 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Values -MESSAGE: Property 'Values' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 53 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: In(string field, object[] values) -MESSAGE: Constructor 'In(string field, object[] values)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 58 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 59 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Value -MESSAGE: Property 'Value' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 60 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Contains(string field, string value) -MESSAGE: Constructor 'Contains(string field, string value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 65 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Field -MESSAGE: Property 'Field' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 66 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Value -MESSAGE: Property 'Value' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 67 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: NotContains(string field, string value) -MESSAGE: Constructor 'NotContains(string field, string value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 72 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Left -MESSAGE: Property 'Left' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 73 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Right -MESSAGE: Property 'Right' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 74 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: And(QueryNode left, QueryNode right) -MESSAGE: Constructor 'And(QueryNode left, QueryNode right)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 79 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Left -MESSAGE: Property 'Left' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 80 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Right -MESSAGE: Property 'Right' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/QueryNode.cs -LINE: 81 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: Or(QueryNode left, QueryNode right) -MESSAGE: Constructor 'Or(QueryNode left, QueryNode right)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/IRetryPolicy.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/IRetryPolicy.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs -LINE: 18 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: RetryPolicy(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger) -MESSAGE: Constructor 'RetryPolicy(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs -LINE: 28 -CATEGORY: MissingTypeParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs -LINE: 28 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs -LINE: 28 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs -LINE: 28 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs -LINE: 70 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs -LINE: 70 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Resilience/RetryPolicy.cs -LINE: 70 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken) -MESSAGE: Method 'ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/SnapshotMetadata.cs -LINE: 5 -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.Core/SnapshotMetadata.cs -LINE: 6 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: TimestampPhysicalTime -MESSAGE: Property 'TimestampPhysicalTime' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/SnapshotMetadata.cs -LINE: 7 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: TimestampLogicalCounter -MESSAGE: Property 'TimestampLogicalCounter' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/SnapshotMetadata.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.Core/Storage/CorruptDatabaseException.cs -LINE: 7 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CorruptDatabaseException(string message, Exception innerException) -MESSAGE: Constructor 'CorruptDatabaseException(string message, Exception innerException)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentMetadataStore.cs -LINE: 89 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: DocumentMetadata() -MESSAGE: Constructor 'DocumentMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentMetadataStore.cs -LINE: 91 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: DocumentMetadata(string collection, string key, HlcTimestamp updatedAt, bool isDeleted) -MESSAGE: 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/Storage/IDocumentStore.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: InterestedCollection -MESSAGE: Property 'InterestedCollection' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IDocumentStore.cs -LINE: 81 -CATEGORY: MalformedXml -SEVERITY: Error -MEMBER: Method -SIGNATURE: DeleteBatchDocumentsAsync(IEnumerable documentKeys, CancellationToken cancellationToken) -MESSAGE: Method 'DeleteBatchDocumentsAsync(IEnumerable documentKeys, CancellationToken cancellationToken)' has malformed XML documentation that cannot be parsed. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs -LINE: 22 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Update(OplogEntry entry) -MESSAGE: Method 'Update(OplogEntry entry)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs -LINE: 27 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetVectorClockAsync(CancellationToken cancellationToken) -MESSAGE: Method 'GetVectorClockAsync(CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs -LINE: 32 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetLatestTimestampAsync(CancellationToken cancellationToken) -MESSAGE: Method 'GetLatestTimestampAsync(CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs -LINE: 38 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetLastHash(string nodeId) -MESSAGE: Method 'GetLastHash(string nodeId)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs -LINE: 44 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: UpdateNode(string nodeId, HlcTimestamp timestamp, string hash) -MESSAGE: Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs -LINE: 44 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: UpdateNode(string nodeId, HlcTimestamp timestamp, string hash) -MESSAGE: Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Storage/IVectorClockService.cs -LINE: 44 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: UpdateNode(string nodeId, HlcTimestamp timestamp, string hash) -MESSAGE: Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: ShouldApply -MESSAGE: Property 'ShouldApply' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: MergedDocument -MESSAGE: Property 'MergedDocument' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: ConflictResolutionResult(bool shouldApply, Document? mergedDocument) -MESSAGE: Constructor 'ConflictResolutionResult(bool shouldApply, Document? mergedDocument)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Apply(Document document) -MESSAGE: Method 'Apply(Document document)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs -LINE: 18 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Ignore() -MESSAGE: Method 'Ignore()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IConflictResolver.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Resolve(Document? local, OplogEntry remote) -MESSAGE: Method 'Resolve(Document? local, OplogEntry remote)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IOfflineQueue.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Count -MESSAGE: Property 'Count' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IOfflineQueue.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Clear() -MESSAGE: Method 'Clear()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IOfflineQueue.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Enqueue(PendingOperation operation) -MESSAGE: Method 'Enqueue(PendingOperation operation)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/IOfflineQueue.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: FlushAsync(Func executor, CancellationToken cancellationToken) -MESSAGE: Method 'FlushAsync(Func executor, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/LastWriteWinsConflictResolver.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Resolve(Document? local, OplogEntry remote) -MESSAGE: Method 'Resolve(Document? local, OplogEntry remote)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/OfflineQueue.cs -LINE: 22 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: OfflineQueue(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger? logger) -MESSAGE: Constructor 'OfflineQueue(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/OfflineQueue.cs -LINE: 45 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Enqueue(PendingOperation operation) -MESSAGE: Method 'Enqueue(PendingOperation operation)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/OfflineQueue.cs -LINE: 66 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: FlushAsync(Func executor, CancellationToken cancellationToken) -MESSAGE: Method 'FlushAsync(Func executor, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/OfflineQueue.cs -LINE: 66 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: FlushAsync(Func executor, CancellationToken cancellationToken) -MESSAGE: Method 'FlushAsync(Func executor, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/PendingOperation.cs -LINE: 12 -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.Core/Sync/PendingOperation.cs -LINE: 13 -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.Core/Sync/PendingOperation.cs -LINE: 14 -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.Core/Sync/PendingOperation.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Data -MESSAGE: Property 'Data' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/PendingOperation.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: QueuedAt -MESSAGE: Property 'QueuedAt' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/Sync/RecursiveNodeMergeConflictResolver.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Resolve(Document? local, OplogEntry remote) -MESSAGE: Method 'Resolve(Document? local, OplogEntry remote)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: VectorClock() -MESSAGE: Constructor 'VectorClock()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 20 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: VectorClock(Dictionary clock) -MESSAGE: Constructor 'VectorClock(Dictionary clock)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 33 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetTimestamp(string nodeId) -MESSAGE: Method 'GetTimestamp(string nodeId)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 41 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: SetTimestamp(string nodeId, HlcTimestamp timestamp) -MESSAGE: Method 'SetTimestamp(string nodeId, HlcTimestamp timestamp)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 41 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: SetTimestamp(string nodeId, HlcTimestamp timestamp) -MESSAGE: Method 'SetTimestamp(string nodeId, HlcTimestamp timestamp)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 49 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: Merge(VectorClock other) -MESSAGE: Method 'Merge(VectorClock other)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 68 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: CompareTo(VectorClock other) -MESSAGE: Method 'CompareTo(VectorClock other)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 110 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetNodesWithUpdates(VectorClock other) -MESSAGE: Method 'GetNodesWithUpdates(VectorClock other)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 134 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetNodesToPush(VectorClock other) -MESSAGE: Method 'GetNodesToPush(VectorClock other)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 158 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ToString() -MESSAGE: Method 'ToString()' is missing XML documentation. - diff --git a/Network-docs-fixed.md b/Network-docs-fixed.md deleted file mode 100644 index 12e4c09..0000000 --- a/Network-docs-fixed.md +++ /dev/null @@ -1,7 +0,0 @@ -# Documentation Analysis Report - -Files Scanned: 29 -Files With Issues: 0 -Total Issues: 0 - -Status: No documentation issues found diff --git a/Network-docs-issues.md b/Network-docs-issues.md deleted file mode 100644 index 9f7cc0b..0000000 --- a/Network-docs-issues.md +++ /dev/null @@ -1,1176 +0,0 @@ -# Documentation Analysis Report - -Files Scanned: 29 -Files With Issues: 24 -Total Issues: 117 - -## Issues - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNode.cs -LINE: 138 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Host -MESSAGE: Property 'Host' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNode.cs -LINE: 139 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Port -MESSAGE: Property 'Port' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNode.cs -LINE: 141 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: NodeAddress(string host, int port) -MESSAGE: Constructor 'NodeAddress(string host, int port)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNode.cs -LINE: 147 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ToString() -MESSAGE: Method 'ToString()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNodeService.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CBDDCNodeService(ICBDDCNode node, ILogger logger) -MESSAGE: Constructor 'CBDDCNodeService(ICBDDCNode node, ILogger logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNodeService.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: StartAsync(CancellationToken cancellationToken) -MESSAGE: Method 'StartAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNodeService.cs -LINE: 47 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: StopAsync(CancellationToken cancellationToken) -MESSAGE: Method 'StopAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompositeDiscoveryService.cs -LINE: 53 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetActivePeers() -MESSAGE: Method 'GetActivePeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompositeDiscoveryService.cs -LINE: 62 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompositeDiscoveryService.cs -LINE: 97 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompressionHelper.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: IsBrotliSupported -MESSAGE: Property 'IsBrotliSupported' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompressionHelper.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Compress(byte[] data) -MESSAGE: Method 'Compress(byte[] data)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CompressionHelper.cs -LINE: 39 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Decompress(byte[] compressedData) -MESSAGE: Method 'Decompress(byte[] compressedData)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ICBDDCNode.cs -LINE: 7 -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.Network/ICBDDCNode.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Discovery -MESSAGE: Property 'Discovery' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ICBDDCNode.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Orchestrator -MESSAGE: Property 'Orchestrator' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ICBDDCNode.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Server -MESSAGE: Property 'Server' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ICBDDCNode.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ICBDDCNode.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/IDiscoveryService.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetActivePeers() -MESSAGE: Method 'GetActivePeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/IDiscoveryService.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/IDiscoveryService.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncOrchestrator.cs -LINE: 7 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncOrchestrator.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncServer.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncServer.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/ISyncServer.cs -LINE: 19 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: ListeningEndpoint -MESSAGE: Property 'ListeningEndpoint' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/BullyLeaderElectionService.cs -LINE: 29 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: IsCloudGateway -MESSAGE: Property 'IsCloudGateway' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/BullyLeaderElectionService.cs -LINE: 30 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: CurrentGatewayNodeId -MESSAGE: Property 'CurrentGatewayNodeId' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/BullyLeaderElectionService.cs -LINE: 32 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Event -SIGNATURE: LeadershipChanged -MESSAGE: Event 'LeadershipChanged' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/BullyLeaderElectionService.cs -LINE: 53 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/BullyLeaderElectionService.cs -LINE: 70 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/ILeaderElectionService.cs -LINE: 25 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Constructor -SIGNATURE: LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway) -MESSAGE: Constructor 'LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Leadership/ILeaderElectionService.cs -LINE: 25 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Constructor -SIGNATURE: LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway) -MESSAGE: Constructor 'LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/PeerDbNetworkExtensions.cs -LINE: 19 -CATEGORY: MissingTypeParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: AddCBDDCNetwork(IServiceCollection services, bool useHostedService) -MESSAGE: Method 'AddCBDDCNetwork(IServiceCollection services, bool useHostedService)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/PeerDbNetworkExtensions.cs -LINE: 19 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: AddCBDDCNetwork(IServiceCollection services, bool useHostedService) -MESSAGE: Method 'AddCBDDCNetwork(IServiceCollection services, bool useHostedService)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs -LINE: 24 -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: 30 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SendMessageAsync(Stream stream, MessageType type, IMessage message, bool useCompression, CipherState? cipherState, CancellationToken token) -MESSAGE: Method 'SendMessageAsync(Stream stream, MessageType type, IMessage message, bool useCompression, CipherState? cipherState, CancellationToken token)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Protocol/ProtocolHandler.cs -LINE: 109 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ReadMessageAsync(Stream stream, CipherState? cipherState, CancellationToken token) -MESSAGE: Method 'ReadMessageAsync(Stream stream, CipherState? cipherState, CancellationToken token)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/CryptoHelper.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Encrypt(byte[] plaintext, byte[] key) -MESSAGE: Method 'Encrypt(byte[] plaintext, byte[] key)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/CryptoHelper.cs -LINE: 34 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Decrypt(byte[] ciphertext, byte[] iv, byte[] tag, byte[] key) -MESSAGE: Method 'Decrypt(byte[] ciphertext, byte[] iv, byte[] tag, byte[] key)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IAuthenticator.cs -LINE: 7 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ValidateAsync(string nodeId, string token) -MESSAGE: Method 'ValidateAsync(string nodeId, string token)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs -LINE: 12 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs -LINE: 12 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs -LINE: 12 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs -LINE: 12 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(System.IO.Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: EncryptKey -MESSAGE: Property 'EncryptKey' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs -LINE: 18 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: DecryptKey -MESSAGE: Property 'DecryptKey' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/IPeerHandshakeService.cs -LINE: 22 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CipherState(byte[] encryptKey, byte[] decryptKey) -MESSAGE: Constructor 'CipherState(byte[] encryptKey, byte[] decryptKey)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/JwtOAuth2Validator.cs -LINE: 41 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ValidateTokenAsync(string jwtToken, CancellationToken cancellationToken) -MESSAGE: Method 'ValidateTokenAsync(string jwtToken, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/OAuth2ClientCredentialsTokenProvider.cs -LINE: 47 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetAccessTokenAsync(CancellationToken cancellationToken) -MESSAGE: Method 'GetAccessTokenAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/OAuth2ClientCredentialsTokenProvider.cs -LINE: 137 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/OAuth2ClientCredentialsTokenProvider.cs -LINE: 144 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: AccessToken -MESSAGE: Property 'AccessToken' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/OAuth2ClientCredentialsTokenProvider.cs -LINE: 147 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: ExpiresIn -MESSAGE: Property 'ExpiresIn' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/OAuth2ClientCredentialsTokenProvider.cs -LINE: 150 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: TokenType -MESSAGE: Property 'TokenType' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/SecureHandshakeService.cs -LINE: 14 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SecureHandshakeService(ILogger? logger) -MESSAGE: Constructor 'SecureHandshakeService(ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Security/SecureHandshakeService.cs -LINE: 24 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: HandshakeAsync(Stream stream, bool isInitiator, string myNodeId, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(Stream stream, bool isInitiator, string myNodeId, CancellationToken token)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs -LINE: 44 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: FailureCount -MESSAGE: Property 'FailureCount' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs -LINE: 45 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: NextRetryTime -MESSAGE: Property 'NextRetryTime' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs -LINE: 50 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILoggerFactory loggerFactory, IPeerHandshakeService? handshakeService, INetworkTelemetryService? telemetry) -MESSAGE: Constructor 'SyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILoggerFactory loggerFactory, IPeerHandshakeService? handshakeService, INetworkTelemetryService? telemetry)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs -LINE: 73 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs -LINE: 101 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 37 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: IsConnected -MESSAGE: Property 'IsConnected' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 48 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: HasHandshaked -MESSAGE: Property 'HasHandshaked' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 52 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: TcpPeerClient(string peerAddress, ILogger logger, IPeerHandshakeService? handshakeService, INetworkTelemetryService? telemetry) -MESSAGE: Constructor 'TcpPeerClient(string peerAddress, ILogger logger, IPeerHandshakeService? handshakeService, INetworkTelemetryService? telemetry)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 62 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ConnectAsync(CancellationToken token) -MESSAGE: Method 'ConnectAsync(CancellationToken token)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 143 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 143 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 143 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 143 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token) -MESSAGE: Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 196 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetClockAsync(CancellationToken token) -MESSAGE: Method 'GetClockAsync(CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 213 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetVectorClockAsync(CancellationToken token) -MESSAGE: Method 'GetVectorClockAsync(CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 237 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesAsync(HlcTimestamp since, CancellationToken token) -MESSAGE: Method 'PullChangesAsync(HlcTimestamp since, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 237 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesAsync(HlcTimestamp since, CancellationToken token) -MESSAGE: Method 'PullChangesAsync(HlcTimestamp since, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 245 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token) -MESSAGE: Method 'PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 245 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token) -MESSAGE: Method 'PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 245 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token) -MESSAGE: Method 'PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 281 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token) -MESSAGE: Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 281 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token) -MESSAGE: Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 281 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token) -MESSAGE: Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 289 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token) -MESSAGE: Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 289 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token) -MESSAGE: Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 289 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token) -MESSAGE: Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 289 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token) -MESSAGE: Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 325 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetChainRangeAsync(string startHash, string endHash, CancellationToken token) -MESSAGE: Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 325 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetChainRangeAsync(string startHash, string endHash, CancellationToken token) -MESSAGE: Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 325 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetChainRangeAsync(string startHash, string endHash, CancellationToken token) -MESSAGE: Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 351 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PushChangesAsync(IEnumerable entries, CancellationToken token) -MESSAGE: Method 'PushChangesAsync(IEnumerable entries, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 351 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: PushChangesAsync(IEnumerable entries, CancellationToken token) -MESSAGE: Method 'PushChangesAsync(IEnumerable entries, CancellationToken token)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 387 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetSnapshotAsync(Stream destination, CancellationToken token) -MESSAGE: Method 'GetSnapshotAsync(Stream destination, CancellationToken token)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 406 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpPeerClient.cs -LINE: 438 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SnapshotRequiredException() -MESSAGE: Constructor 'SnapshotRequiredException()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpSyncServer.cs -LINE: 58 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Constructor -SIGNATURE: TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry) -MESSAGE: Constructor 'TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/TcpSyncServer.cs -LINE: 58 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Constructor -SIGNATURE: TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry) -MESSAGE: Constructor 'TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RecordValue(MetricType type, double value) -MESSAGE: Method 'RecordValue(MetricType type, double value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: StartMetric(MetricType type) -MESSAGE: Method 'StartMetric(MetricType type)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetSnapshot() -MESSAGE: Method 'GetSnapshot()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs -LINE: 19 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: MetricTimer(INetworkTelemetryService service, MetricType type) -MESSAGE: Constructor 'MetricTimer(INetworkTelemetryService service, MetricType type)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/INetworkTelemetryService.cs -LINE: 26 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 33 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: NetworkTelemetryService(ILogger logger, string persistencePath) -MESSAGE: Constructor 'NetworkTelemetryService(ILogger logger, string persistencePath)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 53 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RecordValue(MetricType type, double value) -MESSAGE: Method 'RecordValue(MetricType type, double value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 58 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: StartMetric(MetricType type) -MESSAGE: Method 'StartMetric(MetricType type)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 63 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetSnapshot() -MESSAGE: Method 'GetSnapshot()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 173 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ForcePersist() -MESSAGE: Method 'ForcePersist()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 201 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 215 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: MetricBucket() -MESSAGE: Constructor 'MetricBucket()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 222 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Reset() -MESSAGE: Method 'Reset()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 228 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Add(MetricType type, double value) -MESSAGE: Method 'Add(MetricType type, double value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 235 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetSum(MetricType type) -MESSAGE: Method 'GetSum(MetricType type)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/Telemetry/NetworkTelemetryService.cs -LINE: 236 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetCount(MetricType type) -MESSAGE: Method 'GetCount(MetricType type)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs -LINE: 32 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: UdpDiscoveryService(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IDocumentStore documentStore, ILogger logger) -MESSAGE: Constructor 'UdpDiscoveryService(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IDocumentStore documentStore, ILogger logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs -LINE: 147 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs -LINE: 179 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetActivePeers() -MESSAGE: Method 'GetActivePeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs -LINE: 279 -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.Network/UdpDiscoveryService.cs -LINE: 282 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: TcpPort -MESSAGE: Property 'TcpPort' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs -LINE: 285 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: ClusterHash -MESSAGE: Property 'ClusterHash' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/UdpDiscoveryService.cs -LINE: 288 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: InterestingCollections -MESSAGE: Property 'InterestingCollections' is missing XML documentation - diff --git a/Persistence-docs-fixed.md b/Persistence-docs-fixed.md deleted file mode 100644 index f013798..0000000 --- a/Persistence-docs-fixed.md +++ /dev/null @@ -1,7 +0,0 @@ -# Documentation Analysis Report - -Files Scanned: 8 -Files With Issues: 0 -Total Issues: 0 - -Status: No documentation issues found diff --git a/Persistence-docs-issues.md b/Persistence-docs-issues.md deleted file mode 100644 index 4d3b8fe..0000000 --- a/Persistence-docs-issues.md +++ /dev/null @@ -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 appliedEntries) -MESSAGE: Method 'OnChangesApplied(IEnumerable 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 items, CancellationToken cancellationToken) -MESSAGE: Method 'ImportAsync(IEnumerable 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 items, CancellationToken cancellationToken) -MESSAGE: Method 'MergeAsync(IEnumerable 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 items, CancellationToken cancellationToken) -MESSAGE: Method 'ImportAsync(IEnumerable 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 items, CancellationToken cancellationToken) -MESSAGE: Method 'MergeAsync(IEnumerable 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 items, CancellationToken cancellationToken) -MESSAGE: Method 'ImportAsync(IEnumerable 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 items, CancellationToken cancellationToken) -MESSAGE: Method 'MergeAsync(IEnumerable 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. - diff --git a/batch4-docs-verify.md b/batch4-docs-verify.md deleted file mode 100644 index e647427..0000000 --- a/batch4-docs-verify.md +++ /dev/null @@ -1,3326 +0,0 @@ -# Documentation Analysis Report - -Files Scanned: 144 -Files With Issues: 47 -Total Issues: 332 - -## Issues - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/ConsoleInteractiveService.cs -LINE: 32 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: ConsoleInteractiveService(ILogger logger, SampleDbContext db, ICBDDCNode node, IHostApplicationLifetime lifetime, IDocumentCache cache, IOfflineQueue queue, ICBDDCHealthCheck healthCheck, ISyncStatusTracker syncTracker, IServiceProvider serviceProvider, IPeerNodeConfigurationProvider peerNodeConfigurationProvider) -MESSAGE: Constructor 'ConsoleInteractiveService(ILogger logger, SampleDbContext db, ICBDDCNode node, IHostApplicationLifetime lifetime, IDocumentCache cache, IOfflineQueue queue, ICBDDCHealthCheck healthCheck, ISyncStatusTracker syncTracker, IServiceProvider serviceProvider, IPeerNodeConfigurationProvider peerNodeConfigurationProvider)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/ConsoleInteractiveService.cs -LINE: 56 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ExecuteAsync(CancellationToken stoppingToken) -MESSAGE: Method 'ExecuteAsync(CancellationToken stoppingToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 83 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Configuration -MESSAGE: Property 'Configuration' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 85 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: StaticPeerNodeConfigurationProvider(PeerNodeConfiguration configuration) -MESSAGE: Constructor 'StaticPeerNodeConfigurationProvider(PeerNodeConfiguration configuration)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 90 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Event -SIGNATURE: ConfigurationChanged -MESSAGE: Event 'ConfigurationChanged' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 92 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetConfiguration() -MESSAGE: Method 'GetConfiguration()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 97 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnConfigurationChanged(PeerNodeConfiguration newConfig) -MESSAGE: Method 'OnConfigurationChanged(PeerNodeConfiguration newConfig)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 106 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SimpleFileLoggerProvider(string path) -MESSAGE: Constructor 'SimpleFileLoggerProvider(string path)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 107 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CreateLogger(string categoryName) -MESSAGE: Method 'CreateLogger(string categoryName)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 108 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 117 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SimpleFileLogger(string category, string path) -MESSAGE: Constructor 'SimpleFileLogger(string category, string path)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 123 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: BeginScope(TState state) -MESSAGE: Method 'BeginScope(TState state)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 124 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: IsEnabled(LogLevel logLevel) -MESSAGE: Method 'IsEnabled(LogLevel logLevel)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/Program.cs -LINE: 126 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func formatter) -MESSAGE: Method 'Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func formatter)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDbContext.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Users -MESSAGE: Property 'Users' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDbContext.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: TodoLists -MESSAGE: Property 'TodoLists' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDbContext.cs -LINE: 36 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnModelCreating(ModelBuilder modelBuilder) -MESSAGE: Method 'OnModelCreating(ModelBuilder modelBuilder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDocumentStore.cs -LINE: 20 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SampleDocumentStore(SampleDbContext context, IPeerNodeConfigurationProvider configProvider, IVectorClockService vectorClockService, ILogger? logger) -MESSAGE: Constructor 'SampleDocumentStore(SampleDbContext context, IPeerNodeConfigurationProvider configProvider, IVectorClockService vectorClockService, ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDocumentStore.cs -LINE: 35 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDocumentStore.cs -LINE: 42 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDocumentStore.cs -LINE: 81 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDocumentStore.cs -LINE: 92 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDocumentStore.cs -LINE: 99 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleDocumentStore.cs -LINE: 125 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken) -MESSAGE: Method 'GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDbContext.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SampleEfCoreDbContext(string databasePath) -MESSAGE: Constructor 'SampleEfCoreDbContext(string databasePath)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDbContext.cs -LINE: 21 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Users -MESSAGE: Property 'Users' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDbContext.cs -LINE: 22 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: TodoLists -MESSAGE: Property 'TodoLists' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDbContext.cs -LINE: 25 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: OplogEntries -MESSAGE: Property 'OplogEntries' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDbContext.cs -LINE: 26 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: RemotePeers -MESSAGE: Property 'RemotePeers' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDbContext.cs -LINE: 27 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: SnapshotMetadatas -MESSAGE: Property 'SnapshotMetadatas' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDbContext.cs -LINE: 29 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnConfiguring(DbContextOptionsBuilder optionsBuilder) -MESSAGE: Method 'OnConfiguring(DbContextOptionsBuilder optionsBuilder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDbContext.cs -LINE: 37 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnModelCreating(ModelBuilder modelBuilder) -MESSAGE: Method 'OnModelCreating(ModelBuilder modelBuilder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDocumentStore.cs -LINE: 22 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SampleEfCoreDocumentStore(SampleEfCoreDbContext context, IPeerNodeConfigurationProvider configProvider, ILogger? logger) -MESSAGE: Constructor 'SampleEfCoreDocumentStore(SampleEfCoreDbContext context, IPeerNodeConfigurationProvider configProvider, ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDocumentStore.cs -LINE: 30 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: InterestedCollection -MESSAGE: Inherited property 'InterestedCollection' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDocumentStore.cs -LINE: 34 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDocumentStore.cs -LINE: 41 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDocumentStore.cs -LINE: 80 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDocumentStore.cs -LINE: 91 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDocumentStore.cs -LINE: 98 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/SampleEfCoreDocumentStore.cs -LINE: 126 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken) -MESSAGE: Method 'GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/TodoList.cs -LINE: 8 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Id -MESSAGE: Property 'Id' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/TodoList.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Name -MESSAGE: Property 'Name' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/TodoList.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Items -MESSAGE: Property 'Items' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/TodoList.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Task -MESSAGE: Property 'Task' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/TodoList.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Completed -MESSAGE: Property 'Completed' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/TodoList.cs -LINE: 18 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: CreatedAt -MESSAGE: Property 'CreatedAt' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/User.cs -LINE: 7 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Id -MESSAGE: Property 'Id' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/User.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Name -MESSAGE: Property 'Name' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/User.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Age -MESSAGE: Property 'Age' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/User.cs -LINE: 14 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Address -MESSAGE: Property 'Address' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/samples/ZB.MOM.WW.CBDDC.Sample.Console/User.cs -LINE: 19 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: City -MESSAGE: Property 'City' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/HealthChecks/CBDDCHealthCheck.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CBDDCHealthCheck(IOplogStore oplogStore) -MESSAGE: Constructor 'CBDDCHealthCheck(IOplogStore oplogStore)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/HealthChecks/CBDDCHealthCheck.cs -LINE: 22 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken) -MESSAGE: Method 'CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/HostedServices/DiscoveryServiceHostedService.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: DiscoveryServiceHostedService(IDiscoveryService discoveryService, ILogger logger) -MESSAGE: Constructor 'DiscoveryServiceHostedService(IDiscoveryService discoveryService, ILogger logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/HostedServices/DiscoveryServiceHostedService.cs -LINE: 25 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: StartAsync(CancellationToken cancellationToken) -MESSAGE: Method 'StartAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/HostedServices/DiscoveryServiceHostedService.cs -LINE: 32 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: StopAsync(CancellationToken cancellationToken) -MESSAGE: Method 'StopAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/HostedServices/TcpSyncServerHostedService.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: TcpSyncServerHostedService(ISyncServer syncServer, ILogger logger) -MESSAGE: Constructor 'TcpSyncServerHostedService(ISyncServer syncServer, ILogger logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/HostedServices/TcpSyncServerHostedService.cs -LINE: 25 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: StartAsync(CancellationToken cancellationToken) -MESSAGE: Method 'StartAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/HostedServices/TcpSyncServerHostedService.cs -LINE: 32 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: StopAsync(CancellationToken cancellationToken) -MESSAGE: Method 'StopAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpDiscoveryService.cs -LINE: 18 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: NoOpDiscoveryService(ILogger? logger) -MESSAGE: Constructor 'NoOpDiscoveryService(ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpDiscoveryService.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetActivePeers() -MESSAGE: Method 'GetActivePeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpDiscoveryService.cs -LINE: 28 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpDiscoveryService.cs -LINE: 34 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpDiscoveryService.cs -LINE: 40 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpSyncOrchestrator.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: NoOpSyncOrchestrator(ILogger? logger) -MESSAGE: Constructor 'NoOpSyncOrchestrator(ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpSyncOrchestrator.cs -LINE: 21 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Start() -MESSAGE: Method 'Start()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpSyncOrchestrator.cs -LINE: 27 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Stop() -MESSAGE: Method 'Stop()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Hosting/Services/NoOpSyncOrchestrator.cs -LINE: 33 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Core/VectorClock.cs -LINE: 176 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ToString() -MESSAGE: Inherited method 'ToString()' should use for documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/CBDDCNode.cs -LINE: 162 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ToString() -MESSAGE: Inherited method 'ToString()' should use for documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentMetadataStore.cs -LINE: 19 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: BLiteDocumentMetadataStore(TDbContext context, ILogger>? logger) -MESSAGE: Constructor 'BLiteDocumentMetadataStore(TDbContext context, ILogger>? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 50 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: BLiteDocumentStore(TDbContext context, IPeerNodeConfigurationProvider configProvider, IVectorClockService vectorClockService, IConflictResolver? conflictResolver, ILogger? logger) -MESSAGE: Constructor 'BLiteDocumentStore(TDbContext context, IPeerNodeConfigurationProvider configProvider, IVectorClockService vectorClockService, IConflictResolver? conflictResolver, ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 101 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: CdcObserver(string collectionName, Func keySelector, BLiteDocumentStore store) -MESSAGE: Constructor 'CdcObserver(string collectionName, Func keySelector, BLiteDocumentStore store)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 111 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnNext(ChangeStreamEvent changeEvent) -MESSAGE: Method 'OnNext(ChangeStreamEvent changeEvent)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 131 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnError(Exception error) -MESSAGE: Method 'OnError(Exception error)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 132 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnCompleted() -MESSAGE: Method 'OnCompleted()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 143 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 143 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 143 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 143 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 150 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 150 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 156 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 156 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 156 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 162 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 162 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 162 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 168 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 168 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 174 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken) -MESSAGE: Method 'GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 174 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken) -MESSAGE: Method 'GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 186 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetDocumentAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetDocumentAsync(string collection, string key, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 195 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetDocumentsByCollectionAsync(string collection, CancellationToken cancellationToken) -MESSAGE: Method 'GetDocumentsByCollectionAsync(string collection, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 202 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetDocumentsAsync(List<(string Collection, string Key)> documentKeys, CancellationToken cancellationToken) -MESSAGE: Method 'GetDocumentsAsync(List<(string Collection, string Key)> documentKeys, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 216 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PutDocumentAsync(Document document, CancellationToken cancellationToken) -MESSAGE: Method 'PutDocumentAsync(Document document, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 235 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: UpdateBatchDocumentsAsync(IEnumerable documents, CancellationToken cancellationToken) -MESSAGE: Method 'UpdateBatchDocumentsAsync(IEnumerable documents, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 250 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: InsertBatchDocumentsAsync(IEnumerable documents, CancellationToken cancellationToken) -MESSAGE: Method 'InsertBatchDocumentsAsync(IEnumerable documents, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 265 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DeleteDocumentAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'DeleteDocumentAsync(string collection, string key, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 284 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DeleteBatchDocumentsAsync(IEnumerable documentKeys, CancellationToken cancellationToken) -MESSAGE: Method 'DeleteBatchDocumentsAsync(IEnumerable documentKeys, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 314 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: MergeAsync(Document incoming, CancellationToken cancellationToken) -MESSAGE: Method 'MergeAsync(Document incoming, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 347 -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.BLite/BLiteDocumentStore.cs -LINE: 359 -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.BLite/BLiteDocumentStore.cs -LINE: 370 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ImportAsync(IEnumerable items, CancellationToken cancellationToken) -MESSAGE: Method 'ImportAsync(IEnumerable items, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 384 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: MergeAsync(IEnumerable items, CancellationToken cancellationToken) -MESSAGE: Method 'MergeAsync(IEnumerable items, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 415 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken) -MESSAGE: Method 'OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 415 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken) -MESSAGE: Method 'OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 415 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken) -MESSAGE: Method 'OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 415 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken) -MESSAGE: Method 'OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 415 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken) -MESSAGE: Method 'OnLocalChangeDetectedAsync(string collection, string key, OperationType operationType, JsonElement? content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 527 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: RemoteSyncScope(SemaphoreSlim guard) -MESSAGE: Constructor 'RemoteSyncScope(SemaphoreSlim guard)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 532 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteDocumentStore.cs -LINE: 540 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: BLiteOplogStore(TDbContext dbContext, IDocumentStore documentStore, IConflictResolver conflictResolver, IVectorClockService vectorClockService, ISnapshotMetadataStore? snapshotMetadataStore, ILogger>? logger) -MESSAGE: Constructor 'BLiteOplogStore(TDbContext dbContext, IDocumentStore documentStore, IConflictResolver conflictResolver, IVectorClockService vectorClockService, ISnapshotMetadataStore? snapshotMetadataStore, ILogger>? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 28 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ApplyBatchAsync(IEnumerable oplogEntries, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyBatchAsync(IEnumerable oplogEntries, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 36 -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.BLite/BLiteOplogStore.cs -LINE: 44 -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.BLite/BLiteOplogStore.cs -LINE: 49 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetChainRangeAsync(string startHash, string endHash, CancellationToken cancellationToken) -MESSAGE: Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 72 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetEntryByHashAsync(string hash, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntryByHashAsync(string hash, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 78 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetOplogAfterAsync(HlcTimestamp timestamp, IEnumerable? collections, CancellationToken cancellationToken) -MESSAGE: Method 'GetOplogAfterAsync(HlcTimestamp timestamp, IEnumerable? collections, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 95 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetOplogForNodeAfterAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken cancellationToken) -MESSAGE: Method 'GetOplogForNodeAfterAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 113 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ImportAsync(IEnumerable items, CancellationToken cancellationToken) -MESSAGE: Method 'ImportAsync(IEnumerable items, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 122 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: MergeAsync(IEnumerable items, CancellationToken cancellationToken) -MESSAGE: Method 'MergeAsync(IEnumerable items, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 136 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PruneOplogAsync(HlcTimestamp cutoff, CancellationToken cancellationToken) -MESSAGE: Method 'PruneOplogAsync(HlcTimestamp cutoff, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 146 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: InitializeVectorClock() -MESSAGE: Method 'InitializeVectorClock()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 205 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: InsertOplogEntryAsync(OplogEntry entry, CancellationToken cancellationToken) -MESSAGE: Method 'InsertOplogEntryAsync(OplogEntry entry, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 210 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: QueryLastHashForNodeAsync(string nodeId, CancellationToken cancellationToken) -MESSAGE: Method 'QueryLastHashForNodeAsync(string nodeId, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/BLiteOplogStore.cs -LINE: 220 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: QueryLastHashTimestampFromOplogAsync(string hash, CancellationToken cancellationToken) -MESSAGE: Method 'QueryLastHashTimestampFromOplogAsync(string hash, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/CBDDCDocumentDbContext.cs -LINE: 57 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OnModelCreating(ModelBuilder modelBuilder) -MESSAGE: Method 'OnModelCreating(ModelBuilder modelBuilder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 17 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToEntity(OplogEntry entry) -MESSAGE: Method 'ToEntity(OplogEntry entry)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 38 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToDomain(OplogEntity entity) -MESSAGE: Method 'ToDomain(OplogEntity entity)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 60 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToDomain(IEnumerable entities) -MESSAGE: Method 'ToDomain(IEnumerable entities)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 72 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToEntity(SnapshotMetadata metadata) -MESSAGE: Method 'ToEntity(SnapshotMetadata metadata)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 87 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToDomain(SnapshotMetadataEntity entity) -MESSAGE: Method 'ToDomain(SnapshotMetadataEntity entity)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 101 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToDomain(IEnumerable entities) -MESSAGE: Method 'ToDomain(IEnumerable entities)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 113 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToEntity(RemotePeerConfiguration config) -MESSAGE: Method 'ToEntity(RemotePeerConfiguration config)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 132 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToDomain(RemotePeerEntity entity) -MESSAGE: Method 'ToDomain(RemotePeerEntity entity)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 154 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ToDomain(IEnumerable entities) -MESSAGE: Method 'ToDomain(IEnumerable entities)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 167 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: CreateDocumentMetadata(string collection, string key, HlcTimestamp timestamp, bool isDeleted) -MESSAGE: Method 'CreateDocumentMetadata(string collection, string key, HlcTimestamp timestamp, bool isDeleted)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 167 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: CreateDocumentMetadata(string collection, string key, HlcTimestamp timestamp, bool isDeleted) -MESSAGE: Method 'CreateDocumentMetadata(string collection, string key, HlcTimestamp timestamp, bool isDeleted)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 167 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: CreateDocumentMetadata(string collection, string key, HlcTimestamp timestamp, bool isDeleted) -MESSAGE: Method 'CreateDocumentMetadata(string collection, string key, HlcTimestamp timestamp, bool isDeleted)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.BLite/Entities/EntityMappers.cs -LINE: 167 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: CreateDocumentMetadata(string collection, string key, HlcTimestamp timestamp, bool isDeleted) -MESSAGE: Method 'CreateDocumentMetadata(string collection, string key, HlcTimestamp timestamp, bool isDeleted)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/CBDDCEntityFrameworkExtensions.cs -LINE: 20 -CATEGORY: MissingTypeParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: AddCBDDCEntityFramework(IServiceCollection services) -MESSAGE: Method 'AddCBDDCEntityFramework(IServiceCollection services)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/CBDDCEntityFrameworkExtensions.cs -LINE: 20 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: AddCBDDCEntityFramework(IServiceCollection services) -MESSAGE: Method 'AddCBDDCEntityFramework(IServiceCollection services)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/CBDDCEntityFrameworkExtensions.cs -LINE: 35 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ApplyCBDDCEntityFrameworkConfigurations(ModelBuilder modelBuilder) -MESSAGE: Method 'ApplyCBDDCEntityFrameworkConfigurations(ModelBuilder modelBuilder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/Configurations/DocumentMetadataEntityConfiguration.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Configure(EntityTypeBuilder builder) -MESSAGE: Method 'Configure(EntityTypeBuilder builder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/Configurations/OplogEntityConfiguration.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Configure(EntityTypeBuilder builder) -MESSAGE: Method 'Configure(EntityTypeBuilder builder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/Configurations/RemotePeerEntityConfiguration.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Configure(EntityTypeBuilder builder) -MESSAGE: Method 'Configure(EntityTypeBuilder builder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/Configurations/SnapshotMetadataEntityConfiguration.cs -LINE: 10 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Configure(EntityTypeBuilder builder) -MESSAGE: Method 'Configure(EntityTypeBuilder builder)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 43 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: EfCoreDocumentStore(TDbContext context, IPeerNodeConfigurationProvider configProvider, IConflictResolver? conflictResolver, ILogger? logger) -MESSAGE: Constructor 'EfCoreDocumentStore(TDbContext context, IPeerNodeConfigurationProvider configProvider, IConflictResolver? conflictResolver, ILogger? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 63 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 63 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 63 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 63 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntityAsync(string collection, string key, JsonElement content, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 69 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 69 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'ApplyContentToEntitiesBatchAsync(IEnumerable<(string Collection, string Key, JsonElement Content)> documents, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 75 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 75 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 75 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetEntityAsJsonAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 81 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 81 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 81 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntityAsync(string collection, string key, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 87 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 87 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken) -MESSAGE: Method 'RemoveEntitiesBatchAsync(IEnumerable<(string Collection, string Key)> documents, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 93 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken) -MESSAGE: Method 'GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 93 -CATEGORY: MissingParam -SEVERITY: Warning -MEMBER: Method -SIGNATURE: GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken) -MESSAGE: Method 'GetAllEntitiesAsJsonAsync(string collection, CancellationToken cancellationToken)' is missing documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 100 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: InterestedCollection -MESSAGE: Property 'InterestedCollection' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 102 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetDocumentAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'GetDocumentAsync(string collection, string key, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 118 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetDocumentsByCollectionAsync(string collection, CancellationToken cancellationToken) -MESSAGE: Method 'GetDocumentsByCollectionAsync(string collection, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 136 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetDocumentsAsync(List<(string Collection, string Key)> documentKeys, CancellationToken cancellationToken) -MESSAGE: Method 'GetDocumentsAsync(List<(string Collection, string Key)> documentKeys, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 150 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PutDocumentAsync(Document document, CancellationToken cancellationToken) -MESSAGE: Method 'PutDocumentAsync(Document document, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 169 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: UpdateBatchDocumentsAsync(IEnumerable documents, CancellationToken cancellationToken) -MESSAGE: Method 'UpdateBatchDocumentsAsync(IEnumerable documents, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 184 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: InsertBatchDocumentsAsync(IEnumerable documents, CancellationToken cancellationToken) -MESSAGE: Method 'InsertBatchDocumentsAsync(IEnumerable documents, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 199 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DeleteDocumentAsync(string collection, string key, CancellationToken cancellationToken) -MESSAGE: Method 'DeleteDocumentAsync(string collection, string key, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 218 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DeleteBatchDocumentsAsync(IEnumerable documentKeys, CancellationToken cancellationToken) -MESSAGE: Method 'DeleteBatchDocumentsAsync(IEnumerable documentKeys, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 248 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: MergeAsync(Document incoming, CancellationToken cancellationToken) -MESSAGE: Method 'MergeAsync(Document incoming, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 279 -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.EntityFramework/EfCoreDocumentStore.cs -LINE: 291 -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.EntityFramework/EfCoreDocumentStore.cs -LINE: 302 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ImportAsync(IEnumerable items, CancellationToken cancellationToken) -MESSAGE: Method 'ImportAsync(IEnumerable items, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 316 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: MergeAsync(IEnumerable items, CancellationToken cancellationToken) -MESSAGE: Method 'MergeAsync(IEnumerable items, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 443 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: RemoteSyncScope(SemaphoreSlim guard) -MESSAGE: Constructor 'RemoteSyncScope(SemaphoreSlim guard)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 448 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreDocumentStore.cs -LINE: 456 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreOplogStore.cs -LINE: 18 -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.EntityFramework/EfCoreOplogStore.cs -LINE: 19 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: MaxEntry -MESSAGE: Property 'MaxEntry' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreOplogStore.cs -LINE: 26 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: EfCoreOplogStore(TDbContext context, IDocumentStore documentStore, ISnapshotMetadataStore snapshotMetadataStore, IVectorClockService vectorClockService, IConflictResolver? conflictResolver, ILogger>? logger) -MESSAGE: Constructor 'EfCoreOplogStore(TDbContext context, IDocumentStore documentStore, ISnapshotMetadataStore snapshotMetadataStore, IVectorClockService vectorClockService, IConflictResolver? conflictResolver, ILogger>? logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreOplogStore.cs -LINE: 292 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PruneOplogAsync(HlcTimestamp cutoff, CancellationToken cancellationToken) -MESSAGE: Method 'PruneOplogAsync(HlcTimestamp cutoff, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCorePeerConfigurationStore.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: EfCorePeerConfigurationStore(TDbContext context, ILogger> logger) -MESSAGE: Constructor 'EfCorePeerConfigurationStore(TDbContext context, ILogger> logger)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCorePeerConfigurationStore.cs -LINE: 21 -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.EntityFramework/EfCorePeerConfigurationStore.cs -LINE: 40 -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.EntityFramework/EfCoreSnapshotMetadaStore.cs -LINE: 138 -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.EntityFramework/EfCoreSnapshotMetadaStore.cs -LINE: 156 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetAllSnapshotMetadataAsync(CancellationToken cancellationToken) -MESSAGE: Method 'GetAllSnapshotMetadataAsync(CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/EfCoreSnapshotMetadaStore.cs -LINE: 170 -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.EntityFramework/Entities/SnapshotMetadataEntity.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.EntityFramework/Entities/SnapshotMetadataEntity.cs -LINE: 16 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: TimestampPhysicalTime -MESSAGE: Property 'TimestampPhysicalTime' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/Entities/SnapshotMetadataEntity.cs -LINE: 17 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: TimestampLogicalCounter -MESSAGE: Property 'TimestampLogicalCounter' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Persistence.EntityFramework/Entities/SnapshotMetadataEntity.cs -LINE: 19 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Hash -MESSAGE: Property 'Hash' is missing XML documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/OplogEntryTests.cs -LINE: 11 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ComputeHash_ShouldBeDeterministic_RegardlessOfPayload() -MESSAGE: Method 'ComputeHash_ShouldBeDeterministic_RegardlessOfPayload()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/OplogEntryTests.cs -LINE: 32 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ComputeHash_ShouldUseInvariantCulture_ForTimestamp() -MESSAGE: Method 'ComputeHash_ShouldUseInvariantCulture_ForTimestamp()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/OplogEntryTests.cs -LINE: 59 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: IsValid_ShouldReturnTrue_WhenHashMatches() -MESSAGE: Method 'IsValid_ShouldReturnTrue_WhenHashMatches()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PerformanceRegressionTests.cs -LINE: 18 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: PerformanceRegressionTests(ITestOutputHelper output) -MESSAGE: Constructor 'PerformanceRegressionTests(ITestOutputHelper output)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PerformanceRegressionTests.cs -LINE: 42 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RecursiveMerge_Simple_ShouldBeWithinLimits() -MESSAGE: Method 'RecursiveMerge_Simple_ShouldBeWithinLimits()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PerformanceRegressionTests.cs -LINE: 77 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RecursiveMerge_DeepArray_ShouldBeWithinLimits() -MESSAGE: Method 'RecursiveMerge_DeepArray_ShouldBeWithinLimits()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PerformanceRegressionTests.cs -LINE: 114 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ToOplogEntry(Document d, OperationType t) -MESSAGE: Method 'ToOplogEntry(Document d, OperationType t)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/RecursiveNodeMergeConflictResolverTests.cs -LINE: 12 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: RecursiveNodeMergeConflictResolverTests() -MESSAGE: Constructor 'RecursiveNodeMergeConflictResolverTests()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/RecursiveNodeMergeConflictResolverTests.cs -LINE: 31 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Resolve_ShouldMergeDisjointFields() -MESSAGE: Method 'Resolve_ShouldMergeDisjointFields()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/RecursiveNodeMergeConflictResolverTests.cs -LINE: 54 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Resolve_ShouldPrioritizeHigherTimestamp_PrimitiveCollision() -MESSAGE: Method 'Resolve_ShouldPrioritizeHigherTimestamp_PrimitiveCollision()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/RecursiveNodeMergeConflictResolverTests.cs -LINE: 76 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Resolve_ShouldRecursivelyMergeObjects() -MESSAGE: Method 'Resolve_ShouldRecursivelyMergeObjects()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/RecursiveNodeMergeConflictResolverTests.cs -LINE: 96 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Resolve_ShouldMergeArraysById() -MESSAGE: Method 'Resolve_ShouldMergeArraysById()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/RecursiveNodeMergeConflictResolverTests.cs -LINE: 136 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Resolve_ShouldFallbackToLWW_ForPrimitiveArrays() -MESSAGE: Method 'Resolve_ShouldFallbackToLWW_ForPrimitiveArrays()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: EmptyVectorClock_ShouldReturnDefaultTimestamp() -MESSAGE: Method 'EmptyVectorClock_ShouldReturnDefaultTimestamp()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 22 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SetTimestamp_ShouldStoreTimestamp() -MESSAGE: Method 'SetTimestamp_ShouldStoreTimestamp()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 36 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: NodeIds_ShouldReturnAllNodes() -MESSAGE: Method 'NodeIds_ShouldReturnAllNodes()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 53 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CompareTo_EqualClocks_ShouldReturnEqual() -MESSAGE: Method 'CompareTo_EqualClocks_ShouldReturnEqual()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 72 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CompareTo_StrictlyAhead_ShouldReturnStrictlyAhead() -MESSAGE: Method 'CompareTo_StrictlyAhead_ShouldReturnStrictlyAhead()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 91 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CompareTo_StrictlyBehind_ShouldReturnStrictlyBehind() -MESSAGE: Method 'CompareTo_StrictlyBehind_ShouldReturnStrictlyBehind()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 110 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CompareTo_Concurrent_ShouldReturnConcurrent() -MESSAGE: Method 'CompareTo_Concurrent_ShouldReturnConcurrent()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 129 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetNodesWithUpdates_ShouldReturnNodesWhereOtherIsAhead() -MESSAGE: Method 'GetNodesWithUpdates_ShouldReturnNodesWhereOtherIsAhead()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 149 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetNodesToPush_ShouldReturnNodesWhereThisIsAhead() -MESSAGE: Method 'GetNodesToPush_ShouldReturnNodesWhereThisIsAhead()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 169 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: GetNodesWithUpdates_WhenNewNodeAppearsInOther_ShouldReturnIt() -MESSAGE: Method 'GetNodesWithUpdates_WhenNewNodeAppearsInOther_ShouldReturnIt()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 188 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Merge_ShouldTakeMaximumForEachNode() -MESSAGE: Method 'Merge_ShouldTakeMaximumForEachNode()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 210 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Clone_ShouldCreateIndependentCopy() -MESSAGE: Method 'Clone_ShouldCreateIndependentCopy()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 226 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ToString_ShouldReturnReadableFormat() -MESSAGE: Method 'ToString_ShouldReturnReadableFormat()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/VectorClockTests.cs -LINE: 242 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SplitBrainScenario_ShouldDetectConcurrency() -MESSAGE: Method 'SplitBrainScenario_ShouldDetectConcurrency()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/BullyLeaderElectionServiceTests.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SingleNode_ShouldBecomeLeader() -MESSAGE: Method 'SingleNode_ShouldBecomeLeader()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/BullyLeaderElectionServiceTests.cs -LINE: 47 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: MultipleNodes_SmallestNodeIdShouldBeLeader() -MESSAGE: Method 'MultipleNodes_SmallestNodeIdShouldBeLeader()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/BullyLeaderElectionServiceTests.cs -LINE: 70 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: LocalNodeNotSmallest_ShouldNotBeLeader() -MESSAGE: Method 'LocalNodeNotSmallest_ShouldNotBeLeader()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/BullyLeaderElectionServiceTests.cs -LINE: 93 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: LeaderFailure_ShouldReelect() -MESSAGE: Method 'LeaderFailure_ShouldReelect()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/BullyLeaderElectionServiceTests.cs -LINE: 126 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CloudPeersExcludedFromElection() -MESSAGE: Method 'CloudPeersExcludedFromElection()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ConnectionTests.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Server_Should_Reject_Clients_When_Limit_Reached() -MESSAGE: Method 'Server_Should_Reject_Clients_When_Limit_Reached()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/CryptoHelperTests.cs -LINE: 9 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: EncryptDecrypt_ShouldPreserveData() -MESSAGE: Method 'EncryptDecrypt_ShouldPreserveData()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/CryptoHelperTests.cs -LINE: 26 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Decrypt_ShouldFail_IfTampered() -MESSAGE: Method 'Decrypt_ShouldFail_IfTampered()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/HandshakeRegressionTests.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Server_Should_Call_HandshakeService_On_Client_Connection() -MESSAGE: Method 'Server_Should_Call_HandshakeService_On_Client_Connection()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ProtocolTests.cs -LINE: 18 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: ProtocolTests() -MESSAGE: Constructor 'ProtocolTests()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ProtocolTests.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RoundTrip_ShouldWorks_WithPlainMessage() -MESSAGE: Method 'RoundTrip_ShouldWorks_WithPlainMessage()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ProtocolTests.cs -LINE: 43 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RoundTrip_ShouldWork_WithCompression() -MESSAGE: Method 'RoundTrip_ShouldWork_WithCompression()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ProtocolTests.cs -LINE: 64 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RoundTrip_ShouldWork_WithEncryption() -MESSAGE: Method 'RoundTrip_ShouldWork_WithEncryption()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ProtocolTests.cs -LINE: 88 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RoundTrip_ShouldWork_WithEncryption_And_Compression() -MESSAGE: Method 'RoundTrip_ShouldWork_WithEncryption_And_Compression()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ProtocolTests.cs -LINE: 116 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ReadMessage_ShouldHandle_Fragmentation() -MESSAGE: Method 'ReadMessage_ShouldHandle_Fragmentation()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ProtocolTests.cs -LINE: 141 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: FragmentedMemoryStream(byte[] buffer, int chunkSize) -MESSAGE: Constructor 'FragmentedMemoryStream(byte[] buffer, int chunkSize)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/ProtocolTests.cs -LINE: 146 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken) -MESSAGE: Method 'ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 13 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Handshake_Should_Succeed_Between_Two_Services() -MESSAGE: Method 'Handshake_Should_Succeed_Between_Two_Services()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 66 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: CanRead -MESSAGE: Inherited property 'CanRead' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 67 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: CanSeek -MESSAGE: Inherited property 'CanSeek' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 68 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: CanWrite -MESSAGE: Inherited property 'CanWrite' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 69 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Length -MESSAGE: Inherited property 'Length' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 70 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Position -MESSAGE: Inherited property 'Position' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 72 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Flush() -MESSAGE: Method 'Flush()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 74 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Read(byte[] buffer, int offset, int count) -MESSAGE: Method 'Read(byte[] buffer, int offset, int count)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 76 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) -MESSAGE: Method 'ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 95 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Seek(long offset, SeekOrigin origin) -MESSAGE: Method 'Seek(long offset, SeekOrigin origin)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 96 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SetLength(long value) -MESSAGE: Method 'SetLength(long value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 98 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Write(byte[] buffer, int offset, int count) -MESSAGE: Method 'Write(byte[] buffer, int offset, int count)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 116 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: DuplexStream(Stream readSource, Stream writeTarget) -MESSAGE: Constructor 'DuplexStream(Stream readSource, Stream writeTarget)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 122 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: CanRead -MESSAGE: Inherited property 'CanRead' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 123 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: CanSeek -MESSAGE: Inherited property 'CanSeek' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 124 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: CanWrite -MESSAGE: Inherited property 'CanWrite' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 125 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Length -MESSAGE: Inherited property 'Length' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 126 -CATEGORY: MissingInheritDoc -SEVERITY: Error -MEMBER: Property -SIGNATURE: Position -MESSAGE: Inherited property 'Position' must have documentation - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 128 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Flush() -MESSAGE: Method 'Flush()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 130 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Read(byte[] buffer, int offset, int count) -MESSAGE: Method 'Read(byte[] buffer, int offset, int count)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 131 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) -MESSAGE: Method 'ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 134 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Write(byte[] buffer, int offset, int count) -MESSAGE: Method 'Write(byte[] buffer, int offset, int count)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 135 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) -MESSAGE: Method 'WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 138 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Seek(long offset, SeekOrigin origin) -MESSAGE: Method 'Seek(long offset, SeekOrigin origin)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SecureHandshakeTests.cs -LINE: 139 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SetLength(long value) -MESSAGE: Method 'SetLength(long value)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SnapshotReconnectRegressionTests.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: TestableSyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotMetadataStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider) -MESSAGE: Constructor 'TestableSyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotMetadataStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SnapshotReconnectRegressionTests.cs -LINE: 34 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: TestProcessInboundBatchAsync(TcpPeerClient client, string peerNodeId, IList changes, CancellationToken token) -MESSAGE: Method 'TestProcessInboundBatchAsync(TcpPeerClient client, string peerNodeId, IList changes, CancellationToken token)' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SnapshotReconnectRegressionTests.cs -LINE: 159 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ProcessInboundBatch_ShouldSkipGapRecovery_WhenEntryMatchesSnapshotBoundary() -MESSAGE: Method 'ProcessInboundBatch_ShouldSkipGapRecovery_WhenEntryMatchesSnapshotBoundary()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SnapshotReconnectRegressionTests.cs -LINE: 191 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: ProcessInboundBatch_ShouldTryRecovery_WhenSnapshotMismatch() -MESSAGE: Method 'ProcessInboundBatch_ShouldTryRecovery_WhenSnapshotMismatch()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/TelemetryTests.cs -LINE: 14 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: TelemetryTests() -MESSAGE: Constructor 'TelemetryTests()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/TelemetryTests.cs -LINE: 19 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/TelemetryTests.cs -LINE: 24 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Should_Record_And_Persist_Metrics() -MESSAGE: Method 'Should_Record_And_Persist_Metrics()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/VectorClockSyncTests.cs -LINE: 14 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: VectorClockSync_ShouldPullOnlyNodesWithUpdates() -MESSAGE: Method 'VectorClockSync_ShouldPullOnlyNodesWithUpdates()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/VectorClockSyncTests.cs -LINE: 61 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: VectorClockSync_ShouldPushOnlyNodesWithLocalUpdates() -MESSAGE: Method 'VectorClockSync_ShouldPushOnlyNodesWithLocalUpdates()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/VectorClockSyncTests.cs -LINE: 103 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: VectorClockSync_SplitBrain_ShouldSyncBothDirections() -MESSAGE: Method 'VectorClockSync_SplitBrain_ShouldSyncBothDirections()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/VectorClockSyncTests.cs -LINE: 160 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: VectorClockSync_EqualClocks_ShouldNotSync() -MESSAGE: Method 'VectorClockSync_EqualClocks_ShouldNotSync()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/VectorClockSyncTests.cs -LINE: 183 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: VectorClockSync_NewNodeJoins_ShouldBeDetected() -MESSAGE: Method 'VectorClockSync_NewNodeJoins_ShouldBeDetected()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 26 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: BLiteStoreExportImportTests() -MESSAGE: Constructor 'BLiteStoreExportImportTests()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 47 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OplogStore_ExportAsync_ReturnsAllEntries() -MESSAGE: Method 'OplogStore_ExportAsync_ReturnsAllEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 65 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OplogStore_ImportAsync_AddsEntries() -MESSAGE: Method 'OplogStore_ImportAsync_AddsEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 85 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OplogStore_MergeAsync_OnlyAddsNewEntries() -MESSAGE: Method 'OplogStore_MergeAsync_OnlyAddsNewEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 107 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OplogStore_DropAsync_ClearsAllEntries() -MESSAGE: Method 'OplogStore_DropAsync_ClearsAllEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 127 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PeerConfigStore_ExportAsync_ReturnsAllPeers() -MESSAGE: Method 'PeerConfigStore_ExportAsync_ReturnsAllPeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 143 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PeerConfigStore_ImportAsync_AddsPeers() -MESSAGE: Method 'PeerConfigStore_ImportAsync_AddsPeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 161 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PeerConfigStore_MergeAsync_OnlyAddsNewPeers() -MESSAGE: Method 'PeerConfigStore_MergeAsync_OnlyAddsNewPeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 183 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PeerConfigStore_DropAsync_ClearsAllPeers() -MESSAGE: Method 'PeerConfigStore_DropAsync_ClearsAllPeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 203 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SnapshotMetadataStore_ExportAsync_ReturnsAllMetadata() -MESSAGE: Method 'SnapshotMetadataStore_ExportAsync_ReturnsAllMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 221 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SnapshotMetadataStore_ImportAsync_AddsMetadata() -MESSAGE: Method 'SnapshotMetadataStore_ImportAsync_AddsMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 239 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SnapshotMetadataStore_MergeAsync_OnlyAddsNewMetadata() -MESSAGE: Method 'SnapshotMetadataStore_MergeAsync_OnlyAddsNewMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 260 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SnapshotMetadataStore_DropAsync_ClearsAllMetadata() -MESSAGE: Method 'SnapshotMetadataStore_DropAsync_ClearsAllMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 279 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DocumentStore_ExportAsync_ReturnsAllDocuments() -MESSAGE: Method 'DocumentStore_ExportAsync_ReturnsAllDocuments()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 296 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DocumentStore_ImportAsync_AddsDocuments() -MESSAGE: Method 'DocumentStore_ImportAsync_AddsDocuments()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 318 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DocumentStore_MergeAsync_UsesConflictResolution() -MESSAGE: Method 'DocumentStore_MergeAsync_UsesConflictResolution()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 344 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DocumentStore_DropAsync_ClearsAllDocuments() -MESSAGE: Method 'DocumentStore_DropAsync_ClearsAllDocuments()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/BLiteStoreExportImportTests.cs -LINE: 403 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 32 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: EfCoreStoreExportImportTests() -MESSAGE: Constructor 'EfCoreStoreExportImportTests()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 64 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OplogStore_ExportAsync_ReturnsAllEntries() -MESSAGE: Method 'OplogStore_ExportAsync_ReturnsAllEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 82 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OplogStore_ImportAsync_AddsEntries() -MESSAGE: Method 'OplogStore_ImportAsync_AddsEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 102 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OplogStore_MergeAsync_OnlyAddsNewEntries() -MESSAGE: Method 'OplogStore_MergeAsync_OnlyAddsNewEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 124 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: OplogStore_DropAsync_ClearsAllEntries() -MESSAGE: Method 'OplogStore_DropAsync_ClearsAllEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 143 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PeerConfigStore_ExportAsync_ReturnsAllPeers() -MESSAGE: Method 'PeerConfigStore_ExportAsync_ReturnsAllPeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 159 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PeerConfigStore_ImportAsync_AddsPeers() -MESSAGE: Method 'PeerConfigStore_ImportAsync_AddsPeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 177 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PeerConfigStore_MergeAsync_OnlyAddsNewPeers() -MESSAGE: Method 'PeerConfigStore_MergeAsync_OnlyAddsNewPeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 198 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: PeerConfigStore_DropAsync_ClearsAllPeers() -MESSAGE: Method 'PeerConfigStore_DropAsync_ClearsAllPeers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 217 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SnapshotMetadataStore_ExportAsync_ReturnsAllMetadata() -MESSAGE: Method 'SnapshotMetadataStore_ExportAsync_ReturnsAllMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 235 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SnapshotMetadataStore_ImportAsync_AddsMetadata() -MESSAGE: Method 'SnapshotMetadataStore_ImportAsync_AddsMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 253 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SnapshotMetadataStore_MergeAsync_OnlyAddsNewMetadata() -MESSAGE: Method 'SnapshotMetadataStore_MergeAsync_OnlyAddsNewMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 274 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: SnapshotMetadataStore_DropAsync_ClearsAllMetadata() -MESSAGE: Method 'SnapshotMetadataStore_DropAsync_ClearsAllMetadata()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 293 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DocumentStore_ExportAsync_ReturnsAllDocuments() -MESSAGE: Method 'DocumentStore_ExportAsync_ReturnsAllDocuments()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 310 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DocumentStore_ImportAsync_AddsDocuments() -MESSAGE: Method 'DocumentStore_ImportAsync_AddsDocuments()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 332 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DocumentStore_MergeAsync_UsesConflictResolution() -MESSAGE: Method 'DocumentStore_MergeAsync_UsesConflictResolution()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 358 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: DocumentStore_DropAsync_ClearsAllDocuments() -MESSAGE: Method 'DocumentStore_DropAsync_ClearsAllDocuments()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/EfCoreStoreExportImportTests.cs -LINE: 417 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 15 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SampleDbContextTests() -MESSAGE: Constructor 'SampleDbContextTests()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 21 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 30 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Context_ShouldInitializeCollections() -MESSAGE: Method 'Context_ShouldInitializeCollections()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 40 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Users_Insert_ShouldPersist() -MESSAGE: Method 'Users_Insert_ShouldPersist()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 64 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Users_Update_ShouldModifyExisting() -MESSAGE: Method 'Users_Update_ShouldModifyExisting()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 85 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Users_Delete_ShouldRemove() -MESSAGE: Method 'Users_Delete_ShouldRemove()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 102 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: TodoLists_InsertWithItems_ShouldPersist() -MESSAGE: Method 'TodoLists_InsertWithItems_ShouldPersist()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 130 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: TodoLists_UpdateItems_ShouldModifyNestedCollection() -MESSAGE: Method 'TodoLists_UpdateItems_ShouldModifyNestedCollection()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 160 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Users_FindAll_ShouldReturnAllUsers() -MESSAGE: Method 'Users_FindAll_ShouldReturnAllUsers()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SampleDbContextTests.cs -LINE: 179 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Users_Find_WithPredicate_ShouldFilterCorrectly() -MESSAGE: Method 'Users_Find_WithPredicate_ShouldFilterCorrectly()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SnapshotStoreTests.cs -LINE: 23 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Constructor -SIGNATURE: SnapshotStoreTests() -MESSAGE: Constructor 'SnapshotStoreTests()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SnapshotStoreTests.cs -LINE: 54 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CreateSnapshotAsync_WritesValidJsonToStream() -MESSAGE: Method 'CreateSnapshotAsync_WritesValidJsonToStream()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SnapshotStoreTests.cs -LINE: 86 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CreateSnapshotAsync_IncludesAllDocuments() -MESSAGE: Method 'CreateSnapshotAsync_IncludesAllDocuments()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SnapshotStoreTests.cs -LINE: 113 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: RoundTrip_CreateAndReplace_PreservesData() -MESSAGE: Method 'RoundTrip_CreateAndReplace_PreservesData()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SnapshotStoreTests.cs -LINE: 164 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: MergeSnapshotAsync_MergesWithExistingData() -MESSAGE: Method 'MergeSnapshotAsync_MergesWithExistingData()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SnapshotStoreTests.cs -LINE: 221 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CreateSnapshotAsync_HandlesEmptyDatabase() -MESSAGE: Method 'CreateSnapshotAsync_HandlesEmptyDatabase()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SnapshotStoreTests.cs -LINE: 239 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: CreateSnapshotAsync_IncludesOplogEntries() -MESSAGE: Method 'CreateSnapshotAsync_IncludesOplogEntries()' is missing XML documentation. - ---- - -FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Sample.Console.Tests/SnapshotStoreTests.cs -LINE: 270 -CATEGORY: MissingDoc -SEVERITY: Error -MEMBER: Method -SIGNATURE: Dispose() -MESSAGE: Method 'Dispose()' is missing XML documentation. - diff --git a/docs-batch-summary.txt b/docs-batch-summary.txt deleted file mode 100644 index 2e18828..0000000 --- a/docs-batch-summary.txt +++ /dev/null @@ -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 diff --git a/docs-batches.json b/docs-batches.json deleted file mode 100644 index da84a5a..0000000 --- a/docs-batches.json +++ /dev/null @@ -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 - } - ] -} \ No newline at end of file diff --git a/docs-file-counts.tsv b/docs-file-counts.tsv deleted file mode 100644 index 7862ab2..0000000 --- a/docs-file-counts.tsv +++ /dev/null @@ -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 diff --git a/docs-fix-batch-1.md b/docs-fix-batch-1.md deleted file mode 100644 index 46912fe..0000000 --- a/docs-fix-batch-1.md +++ /dev/null @@ -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 (and where appropriate) -- MissingInheritDoc: use /// for overrides/interface implementations where appropriate -- MissingParam: add missing ... tags -- MissingTypeParam: add missing ... 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 clock) - -> Constructor 'VectorClock(Dictionary clock)' is missing XML documentation. -- Line 33, MissingParam, Warning, Method, GetTimestamp(string nodeId) - -> Method 'GetTimestamp(string nodeId)' is missing documentation. -- Line 41, MissingParam, Warning, Method, SetTimestamp(string nodeId, HlcTimestamp timestamp) - -> Method 'SetTimestamp(string nodeId, HlcTimestamp timestamp)' is missing documentation. -- Line 41, MissingParam, Warning, Method, SetTimestamp(string nodeId, HlcTimestamp timestamp) - -> Method 'SetTimestamp(string nodeId, HlcTimestamp timestamp)' is missing documentation. -- Line 49, MissingParam, Warning, Method, Merge(VectorClock other) - -> Method 'Merge(VectorClock other)' is missing documentation. -- Line 68, MissingParam, Warning, Method, CompareTo(VectorClock other) - -> Method 'CompareTo(VectorClock other)' is missing documentation. -- Line 110, MissingParam, Warning, Method, GetNodesWithUpdates(VectorClock other) - -> Method 'GetNodesWithUpdates(VectorClock other)' is missing documentation. -- Line 134, MissingParam, Warning, Method, GetNodesToPush(VectorClock other) - -> Method 'GetNodesToPush(VectorClock other)' is missing 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 changes) - -> Constructor 'ChangesAppliedEventArgs(IEnumerable 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 documentKeys, CancellationToken cancellationToken) - -> Method 'DeleteBatchDocumentsAsync(IEnumerable 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 logger) - -> Constructor 'RetryPolicy(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger)' is missing XML documentation. -- Line 28, MissingTypeParam, Warning, Method, ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing documentation. -- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing documentation. -- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing documentation. -- Line 28, MissingParam, Warning, Method, ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken)' is missing documentation. -- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken)' is missing documentation. -- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken)' is missing documentation. -- Line 70, MissingParam, Warning, Method, ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken)' is missing 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 documentation. -- Line 25, MissingParam, Warning, Constructor, LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway) - -> Constructor 'LeadershipChangedEventArgs(string? currentGatewayNodeId, bool isLocalNodeGateway)' is missing 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. diff --git a/docs-fix-batch-2.md b/docs-fix-batch-2.md deleted file mode 100644 index 3a017b2..0000000 --- a/docs-fix-batch-2.md +++ /dev/null @@ -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 (and where appropriate) -- MissingInheritDoc: use /// for overrides/interface implementations where appropriate -- MissingParam: add missing ... tags -- MissingTypeParam: add missing ... 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 items, CancellationToken cancellationToken) - -> Method 'ImportAsync(IEnumerable items, CancellationToken cancellationToken)' is missing XML documentation. -- Line 35, MissingDoc, Error, Method, MergeAsync(IEnumerable items, CancellationToken cancellationToken) - -> Method 'MergeAsync(IEnumerable 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? logger) - -> Constructor 'SyncStatusTracker(ILogger? logger)' is missing XML documentation. -- Line 33, MissingParam, Warning, Method, SetOnlineStatus(bool isOnline) - -> Method 'SetOnlineStatus(bool isOnline)' is missing documentation. -- Line 48, MissingParam, Warning, Method, RecordSync(int documentCount, long bytesTransferred) - -> Method 'RecordSync(int documentCount, long bytesTransferred)' is missing documentation. -- Line 48, MissingParam, Warning, Method, RecordSync(int documentCount, long bytesTransferred) - -> Method 'RecordSync(int documentCount, long bytesTransferred)' is missing documentation. -- Line 63, MissingParam, Warning, Method, RecordError(string message, string? peerNodeId, string? errorCode) - -> Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing documentation. -- Line 63, MissingParam, Warning, Method, RecordError(string message, string? peerNodeId, string? errorCode) - -> Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing documentation. -- Line 63, MissingParam, Warning, Method, RecordError(string message, string? peerNodeId, string? errorCode) - -> Method 'RecordError(string message, string? peerNodeId, string? errorCode)' is missing documentation. -- Line 89, MissingParam, Warning, Method, UpdatePeer(string nodeId, string address, bool isConnected) - -> Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing documentation. -- Line 89, MissingParam, Warning, Method, UpdatePeer(string nodeId, string address, bool isConnected) - -> Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing documentation. -- Line 89, MissingParam, Warning, Method, UpdatePeer(string nodeId, string address, bool isConnected) - -> Method 'UpdatePeer(string nodeId, string address, bool isConnected)' is missing documentation. -- Line 119, MissingParam, Warning, Method, RecordPeerSuccess(string nodeId) - -> Method 'RecordPeerSuccess(string nodeId)' is missing documentation. -- Line 134, MissingParam, Warning, Method, RecordPeerFailure(string nodeId) - -> Method 'RecordPeerFailure(string nodeId)' is missing documentation. -- Line 169, MissingParam, Warning, Method, CleanupInactivePeers(TimeSpan inactiveThreshold) - -> Method 'CleanupInactivePeers(TimeSpan inactiveThreshold)' is missing 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. diff --git a/docs-fix-batch-3.md b/docs-fix-batch-3.md deleted file mode 100644 index ebf1f1e..0000000 --- a/docs-fix-batch-3.md +++ /dev/null @@ -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 (and where appropriate) -- MissingInheritDoc: use /// for overrides/interface implementations where appropriate -- MissingParam: add missing ... tags -- MissingTypeParam: add missing ... 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 node) - -> Constructor 'CacheEntry(Document document, LinkedListNode node)' is missing XML documentation. -- Line 41, MissingDoc, Error, Constructor, DocumentCache(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger? logger) - -> Constructor 'DocumentCache(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger? logger)' is missing XML documentation. -- Line 50, MissingParam, Warning, Method, Get(string collection, string key) - -> Method 'Get(string collection, string key)' is missing documentation. -- Line 50, MissingParam, Warning, Method, Get(string collection, string key) - -> Method 'Get(string collection, string key)' is missing documentation. -- Line 76, MissingParam, Warning, Method, Set(string collection, string key, Document document) - -> Method 'Set(string collection, string key, Document document)' is missing documentation. -- Line 76, MissingParam, Warning, Method, Set(string collection, string key, Document document) - -> Method 'Set(string collection, string key, Document document)' is missing documentation. -- Line 76, MissingParam, Warning, Method, Set(string collection, string key, Document document) - -> Method 'Set(string collection, string key, Document document)' is missing documentation. -- Line 112, MissingParam, Warning, Method, Remove(string collection, string key) - -> Method 'Remove(string collection, string key)' is missing documentation. -- Line 112, MissingParam, Warning, Method, Remove(string collection, string key) - -> Method 'Remove(string collection, string key)' is missing 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? logger) - -> Constructor 'OfflineQueue(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger? logger)' is missing XML documentation. -- Line 45, MissingParam, Warning, Method, Enqueue(PendingOperation operation) - -> Method 'Enqueue(PendingOperation operation)' is missing documentation. -- Line 66, MissingParam, Warning, Method, FlushAsync(Func executor, CancellationToken cancellationToken) - -> Method 'FlushAsync(Func executor, CancellationToken cancellationToken)' is missing documentation. -- Line 66, MissingParam, Warning, Method, FlushAsync(Func executor, CancellationToken cancellationToken) - -> Method 'FlushAsync(Func executor, CancellationToken cancellationToken)' is missing 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 documentation. -- Line 19, MissingParam, Warning, Method, AddCBDDCNetwork(IServiceCollection services, bool useHostedService) - -> Method 'AddCBDDCNetwork(IServiceCollection services, bool useHostedService)' is missing 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. diff --git a/docs-fix-batch-4.md b/docs-fix-batch-4.md deleted file mode 100644 index 4176f71..0000000 --- a/docs-fix-batch-4.md +++ /dev/null @@ -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 (and where appropriate) -- MissingInheritDoc: use /// for overrides/interface implementations where appropriate -- MissingParam: add missing ... tags -- MissingTypeParam: add missing ... 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 logger, string persistencePath) - -> Constructor 'NetworkTelemetryService(ILogger 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? interestingCollections, CancellationToken token) - -> Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token)' is missing documentation. -- Line 143, MissingParam, Warning, Method, HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token) - -> Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token)' is missing documentation. -- Line 143, MissingParam, Warning, Method, HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token) - -> Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token)' is missing documentation. -- Line 143, MissingParam, Warning, Method, HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token) - -> Method 'HandshakeAsync(string myNodeId, string authToken, IEnumerable? interestingCollections, CancellationToken token)' is missing documentation. -- Line 196, MissingParam, Warning, Method, GetClockAsync(CancellationToken token) - -> Method 'GetClockAsync(CancellationToken token)' is missing documentation. -- Line 213, MissingParam, Warning, Method, GetVectorClockAsync(CancellationToken token) - -> Method 'GetVectorClockAsync(CancellationToken token)' is missing documentation. -- Line 237, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, CancellationToken token) - -> Method 'PullChangesAsync(HlcTimestamp since, CancellationToken token)' is missing documentation. -- Line 237, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, CancellationToken token) - -> Method 'PullChangesAsync(HlcTimestamp since, CancellationToken token)' is missing documentation. -- Line 245, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token) - -> Method 'PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. -- Line 245, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token) - -> Method 'PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. -- Line 245, MissingParam, Warning, Method, PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token) - -> Method 'PullChangesAsync(HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. -- Line 281, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token) - -> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing documentation. -- Line 281, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token) - -> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing documentation. -- Line 281, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token) - -> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, CancellationToken token)' is missing documentation. -- Line 289, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token) - -> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. -- Line 289, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token) - -> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. -- Line 289, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token) - -> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. -- Line 289, MissingParam, Warning, Method, PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token) - -> Method 'PullChangesFromNodeAsync(string nodeId, HlcTimestamp since, IEnumerable? collections, CancellationToken token)' is missing documentation. -- Line 325, MissingParam, Warning, Method, GetChainRangeAsync(string startHash, string endHash, CancellationToken token) - -> Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing documentation. -- Line 325, MissingParam, Warning, Method, GetChainRangeAsync(string startHash, string endHash, CancellationToken token) - -> Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing documentation. -- Line 325, MissingParam, Warning, Method, GetChainRangeAsync(string startHash, string endHash, CancellationToken token) - -> Method 'GetChainRangeAsync(string startHash, string endHash, CancellationToken token)' is missing documentation. -- Line 351, MissingParam, Warning, Method, PushChangesAsync(IEnumerable entries, CancellationToken token) - -> Method 'PushChangesAsync(IEnumerable entries, CancellationToken token)' is missing documentation. -- Line 351, MissingParam, Warning, Method, PushChangesAsync(IEnumerable entries, CancellationToken token) - -> Method 'PushChangesAsync(IEnumerable entries, CancellationToken token)' is missing 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 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 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 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 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 logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry) - -> Constructor 'TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry)' is missing documentation. -- Line 58, MissingParam, Warning, Constructor, TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry) - -> Constructor 'TcpSyncServer(IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotService snapshotStore, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, ILogger logger, IAuthenticator authenticator, IPeerHandshakeService handshakeService, INetworkTelemetryService? telemetry)' is missing 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. diff --git a/docs-fix-batch-5.md b/docs-fix-batch-5.md deleted file mode 100644 index 1b6b9da..0000000 --- a/docs-fix-batch-5.md +++ /dev/null @@ -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 (and where appropriate) -- MissingInheritDoc: use /// for overrides/interface implementations where appropriate -- MissingParam: add missing ... tags -- MissingTypeParam: add missing ... 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 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 appliedEntries) - -> Method 'OnChangesApplied(IEnumerable 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 items, CancellationToken cancellationToken) - -> Method 'ImportAsync(IEnumerable items, CancellationToken cancellationToken)' is missing XML documentation. -- Line 215, MissingDoc, Error, Method, MergeAsync(IEnumerable items, CancellationToken cancellationToken) - -> Method 'MergeAsync(IEnumerable 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 executor, CancellationToken cancellationToken) - -> Method 'FlushAsync(Func 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 logger) - -> Constructor 'CBDDCNodeService(ICBDDCNode node, ILogger 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? logger) - -> Constructor 'SecureHandshakeService(ILogger? 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. diff --git a/docs-fix-batch-6.md b/docs-fix-batch-6.md deleted file mode 100644 index 58847f4..0000000 --- a/docs-fix-batch-6.md +++ /dev/null @@ -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 (and where appropriate) -- MissingInheritDoc: use /// for overrides/interface implementations where appropriate -- MissingParam: add missing ... tags -- MissingTypeParam: add missing ... 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 items, CancellationToken cancellationToken) - -> Method 'ImportAsync(IEnumerable 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 items, CancellationToken cancellationToken) - -> Method 'MergeAsync(IEnumerable 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 logger) - -> Constructor 'UdpDiscoveryService(IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IDocumentStore documentStore, ILogger 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 operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func operation, string operationName, CancellationToken cancellationToken)' is missing XML documentation. -- Line 10, MissingDoc, Error, Method, ExecuteAsync(Func> operation, string operationName, CancellationToken cancellationToken) - -> Method 'ExecuteAsync(Func> 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? logger) - -> Constructor 'CBDDCHealthCheck(IOplogStore store, ISyncStatusTracker syncTracker, ILogger? logger)' is missing XML documentation. -- Line 34, MissingParam, Warning, Method, CheckAsync(CancellationToken cancellationToken) - -> Method 'CheckAsync(CancellationToken cancellationToken)' is missing 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 documentation. -- Line 27, MissingParam, Warning, Method, GetVectorClockAsync(CancellationToken cancellationToken) - -> Method 'GetVectorClockAsync(CancellationToken cancellationToken)' is missing documentation. -- Line 32, MissingParam, Warning, Method, GetLatestTimestampAsync(CancellationToken cancellationToken) - -> Method 'GetLatestTimestampAsync(CancellationToken cancellationToken)' is missing documentation. -- Line 38, MissingParam, Warning, Method, GetLastHash(string nodeId) - -> Method 'GetLastHash(string nodeId)' is missing documentation. -- Line 44, MissingParam, Warning, Method, UpdateNode(string nodeId, HlcTimestamp timestamp, string hash) - -> Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing documentation. -- Line 44, MissingParam, Warning, Method, UpdateNode(string nodeId, HlcTimestamp timestamp, string hash) - -> Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing documentation. -- Line 44, MissingParam, Warning, Method, UpdateNode(string nodeId, HlcTimestamp timestamp, string hash) - -> Method 'UpdateNode(string nodeId, HlcTimestamp timestamp, string hash)' is missing 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. diff --git a/fixdocs-batch1-verify.md b/fixdocs-batch1-verify.md deleted file mode 100644 index 8c857c4..0000000 --- a/fixdocs-batch1-verify.md +++ /dev/null @@ -1,7 +0,0 @@ -# Documentation Analysis Report - -Files Scanned: 138 -Files With Issues: 0 -Total Issues: 0 - -Status: No documentation issues found diff --git a/fixplan.md b/fixplan.md deleted file mode 100644 index 18a3171..0000000 --- a/fixplan.md +++ /dev/null @@ -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. diff --git a/tests/ZB.MOM.WW.CBDDC.E2E.Tests/ClusterCrudSyncE2ETests.cs b/tests/ZB.MOM.WW.CBDDC.E2E.Tests/ClusterCrudSyncE2ETests.cs index f91438e..e3233ff 100644 --- a/tests/ZB.MOM.WW.CBDDC.E2E.Tests/ClusterCrudSyncE2ETests.cs +++ b/tests/ZB.MOM.WW.CBDDC.E2E.Tests/ClusterCrudSyncE2ETests.cs @@ -240,6 +240,9 @@ public class ClusterCrudSyncE2ETests private long _lastPhysicalTime = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(); private int _logicalCounter; + /// + /// Gets the LiteDB-backed context used by this test peer. + /// public SampleDbContext Context { get; } private TestPeerNode( @@ -260,6 +263,14 @@ public class ClusterCrudSyncE2ETests _nodeId = nodeId; } + /// + /// Creates a test peer node and wires all required services. + /// + /// The unique node identifier. + /// The TCP port used by the node listener. + /// The cluster authentication token. + /// The known peers this node can connect to. + /// A configured instance. 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); } + /// + /// Starts the underlying node when it has not been started yet. + /// + /// A task that represents the asynchronous operation. public async Task StartAsync() { if (_started) @@ -311,6 +326,10 @@ public class ClusterCrudSyncE2ETests _started = true; } + /// + /// Stops the underlying node when it is currently running. + /// + /// A task that represents the asynchronous operation. public async Task StopAsync() { if (!_started) @@ -322,6 +341,7 @@ public class ClusterCrudSyncE2ETests _started = false; } + /// public async ValueTask DisposeAsync() { try @@ -336,11 +356,21 @@ public class ClusterCrudSyncE2ETests TryDeleteDirectory(_workDir); } + /// + /// Reads a user document by identifier. + /// + /// The identifier of the user to read. + /// The matching user when found; otherwise . public User? ReadUser(string userId) { return Context.Users.Find(u => u.Id == userId).FirstOrDefault(); } + /// + /// Inserts or updates a user and persists the matching oplog entry. + /// + /// The user payload to upsert. + /// A task that represents the asynchronous operation. public async Task UpsertUserAsync(User user) { await PersistUserMutationWithOplogFallbackAsync( @@ -363,6 +393,11 @@ public class ClusterCrudSyncE2ETests }); } + /// + /// Deletes a user and persists the matching oplog entry. + /// + /// The identifier of the user to delete. + /// A task that represents the asynchronous operation. public async Task DeleteUserAsync(string userId) { await PersistUserMutationWithOplogFallbackAsync( @@ -376,6 +411,11 @@ public class ClusterCrudSyncE2ETests }); } + /// + /// Gets recent in-memory logs captured for this node. + /// + /// The maximum number of log entries to return. + /// A newline-delimited string of recent log entries. public string GetRecentLogs(int max = 50) { return _logSink.GetRecent(max); @@ -450,16 +490,19 @@ public class ClusterCrudSyncE2ETests private sealed class PassiveDiscoveryService : IDiscoveryService { + /// public IEnumerable GetActivePeers() { return Array.Empty(); } + /// public Task Start() { return Task.CompletedTask; } + /// public Task Stop() { return Task.CompletedTask; @@ -470,18 +513,25 @@ public class ClusterCrudSyncE2ETests { private PeerNodeConfiguration _configuration; + /// + /// Initializes a new instance of the class. + /// + /// The initial peer node configuration. public StaticPeerNodeConfigurationProvider(PeerNodeConfiguration configuration) { _configuration = configuration; } + /// public event PeerNodeConfigurationChangedEventHandler? ConfigurationChanged; + /// public Task GetConfiguration() { return Task.FromResult(_configuration); } + /// public void Update(PeerNodeConfiguration configuration) { _configuration = configuration; @@ -494,11 +544,22 @@ public class ClusterCrudSyncE2ETests private readonly ConcurrentQueue _entries = new(); private readonly string _nodeId; + /// + /// Initializes a new instance of the class. + /// + /// The node identifier associated with emitted logs. public InMemoryLogSink(string nodeId) { _nodeId = nodeId; } + /// + /// Adds a log entry to the in-memory sink. + /// + /// The log category. + /// The log level. + /// The formatted log message. + /// The optional exception associated with the log entry. 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 } } + /// + /// Gets the most recent log entries from the sink. + /// + /// The maximum number of entries to return. + /// A newline-delimited string of recent log entries, or a placeholder when none exist. public string GetRecent(int max) { var entries = _entries.ToArray(); @@ -529,16 +595,22 @@ public class ClusterCrudSyncE2ETests { private readonly InMemoryLogSink _sink; + /// + /// Initializes a new instance of the class. + /// + /// The shared sink used to capture log messages. public InMemoryLoggerProvider(InMemoryLogSink sink) { _sink = sink; } + /// public ILogger CreateLogger(string categoryName) { return new InMemoryLogger(categoryName, _sink); } + /// public void Dispose() { } @@ -549,22 +621,30 @@ public class ClusterCrudSyncE2ETests private readonly string _categoryName; private readonly InMemoryLogSink _sink; + /// + /// Initializes a new instance of the class. + /// + /// The logger category name. + /// The sink that stores emitted log messages. public InMemoryLogger(string categoryName, InMemoryLogSink sink) { _categoryName = categoryName; _sink = sink; } + /// public IDisposable BeginScope(TState state) where TState : notnull { return NullScope.Instance; } + /// public bool IsEnabled(LogLevel logLevel) { return true; } + /// public void Log( LogLevel logLevel, EventId eventId, @@ -580,6 +660,7 @@ public class ClusterCrudSyncE2ETests { public static readonly NullScope Instance = new(); + /// public void Dispose() { } diff --git a/twonode.md b/twonode.md deleted file mode 100644 index 26277c7..0000000 --- a/twonode.md +++ /dev/null @@ -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.