Files
CBDDC/Persistence-docs-issues.md

15 KiB

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.