Files

Joseph Doherty 08bfc17218

CI / verify (push) Has been cancelled

Details

Initial import of the CBDDC codebase with docs and tests. Add a .NET-focused gitignore to keep generated artifacts out of source control.

2026-02-20 13:03:21 -05:00

38 KiB

Raw Blame History

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/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: 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: 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: 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: 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: 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/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

38 KiB Raw Blame History

Documentation Analysis Report

Issues

38 KiB

Raw Blame History