dohertj2/CBDD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
528939d3a04917769cad4a497c136087444d5c30
CBDD/.fixdocs_batches/batch_4.md

139 lines
23 KiB
Markdown
Raw Blame History

# FixDocs Batch 4
Total issues: 98 (Errors: 60, Warnings: 38)
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Bson/BsonSpanWriter.cs
File issues: 30 (Errors: 16, Warnings: 14)
- LINE: 17 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: BsonSpanWriter(Span<byte> buffer, System.Collections.Concurrent.ConcurrentDictionary<string, ushort> keyMap) | MESSAGE: Constructor 'BsonSpanWriter(Span<byte> buffer, System.Collections.Concurrent.ConcurrentDictionary<string, ushort> keyMap)' is missing XML documentation.
- LINE: 24 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Position | MESSAGE: Property 'Position' is missing XML documentation
- LINE: 25 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Remaining | MESSAGE: Property 'Remaining' is missing XML documentation
- LINE: 41 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: PatchDocumentSize(int sizePosition) | MESSAGE: Method 'PatchDocumentSize(int sizePosition)' is missing <param name="sizePosition"> documentation.
- LINE: 50 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteElementHeader(BsonType type, string name) | MESSAGE: Method 'WriteElementHeader(BsonType type, string name)' is missing <param name="name"> documentation.
- LINE: 50 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteElementHeader(BsonType type, string name) | MESSAGE: Method 'WriteElementHeader(BsonType type, string name)' is missing <param name="type"> documentation.
- LINE: 87 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteString(string name, string value) | MESSAGE: Method 'WriteString(string name, string value)' is missing <param name="value"> documentation.
- LINE: 87 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteString(string name, string value) | MESSAGE: Method 'WriteString(string name, string value)' is missing <param name="name"> documentation.
- LINE: 104 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteInt32(string name, int value) | MESSAGE: Method 'WriteInt32(string name, int value)' is missing XML documentation.
- LINE: 111 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteInt64(string name, long value) | MESSAGE: Method 'WriteInt64(string name, long value)' is missing XML documentation.
- LINE: 118 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteDouble(string name, double value) | MESSAGE: Method 'WriteDouble(string name, double value)' is missing XML documentation.
- LINE: 129 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteCoordinates(string name, (double, double) coordinates) | MESSAGE: Method 'WriteCoordinates(string name, (double, double) coordinates)' is missing <param name="coordinates"> documentation.
- LINE: 129 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteCoordinates(string name, (double, double) coordinates) | MESSAGE: Method 'WriteCoordinates(string name, (double, double) coordinates)' is missing <param name="name"> documentation.
- LINE: 157 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteDecimal128(string name, decimal value) | MESSAGE: Method 'WriteDecimal128(string name, decimal value)' is missing XML documentation.
- LINE: 170 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteBoolean(string name, bool value) | MESSAGE: Method 'WriteBoolean(string name, bool value)' is missing XML documentation.
- LINE: 177 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteDateTime(string name, DateTime value) | MESSAGE: Method 'WriteDateTime(string name, DateTime value)' is missing XML documentation.
- LINE: 185 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteDateTimeOffset(string name, DateTimeOffset value) | MESSAGE: Method 'WriteDateTimeOffset(string name, DateTimeOffset value)' is missing XML documentation.
- LINE: 193 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteTimeSpan(string name, TimeSpan value) | MESSAGE: Method 'WriteTimeSpan(string name, TimeSpan value)' is missing XML documentation.
- LINE: 200 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteDateOnly(string name, DateOnly value) | MESSAGE: Method 'WriteDateOnly(string name, DateOnly value)' is missing XML documentation.
- LINE: 207 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteTimeOnly(string name, TimeOnly value) | MESSAGE: Method 'WriteTimeOnly(string name, TimeOnly value)' is missing XML documentation.
- LINE: 214 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteGuid(string name, Guid value) | MESSAGE: Method 'WriteGuid(string name, Guid value)' is missing XML documentation.
- LINE: 219 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteObjectId(string name, ObjectId value) | MESSAGE: Method 'WriteObjectId(string name, ObjectId value)' is missing XML documentation.
- LINE: 226 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteNull(string name) | MESSAGE: Method 'WriteNull(string name)' is missing XML documentation.
- LINE: 235 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteBinary(string name, ReadOnlySpan<byte> data, byte subtype) | MESSAGE: Method 'WriteBinary(string name, ReadOnlySpan<byte> data, byte subtype)' is missing <param name="subtype"> documentation.
- LINE: 235 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteBinary(string name, ReadOnlySpan<byte> data, byte subtype) | MESSAGE: Method 'WriteBinary(string name, ReadOnlySpan<byte> data, byte subtype)' is missing <param name="data"> documentation.
- LINE: 235 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteBinary(string name, ReadOnlySpan<byte> data, byte subtype) | MESSAGE: Method 'WriteBinary(string name, ReadOnlySpan<byte> data, byte subtype)' is missing <param name="name"> documentation.
- LINE: 252 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: BeginDocument(string name) | MESSAGE: Method 'BeginDocument(string name)' is missing <param name="name"> documentation.
- LINE: 269 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: EndDocument(int sizePosition) | MESSAGE: Method 'EndDocument(int sizePosition)' is missing <param name="sizePosition"> documentation.
- LINE: 278 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: BeginArray(string name) | MESSAGE: Method 'BeginArray(string name)' is missing <param name="name"> documentation.
- LINE: 287 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: EndArray(int sizePosition) | MESSAGE: Method 'EndArray(int sizePosition)' is missing <param name="sizePosition"> documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeIndex.cs
File issues: 27 (Errors: 11, Warnings: 16)
- LINE: 19 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: BTreeIndex(StorageEngine storage, IndexOptions options, uint rootPageId) | MESSAGE: Constructor 'BTreeIndex(StorageEngine storage, IndexOptions options, uint rootPageId)' is missing XML documentation.
- LINE: 68 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: RootPageId | MESSAGE: Property 'RootPageId' is missing XML documentation
- LINE: 74 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ReadPage(uint pageId, ulong transactionId, Span<byte> destination) | MESSAGE: Method 'ReadPage(uint pageId, ulong transactionId, Span<byte> destination)' is missing <param name="destination"> documentation.
- LINE: 74 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ReadPage(uint pageId, ulong transactionId, Span<byte> destination) | MESSAGE: Method 'ReadPage(uint pageId, ulong transactionId, Span<byte> destination)' is missing <param name="transactionId"> documentation.
- LINE: 74 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ReadPage(uint pageId, ulong transactionId, Span<byte> destination) | MESSAGE: Method 'ReadPage(uint pageId, ulong transactionId, Span<byte> destination)' is missing <param name="pageId"> documentation.
- LINE: 90 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Insert(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'Insert(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="transactionId"> documentation.
- LINE: 90 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Insert(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'Insert(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="location"> documentation.
- LINE: 90 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Insert(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'Insert(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="key"> documentation.
- LINE: 128 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFind(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'TryFind(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="transactionId"> documentation.
- LINE: 128 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFind(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'TryFind(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="location"> documentation.
- LINE: 128 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFind(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'TryFind(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="key"> documentation.
- LINE: 167 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Range(IndexKey minKey, IndexKey maxKey, IndexDirection direction, ulong? transactionId) | MESSAGE: Method 'Range(IndexKey minKey, IndexKey maxKey, IndexDirection direction, ulong? transactionId)' is missing <param name="transactionId"> documentation.
- LINE: 167 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Range(IndexKey minKey, IndexKey maxKey, IndexDirection direction, ulong? transactionId) | MESSAGE: Method 'Range(IndexKey minKey, IndexKey maxKey, IndexDirection direction, ulong? transactionId)' is missing <param name="direction"> documentation.
- LINE: 167 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Range(IndexKey minKey, IndexKey maxKey, IndexDirection direction, ulong? transactionId) | MESSAGE: Method 'Range(IndexKey minKey, IndexKey maxKey, IndexDirection direction, ulong? transactionId)' is missing <param name="maxKey"> documentation.
- LINE: 167 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Range(IndexKey minKey, IndexKey maxKey, IndexDirection direction, ulong? transactionId) | MESSAGE: Method 'Range(IndexKey minKey, IndexKey maxKey, IndexDirection direction, ulong? transactionId)' is missing <param name="minKey"> documentation.
- LINE: 259 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FindLeafNode(IndexKey key, ulong transactionId) | MESSAGE: Method 'FindLeafNode(IndexKey key, ulong transactionId)' is missing XML documentation.
- LINE: 327 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateCursor(ulong transactionId) | MESSAGE: Method 'CreateCursor(ulong transactionId)' is missing XML documentation.
- LINE: 334 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Equal(IndexKey key, ulong transactionId) | MESSAGE: Method 'Equal(IndexKey key, ulong transactionId)' is missing XML documentation.
- LINE: 347 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GreaterThan(IndexKey key, bool orEqual, ulong transactionId) | MESSAGE: Method 'GreaterThan(IndexKey key, bool orEqual, ulong transactionId)' is missing XML documentation.
- LINE: 364 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: LessThan(IndexKey key, bool orEqual, ulong transactionId) | MESSAGE: Method 'LessThan(IndexKey key, bool orEqual, ulong transactionId)' is missing XML documentation.
- LINE: 390 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Between(IndexKey start, IndexKey end, bool startInclusive, bool endInclusive, ulong transactionId) | MESSAGE: Method 'Between(IndexKey start, IndexKey end, bool startInclusive, bool endInclusive, ulong transactionId)' is missing XML documentation.
- LINE: 412 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: StartsWith(string prefix, ulong transactionId) | MESSAGE: Method 'StartsWith(string prefix, ulong transactionId)' is missing XML documentation.
- LINE: 432 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: In(IEnumerable<IndexKey> keys, ulong transactionId) | MESSAGE: Method 'In(IEnumerable<IndexKey> keys, ulong transactionId)' is missing XML documentation.
- LINE: 446 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Like(string pattern, ulong transactionId) | MESSAGE: Method 'Like(string pattern, ulong transactionId)' is missing XML documentation.
- LINE: 921 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Delete(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'Delete(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="transactionId"> documentation.
- LINE: 921 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Delete(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'Delete(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="location"> documentation.
- LINE: 921 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Delete(IndexKey key, DocumentLocation location, ulong? transactionId) | MESSAGE: Method 'Delete(IndexKey key, DocumentLocation location, ulong? transactionId)' is missing <param name="key"> documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.SourceGenerators/MapperGenerator.cs
File issues: 10 (Errors: 10, Warnings: 0)
- LINE: 13 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: ClassName | MESSAGE: Property 'ClassName' is missing XML documentation
- LINE: 14 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: FullClassName | MESSAGE: Property 'FullClassName' is missing XML documentation
- LINE: 15 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Namespace | MESSAGE: Property 'Namespace' is missing XML documentation
- LINE: 16 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: FilePath | MESSAGE: Property 'FilePath' is missing XML documentation
- LINE: 17 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsNested | MESSAGE: Property 'IsNested' is missing XML documentation
- LINE: 18 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsPartial | MESSAGE: Property 'IsPartial' is missing XML documentation
- LINE: 19 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: HasBaseDbContext | MESSAGE: Property 'HasBaseDbContext' is missing XML documentation
- LINE: 20 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Entities | MESSAGE: Property 'Entities' is missing XML documentation
- LINE: 21 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: GlobalNestedTypes | MESSAGE: Property 'GlobalNestedTypes' is missing XML documentation
- LINE: 27 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Initialize(IncrementalGeneratorInitializationContext context) | MESSAGE: Method 'Initialize(IncrementalGeneratorInitializationContext context)' is missing XML documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/Internal/GeoTypes.cs
File issues: 8 (Errors: 8, Warnings: 0)
- LINE: 9 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Empty | MESSAGE: Property 'Empty' is missing XML documentation
- LINE: 18 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Empty | MESSAGE: Property 'Empty' is missing XML documentation
- LINE: 20 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Contains(GeoPoint point) | MESSAGE: Method 'Contains(GeoPoint point)' is missing XML documentation.
- LINE: 26 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Intersects(GeoBox other) | MESSAGE: Method 'Intersects(GeoBox other)' is missing XML documentation.
- LINE: 32 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FromPoint(GeoPoint point) | MESSAGE: Method 'FromPoint(GeoPoint point)' is missing XML documentation.
- LINE: 37 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ExpandTo(GeoPoint point) | MESSAGE: Method 'ExpandTo(GeoPoint point)' is missing XML documentation.
- LINE: 46 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ExpandTo(GeoBox other) | MESSAGE: Method 'ExpandTo(GeoBox other)' is missing XML documentation.
- LINE: 55 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Area | MESSAGE: Property 'Area' is missing XML documentation
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/PageFile.cs
File issues: 12 (Errors: 7, Warnings: 5)
- LINE: 10 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PageSize | MESSAGE: Property 'PageSize' is missing XML documentation
- LINE: 11 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: InitialFileSize | MESSAGE: Property 'InitialFileSize' is missing XML documentation
- LINE: 12 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Access | MESSAGE: Property 'Access' is missing XML documentation
- LINE: 60 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: NextPageId | MESSAGE: Property 'NextPageId' is missing XML documentation
- LINE: 62 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: PageFile(string filePath, PageFileConfig config) | MESSAGE: Constructor 'PageFile(string filePath, PageFileConfig config)' is missing XML documentation.
- LINE: 68 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PageSize | MESSAGE: Property 'PageSize' is missing XML documentation
- LINE: 167 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ReadPage(uint pageId, Span<byte> destination) | MESSAGE: Method 'ReadPage(uint pageId, Span<byte> destination)' is missing <param name="destination"> documentation.
- LINE: 167 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ReadPage(uint pageId, Span<byte> destination) | MESSAGE: Method 'ReadPage(uint pageId, Span<byte> destination)' is missing <param name="pageId"> documentation.
- LINE: 186 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WritePage(uint pageId, ReadOnlySpan<byte> source) | MESSAGE: Method 'WritePage(uint pageId, ReadOnlySpan<byte> source)' is missing <param name="source"> documentation.
- LINE: 186 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WritePage(uint pageId, ReadOnlySpan<byte> source) | MESSAGE: Method 'WritePage(uint pageId, ReadOnlySpan<byte> source)' is missing <param name="pageId"> documentation.
- LINE: 283 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: FreePage(uint pageId) | MESSAGE: Method 'FreePage(uint pageId)' is missing <param name="pageId"> documentation.
- LINE: 341 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Dispose() | MESSAGE: Method 'Dispose()' is missing XML documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/VectorMath.cs
File issues: 4 (Errors: 4, Warnings: 0)
- LINE: 13 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Distance(ReadOnlySpan<float> v1, ReadOnlySpan<float> v2, VectorMetric metric) | MESSAGE: Method 'Distance(ReadOnlySpan<float> v1, ReadOnlySpan<float> v2, VectorMetric metric)' is missing XML documentation.
- LINE: 24 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CosineSimilarity(ReadOnlySpan<float> v1, ReadOnlySpan<float> v2) | MESSAGE: Method 'CosineSimilarity(ReadOnlySpan<float> v1, ReadOnlySpan<float> v2)' is missing XML documentation.
- LINE: 34 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: DotProduct(ReadOnlySpan<float> v1, ReadOnlySpan<float> v2) | MESSAGE: Method 'DotProduct(ReadOnlySpan<float> v1, ReadOnlySpan<float> v2)' is missing XML documentation.
- LINE: 67 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: EuclideanDistanceSquared(ReadOnlySpan<float> v1, ReadOnlySpan<float> v2) | MESSAGE: Method 'EuclideanDistanceSquared(ReadOnlySpan<float> v1, ReadOnlySpan<float> v2)' is missing XML documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/InternalEntry.cs
File issues: 3 (Errors: 3, Warnings: 0)
- LINE: 7 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Key | MESSAGE: Property 'Key' is missing XML documentation
- LINE: 8 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PageId | MESSAGE: Property 'PageId' is missing XML documentation
- LINE: 10 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: InternalEntry(IndexKey key, uint pageId) | MESSAGE: Constructor 'InternalEntry(IndexKey key, uint pageId)' is missing XML documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Schema.cs
File issues: 3 (Errors: 1, Warnings: 2)
- LINE: 10 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetSchemas(uint rootPageId) | MESSAGE: Method 'GetSchemas(uint rootPageId)' is missing XML documentation.
- LINE: 48 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: AppendSchema(uint rootPageId, BsonSchema schema) | MESSAGE: Method 'AppendSchema(uint rootPageId, BsonSchema schema)' is missing <param name="schema"> documentation.
- LINE: 48 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: AppendSchema(uint rootPageId, BsonSchema schema) | MESSAGE: Method 'AppendSchema(uint rootPageId, BsonSchema schema)' is missing <param name="rootPageId"> documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Transactions/ITransaction.cs
File issues: 1 (Errors: 0, Warnings: 1)
- LINE: 40 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: CommitAsync(CancellationToken ct) | MESSAGE: Method 'CommitAsync(CancellationToken ct)' is missing <param name="ct"> documentation.
Reference in New Issue View Git Blame Copy Permalink