dohertj2/CBDDC
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
3a352944c3b41c26319563519f6557139cd6522b
CBDDC/CBDDC-docs-issues.md

17 KiB
Raw Blame History

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<TState, Exception?, string> formatter) MESSAGE: Method 'Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs LINE: 252 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: RunMaintenanceIfDueAsync(PeerNodeConfiguration config, DateTime now, CancellationToken token) MESSAGE: Method 'RunMaintenanceIfDueAsync(PeerNodeConfiguration config, DateTime now, CancellationToken token)' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/src/ZB.MOM.WW.CBDDC.Network/SyncOrchestrator.cs LINE: 529 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: BuildMergedPeerList(IEnumerable 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<TState, Exception?, string> formatter) MESSAGE: Method 'Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PeerManagementServiceTests.cs LINE: 8 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: RemovePeerTrackingAsync_WhenRemoveRemoteConfigTrue_RemovesTrackingAndRemoteConfig() MESSAGE: Method 'RemovePeerTrackingAsync_WhenRemoveRemoteConfigTrue_RemovesTrackingAndRemoteConfig()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PeerManagementServiceTests.cs LINE: 22 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: RemovePeerTrackingAsync_WhenRemoveRemoteConfigFalse_RemovesTrackingOnly() MESSAGE: Method 'RemovePeerTrackingAsync_WhenRemoveRemoteConfigFalse_RemovesTrackingOnly()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PeerManagementServiceTests.cs LINE: 35 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: RemoveRemotePeerAsync_DelegatesToTrackingRemovalWithRemoteConfig() MESSAGE: Method 'RemoveRemotePeerAsync_DelegatesToTrackingRemovalWithRemoteConfig()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Core.Tests/PeerManagementServiceTests.cs LINE: 49 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: RemovePeerTrackingAsync_WhenNodeIdInvalid_ThrowsArgumentException() MESSAGE: Method 'RemovePeerTrackingAsync_WhenNodeIdInvalid_ThrowsArgumentException()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs LINE: 11 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: CheckHealthAsync_WhenPersistenceOkAndPeersWithinLagThreshold_ReturnsHealthyWithPayload() MESSAGE: Method 'CheckHealthAsync_WhenPersistenceOkAndPeersWithinLagThreshold_ReturnsHealthyWithPayload()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs LINE: 68 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: CheckHealthAsync_WhenPeersLaggingOrUnconfirmed_ReturnsDegradedWithPayload() MESSAGE: Method 'CheckHealthAsync_WhenPeersLaggingOrUnconfirmed_ReturnsDegradedWithPayload()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs LINE: 126 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: CheckHealthAsync_WhenCriticalLagBreached_ReturnsUnhealthyWithPayload() MESSAGE: Method 'CheckHealthAsync_WhenCriticalLagBreached_ReturnsUnhealthyWithPayload()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs LINE: 161 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: CheckHealthAsync_WhenPeerHasMultipleSourceConfirmations_UsesWorstCaseLag() MESSAGE: Method 'CheckHealthAsync_WhenPeerHasMultipleSourceConfirmations_UsesWorstCaseLag()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Hosting.Tests/CBDDCHealthCheckTests.cs LINE: 205 CATEGORY: MissingDoc SEVERITY: Error MEMBER: Method SIGNATURE: CheckHealthAsync_WhenStoreThrows_ReturnsUnhealthy() MESSAGE: Method 'CheckHealthAsync_WhenStoreThrows_ReturnsUnhealthy()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDDC/tests/ZB.MOM.WW.CBDDC.Network.Tests/SnapshotReconnectRegressionTests.cs LINE: 32 CATEGORY: MissingParam SEVERITY: Warning MEMBER: Constructor SIGNATURE: TestableSyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotMetadataStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IPeerOplogConfirmationStore peerOplogConfirmationStore) MESSAGE: Constructor 'TestableSyncOrchestrator(IDiscoveryService discovery, IOplogStore oplogStore, IDocumentStore documentStore, ISnapshotMetadataStore snapshotMetadataStore, ISnapshotService snapshotService, IPeerNodeConfigurationProvider peerNodeConfigurationProvider, IPeerOplogConfirmationStore peerOplogConfirmationStore)' is missing 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.

Reference in New Issue View Git Blame Copy Permalink