1117 lines
30 KiB
Markdown
1117 lines
30 KiB
Markdown
# Documentation Analysis Report
|
|
|
|
Files Scanned: 59
|
|
Files With Issues: 16
|
|
Total Issues: 111
|
|
|
|
## Issues
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/BsonSchemaGenerator.cs
|
|
LINE: 14
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: FromType()
|
|
MESSAGE: Method 'FromType()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/BsonSchemaGenerator.cs
|
|
LINE: 21
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: FromType(Type type)
|
|
MESSAGE: Method 'FromType(Type type)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 15
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: CollectionName
|
|
MESSAGE: Property 'CollectionName' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 16
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: UsedKeys
|
|
MESSAGE: Property 'UsedKeys' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 17
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetSchema()
|
|
MESSAGE: Method 'GetSchema()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 26
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Serialize(T entity, BsonSpanWriter writer)
|
|
MESSAGE: Method 'Serialize(T entity, BsonSpanWriter writer)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 27
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Deserialize(BsonSpanReader reader)
|
|
MESSAGE: Method 'Deserialize(BsonSpanReader reader)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 29
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetId(T entity)
|
|
MESSAGE: Method 'GetId(T entity)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 30
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: SetId(T entity, TId id)
|
|
MESSAGE: Method 'SetId(T entity, TId id)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 32
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: ToIndexKey(TId id)
|
|
MESSAGE: Method 'ToIndexKey(TId id)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs
|
|
LINE: 33
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: FromIndexKey(IndexKey key)
|
|
MESSAGE: Method 'FromIndexKey(IndexKey key)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/SchemaVersion.cs
|
|
LINE: 7
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Version
|
|
MESSAGE: Property 'Version' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/SchemaVersion.cs
|
|
LINE: 8
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Hash
|
|
MESSAGE: Property 'Hash' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/SchemaVersion.cs
|
|
LINE: 10
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: SchemaVersion(int version, long hash)
|
|
MESSAGE: Constructor 'SchemaVersion(int version, long hash)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/SchemaVersion.cs
|
|
LINE: 16
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: ToString()
|
|
MESSAGE: Method 'ToString()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeCursor.cs
|
|
LINE: 23
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: BTreeCursor(BTreeIndex index, StorageEngine storage, ulong transactionId)
|
|
MESSAGE: Constructor 'BTreeCursor(BTreeIndex index, StorageEngine storage, ulong transactionId)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeCursor.cs
|
|
LINE: 33
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Current
|
|
MESSAGE: Property 'Current' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeCursor.cs
|
|
LINE: 42
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: MoveToFirst()
|
|
MESSAGE: Method 'MoveToFirst()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeCursor.cs
|
|
LINE: 60
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: MoveToLast()
|
|
MESSAGE: Method 'MoveToLast()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeCursor.cs
|
|
LINE: 95
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Seek(IndexKey key)
|
|
MESSAGE: Method 'Seek(IndexKey key)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeCursor.cs
|
|
LINE: 144
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: MoveNext()
|
|
MESSAGE: Method 'MoveNext()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeCursor.cs
|
|
LINE: 165
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: MovePrev()
|
|
MESSAGE: Method 'MovePrev()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeCursor.cs
|
|
LINE: 252
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Dispose()
|
|
MESSAGE: Method 'Dispose()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 13
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Key
|
|
MESSAGE: Property 'Key' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 14
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Location
|
|
MESSAGE: Property 'Location' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 16
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: IndexEntry(IndexKey key, DocumentLocation location)
|
|
MESSAGE: Constructor 'IndexEntry(IndexKey key, DocumentLocation location)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 24
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: IndexEntry(IndexKey key, ObjectId documentId)
|
|
MESSAGE: Constructor 'IndexEntry(IndexKey key, ObjectId documentId)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 32
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: CompareTo(IndexEntry other)
|
|
MESSAGE: Method 'CompareTo(IndexEntry other)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 37
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: CompareTo(object? obj)
|
|
MESSAGE: Method 'CompareTo(object? obj)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 50
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: PageId
|
|
MESSAGE: Property 'PageId' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 51
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: IsLeaf
|
|
MESSAGE: Property 'IsLeaf' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 52
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: EntryCount
|
|
MESSAGE: Property 'EntryCount' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 53
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: ParentPageId
|
|
MESSAGE: Property 'ParentPageId' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 54
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: NextLeafPageId
|
|
MESSAGE: Property 'NextLeafPageId' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 55
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: PrevLeafPageId
|
|
MESSAGE: Property 'PrevLeafPageId' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 57
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: WriteTo(Span<byte> destination)
|
|
MESSAGE: Method 'WriteTo(Span<byte> destination)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs
|
|
LINE: 70
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: ReadFrom(ReadOnlySpan<byte> source)
|
|
MESSAGE: Method 'ReadFrom(ReadOnlySpan<byte> source)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionIndexDefinition.cs
|
|
LINE: 152
|
|
CATEGORY: MissingInheritDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: ToString()
|
|
MESSAGE: Inherited method 'ToString()' should use <inheritdoc /> for documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionIndexDefinition.cs
|
|
LINE: 204
|
|
CATEGORY: MissingInheritDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: ToString()
|
|
MESSAGE: Inherited method 'ToString()' should use <inheritdoc /> for documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 38
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: RootPageId
|
|
MESSAGE: Property 'RootPageId' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 40
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: CollectionSecondaryIndex(CollectionIndexDefinition<T> definition, StorageEngine storage, IDocumentMapper<TId, T> mapper, uint rootPageId)
|
|
MESSAGE: Constructor 'CollectionSecondaryIndex(CollectionIndexDefinition<T> definition, StorageEngine storage, IDocumentMapper<TId, T> mapper, uint rootPageId)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 215
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: VectorSearch(float[] query, int k, int efSearch, ITransaction? transaction)
|
|
MESSAGE: Method 'VectorSearch(float[] query, int k, int efSearch, ITransaction? transaction)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 226
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Near((double Latitude, double Longitude) center, double radiusKm, ITransaction? transaction)
|
|
MESSAGE: Method 'Near((double Latitude, double Longitude) center, double radiusKm, ITransaction? transaction)' is missing <param name="transaction"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 226
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Near((double Latitude, double Longitude) center, double radiusKm, ITransaction? transaction)
|
|
MESSAGE: Method 'Near((double Latitude, double Longitude) center, double radiusKm, ITransaction? transaction)' is missing <param name="radiusKm"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 226
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Near((double Latitude, double Longitude) center, double radiusKm, ITransaction? transaction)
|
|
MESSAGE: Method 'Near((double Latitude, double Longitude) center, double radiusKm, ITransaction? transaction)' is missing <param name="center"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 241
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Within((double Latitude, double Longitude) min, (double Latitude, double Longitude) max, ITransaction? transaction)
|
|
MESSAGE: Method 'Within((double Latitude, double Longitude) min, (double Latitude, double Longitude) max, ITransaction? transaction)' is missing <param name="transaction"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 241
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Within((double Latitude, double Longitude) min, (double Latitude, double Longitude) max, ITransaction? transaction)
|
|
MESSAGE: Method 'Within((double Latitude, double Longitude) min, (double Latitude, double Longitude) max, ITransaction? transaction)' is missing <param name="max"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 241
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Within((double Latitude, double Longitude) min, (double Latitude, double Longitude) max, ITransaction? transaction)
|
|
MESSAGE: Method 'Within((double Latitude, double Longitude) min, (double Latitude, double Longitude) max, ITransaction? transaction)' is missing <param name="min"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 257
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Range(object? minKey, object? maxKey, IndexDirection direction, ITransaction? transaction)
|
|
MESSAGE: Method 'Range(object? minKey, object? maxKey, IndexDirection direction, ITransaction? transaction)' is missing <param name="direction"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionSecondaryIndex.cs
|
|
LINE: 396
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Dispose()
|
|
MESSAGE: Method 'Dispose()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 17
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: MinKey
|
|
MESSAGE: Property 'MinKey' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 18
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: MaxKey
|
|
MESSAGE: Property 'MaxKey' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 20
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: IndexKey(ReadOnlySpan<byte> data)
|
|
MESSAGE: Constructor 'IndexKey(ReadOnlySpan<byte> data)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 26
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: IndexKey(ObjectId objectId)
|
|
MESSAGE: Constructor 'IndexKey(ObjectId objectId)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 33
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: IndexKey(int value)
|
|
MESSAGE: Constructor 'IndexKey(int value)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 39
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: IndexKey(long value)
|
|
MESSAGE: Constructor 'IndexKey(long value)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 45
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: IndexKey(string value)
|
|
MESSAGE: Constructor 'IndexKey(string value)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 51
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: IndexKey(Guid value)
|
|
MESSAGE: Constructor 'IndexKey(Guid value)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 57
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Data
|
|
MESSAGE: Property 'Data' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 59
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: CompareTo(IndexKey other)
|
|
MESSAGE: Method 'CompareTo(IndexKey other)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 76
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Equals(IndexKey other)
|
|
MESSAGE: Method 'Equals(IndexKey other)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 87
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Equals(object? obj)
|
|
MESSAGE: Method 'Equals(object? obj)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 89
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetHashCode()
|
|
MESSAGE: Method 'GetHashCode()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 105
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Create(T value)
|
|
MESSAGE: Method 'Create(T value)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/IndexKey.cs
|
|
LINE: 119
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: As()
|
|
MESSAGE: Method 'As()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Metadata/ValueConverter.cs
|
|
LINE: 12
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: ConvertToProvider(TModel model)
|
|
MESSAGE: Method 'ConvertToProvider(TModel model)' is missing <param name="model"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Metadata/ValueConverter.cs
|
|
LINE: 17
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: ConvertFromProvider(TProvider provider)
|
|
MESSAGE: Method 'ConvertFromProvider(TProvider provider)' is missing <param name="provider"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeExpressionVisitor.cs
|
|
LINE: 9
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetModel()
|
|
MESSAGE: Method 'GetModel()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeExpressionVisitor.cs
|
|
LINE: 11
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: VisitMethodCall(MethodCallExpression node)
|
|
MESSAGE: Method 'VisitMethodCall(MethodCallExpression node)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeQueryProvider.cs
|
|
LINE: 13
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: BTreeQueryProvider(DocumentCollection<TId, T> collection)
|
|
MESSAGE: Constructor 'BTreeQueryProvider(DocumentCollection<TId, T> collection)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeQueryProvider.cs
|
|
LINE: 18
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: CreateQuery(Expression expression)
|
|
MESSAGE: Method 'CreateQuery(Expression expression)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeQueryProvider.cs
|
|
LINE: 33
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: CreateQuery(Expression expression)
|
|
MESSAGE: Method 'CreateQuery(Expression expression)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeQueryProvider.cs
|
|
LINE: 38
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Execute(Expression expression)
|
|
MESSAGE: Method 'Execute(Expression expression)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeQueryProvider.cs
|
|
LINE: 43
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Execute(Expression expression)
|
|
MESSAGE: Method 'Execute(Expression expression)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeQueryProvider.cs
|
|
LINE: 129
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Root
|
|
MESSAGE: Property 'Root' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeQueryProvider.cs
|
|
LINE: 131
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: VisitConstant(ConstantExpression node)
|
|
MESSAGE: Method 'VisitConstant(ConstantExpression node)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/EnumerableRewriter.cs
|
|
LINE: 30
|
|
CATEGORY: MissingInheritDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: VisitConstant(ConstantExpression node)
|
|
MESSAGE: Inherited method 'VisitConstant(ConstantExpression node)' should use <inheritdoc /> for documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/EnumerableRewriter.cs
|
|
LINE: 45
|
|
CATEGORY: MissingInheritDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: VisitMethodCall(MethodCallExpression node)
|
|
MESSAGE: Inherited method 'VisitMethodCall(MethodCallExpression node)' should use <inheritdoc /> for documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 10
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: IndexName
|
|
MESSAGE: Property 'IndexName' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 11
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: MinValue
|
|
MESSAGE: Property 'MinValue' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 12
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: MaxValue
|
|
MESSAGE: Property 'MaxValue' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 13
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: IsRange
|
|
MESSAGE: Property 'IsRange' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 14
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: IsVectorSearch
|
|
MESSAGE: Property 'IsVectorSearch' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 15
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: VectorQuery
|
|
MESSAGE: Property 'VectorQuery' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 16
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: K
|
|
MESSAGE: Property 'K' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 18
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: IsSpatialSearch
|
|
MESSAGE: Property 'IsSpatialSearch' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 19
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: SpatialPoint
|
|
MESSAGE: Property 'SpatialPoint' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 20
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: RadiusKm
|
|
MESSAGE: Property 'RadiusKm' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 21
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: SpatialMin
|
|
MESSAGE: Property 'SpatialMin' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 22
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: SpatialMax
|
|
MESSAGE: Property 'SpatialMax' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 23
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: SpatialType
|
|
MESSAGE: Property 'SpatialType' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs
|
|
LINE: 28
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: TryOptimize(QueryModel model, IEnumerable<CollectionIndexInfo> indexes)
|
|
MESSAGE: Method 'TryOptimize(QueryModel model, IEnumerable<CollectionIndexInfo> indexes)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Dictionary.cs
|
|
LINE: 79
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetKeyMap()
|
|
MESSAGE: Method 'GetKeyMap()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Dictionary.cs
|
|
LINE: 80
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetKeyReverseMap()
|
|
MESSAGE: Method 'GetKeyReverseMap()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Dictionary.cs
|
|
LINE: 86
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: GetOrAddDictionaryEntry(string key)
|
|
MESSAGE: Method 'GetOrAddDictionaryEntry(string key)' is missing <param name="key"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Dictionary.cs
|
|
LINE: 136
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetDictionaryKey(ushort id)
|
|
MESSAGE: Method 'GetDictionaryKey(ushort id)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Dictionary.cs
|
|
LINE: 195
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: RegisterKeys(IEnumerable<string> keys)
|
|
MESSAGE: Method 'RegisterKeys(IEnumerable<string> keys)' is missing <param name="keys"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Recovery.cs
|
|
LINE: 74
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: CheckpointAsync(CancellationToken ct)
|
|
MESSAGE: Method 'CheckpointAsync(CancellationToken ct)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 26
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: IncrementNodeCount(Span<byte> page)
|
|
MESSAGE: Method 'IncrementNodeCount(Span<byte> page)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 32
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Initialize(Span<byte> page, uint pageId, int dimensions, int maxM)
|
|
MESSAGE: Method 'Initialize(Span<byte> page, uint pageId, int dimensions, int maxM)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 57
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetNodeCount(ReadOnlySpan<byte> page)
|
|
MESSAGE: Method 'GetNodeCount(ReadOnlySpan<byte> page)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 60
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetNodeSize(ReadOnlySpan<byte> page)
|
|
MESSAGE: Method 'GetNodeSize(ReadOnlySpan<byte> page)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 63
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetMaxNodes(ReadOnlySpan<byte> page)
|
|
MESSAGE: Method 'GetMaxNodes(ReadOnlySpan<byte> page)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 69
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)
|
|
MESSAGE: Method 'WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)' is missing <param name="dimensions"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 69
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)
|
|
MESSAGE: Method 'WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)' is missing <param name="vector"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 69
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)
|
|
MESSAGE: Method 'WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)' is missing <param name="maxLevel"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 69
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)
|
|
MESSAGE: Method 'WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)' is missing <param name="loc"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 69
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)
|
|
MESSAGE: Method 'WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)' is missing <param name="nodeIndex"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 69
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)
|
|
MESSAGE: Method 'WriteNode(Span<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, ReadOnlySpan<float> vector, int dimensions)' is missing <param name="page"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 90
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: ReadNodeData(ReadOnlySpan<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, Span<float> vector)
|
|
MESSAGE: Method 'ReadNodeData(ReadOnlySpan<byte> page, int nodeIndex, DocumentLocation loc, int maxLevel, Span<float> vector)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/VectorPage.cs
|
|
LINE: 103
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetLinksSpan(Span<byte> page, int nodeIndex, int level, int dimensions, int maxM)
|
|
MESSAGE: Method 'GetLinksSpan(Span<byte> page, int nodeIndex, int level, int dimensions, int maxM)' is missing XML documentation.
|
|
|