140 lines
26 KiB
Markdown
140 lines
26 KiB
Markdown
# FixDocs Batch 6
|
|
|
|
Total issues: 103 (Errors: 60, Warnings: 43)
|
|
|
|
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Transactions/Transaction.cs
|
|
File issues: 16 (Errors: 15, Warnings: 1)
|
|
|
|
- LINE: 23 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: Transaction(ulong transactionId, StorageEngine storage, IsolationLevel isolationLevel) | MESSAGE: Constructor 'Transaction(ulong transactionId, StorageEngine storage, IsolationLevel isolationLevel)' is missing XML documentation.
|
|
- LINE: 34 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: AddChange(CDC.InternalChangeEvent change) | MESSAGE: Method 'AddChange(CDC.InternalChangeEvent change)' is missing XML documentation.
|
|
- LINE: 39 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: TransactionId | MESSAGE: Property 'TransactionId' is missing XML documentation
|
|
- LINE: 40 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: State | MESSAGE: Property 'State' is missing XML documentation
|
|
- LINE: 41 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsolationLevel | MESSAGE: Property 'IsolationLevel' is missing XML documentation
|
|
- LINE: 42 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: StartTime | MESSAGE: Property 'StartTime' is missing XML documentation
|
|
- LINE: 49 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: AddWrite(WriteOperation operation) | MESSAGE: Method 'AddWrite(WriteOperation operation)' is missing <param name="operation"> documentation.
|
|
- LINE: 99 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CommitAsync(CancellationToken ct) | MESSAGE: Method 'CommitAsync(CancellationToken ct)' is missing XML documentation.
|
|
- LINE: 139 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Rollback() | MESSAGE: Method 'Rollback()' is missing XML documentation.
|
|
- LINE: 151 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Dispose() | MESSAGE: Method 'Dispose()' is missing XML documentation.
|
|
- LINE: 173 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: DocumentId | MESSAGE: Property 'DocumentId' is missing XML documentation
|
|
- LINE: 174 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: NewValue | MESSAGE: Property 'NewValue' is missing XML documentation
|
|
- LINE: 175 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PageId | MESSAGE: Property 'PageId' is missing XML documentation
|
|
- LINE: 176 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Type | MESSAGE: Property 'Type' is missing XML documentation
|
|
- LINE: 178 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: WriteOperation(ObjectId documentId, ReadOnlyMemory<byte> newValue, uint pageId, OperationType type) | MESSAGE: Constructor 'WriteOperation(ObjectId documentId, ReadOnlyMemory<byte> newValue, uint pageId, OperationType type)' is missing XML documentation.
|
|
- LINE: 187 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: WriteOperation(ObjectId documentId, byte[] newValue, uint pageId, OperationType type) | MESSAGE: Constructor 'WriteOperation(ObjectId documentId, byte[] newValue, uint pageId, OperationType type)' is missing XML documentation.
|
|
|
|
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Collections.cs
|
|
File issues: 14 (Errors: 13, Warnings: 1)
|
|
|
|
- LINE: 12 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Name | MESSAGE: Property 'Name' is missing XML documentation
|
|
- LINE: 13 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PrimaryRootPageId | MESSAGE: Property 'PrimaryRootPageId' is missing XML documentation
|
|
- LINE: 14 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: SchemaRootPageId | MESSAGE: Property 'SchemaRootPageId' is missing XML documentation
|
|
- LINE: 15 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Indexes | MESSAGE: Property 'Indexes' is missing XML documentation
|
|
- LINE: 20 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Name | MESSAGE: Property 'Name' is missing XML documentation
|
|
- LINE: 21 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsUnique | MESSAGE: Property 'IsUnique' is missing XML documentation
|
|
- LINE: 22 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Type | MESSAGE: Property 'Type' is missing XML documentation
|
|
- LINE: 23 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PropertyPaths | MESSAGE: Property 'PropertyPaths' is missing XML documentation
|
|
- LINE: 24 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Dimensions | MESSAGE: Property 'Dimensions' is missing XML documentation
|
|
- LINE: 25 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Metric | MESSAGE: Property 'Metric' is missing XML documentation
|
|
- LINE: 26 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: RootPageId | MESSAGE: Property 'RootPageId' is missing XML documentation
|
|
- LINE: 31 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetCollectionMetadata(string name) | MESSAGE: Method 'GetCollectionMetadata(string name)' is missing XML documentation.
|
|
- LINE: 99 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: SaveCollectionMetadata(CollectionMetadata metadata) | MESSAGE: Method 'SaveCollectionMetadata(CollectionMetadata metadata)' is missing XML documentation.
|
|
- LINE: 206 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: RegisterMappers(IEnumerable<IDocumentMapper> mappers) | MESSAGE: Method 'RegisterMappers(IEnumerable<IDocumentMapper> mappers)' is missing <param name="mappers"> documentation.
|
|
|
|
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/SpatialPage.cs
|
|
File issues: 11 (Errors: 11, Warnings: 0)
|
|
|
|
- LINE: 32 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Initialize(Span<byte> page, uint pageId, bool isLeaf, byte level) | MESSAGE: Method 'Initialize(Span<byte> page, uint pageId, bool isLeaf, byte level)' is missing XML documentation.
|
|
- LINE: 50 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetIsLeaf(ReadOnlySpan<byte> page) | MESSAGE: Method 'GetIsLeaf(ReadOnlySpan<byte> page)' is missing XML documentation.
|
|
- LINE: 51 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetLevel(ReadOnlySpan<byte> page) | MESSAGE: Method 'GetLevel(ReadOnlySpan<byte> page)' is missing XML documentation.
|
|
- LINE: 52 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetEntryCount(ReadOnlySpan<byte> page) | MESSAGE: Method 'GetEntryCount(ReadOnlySpan<byte> page)' is missing XML documentation.
|
|
- LINE: 53 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: SetEntryCount(Span<byte> page, ushort count) | MESSAGE: Method 'SetEntryCount(Span<byte> page, ushort count)' is missing XML documentation.
|
|
- LINE: 55 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetParentPageId(ReadOnlySpan<byte> page) | MESSAGE: Method 'GetParentPageId(ReadOnlySpan<byte> page)' is missing XML documentation.
|
|
- LINE: 56 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: SetParentPageId(Span<byte> page, uint parentId) | MESSAGE: Method 'SetParentPageId(Span<byte> page, uint parentId)' is missing XML documentation.
|
|
- LINE: 58 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetMaxEntries(int pageSize) | MESSAGE: Method 'GetMaxEntries(int pageSize)' is missing XML documentation.
|
|
- LINE: 60 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteEntry(Span<byte> page, int index, GeoBox mbr, DocumentLocation pointer) | MESSAGE: Method 'WriteEntry(Span<byte> page, int index, GeoBox mbr, DocumentLocation pointer)' is missing XML documentation.
|
|
- LINE: 76 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ReadEntry(ReadOnlySpan<byte> page, int index, GeoBox mbr, DocumentLocation pointer) | MESSAGE: Method 'ReadEntry(ReadOnlySpan<byte> page, int index, GeoBox mbr, DocumentLocation pointer)' is missing XML documentation.
|
|
- LINE: 86 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CalculateMBR(ReadOnlySpan<byte> page) | MESSAGE: Method 'CalculateMBR(ReadOnlySpan<byte> page)' is missing XML documentation.
|
|
|
|
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/CDC/ChangeStreamDispatcher.cs
|
|
File issues: 8 (Errors: 8, Warnings: 0)
|
|
|
|
- LINE: 17 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: ChangeStreamDispatcher() | MESSAGE: Constructor 'ChangeStreamDispatcher()' is missing XML documentation.
|
|
- LINE: 28 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Publish(InternalChangeEvent change) | MESSAGE: Method 'Publish(InternalChangeEvent change)' is missing XML documentation.
|
|
- LINE: 33 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: HasPayloadWatchers(string collectionName) | MESSAGE: Method 'HasPayloadWatchers(string collectionName)' is missing XML documentation.
|
|
- LINE: 38 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: HasAnyWatchers(string collectionName) | MESSAGE: Method 'HasAnyWatchers(string collectionName)' is missing XML documentation.
|
|
- LINE: 43 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Subscribe(string collectionName, bool capturePayload, ChannelWriter<InternalChangeEvent> writer) | MESSAGE: Method 'Subscribe(string collectionName, bool capturePayload, ChannelWriter<InternalChangeEvent> writer)' is missing XML documentation.
|
|
- LINE: 98 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Dispose() | MESSAGE: Method 'Dispose()' is missing XML documentation.
|
|
- LINE: 109 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: Subscription(Action onDispose) | MESSAGE: Constructor 'Subscription(Action onDispose)' is missing XML documentation.
|
|
- LINE: 114 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Dispose() | MESSAGE: Method 'Dispose()' is missing XML documentation.
|
|
|
|
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/DocumentCollection.cs
|
|
File issues: 31 (Errors: 7, Warnings: 24)
|
|
|
|
- LINE: 25 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: DocumentCollection(StorageEngine storage, ITransactionHolder transactionHolder, IDocumentMapper<T> mapper, string? collectionName) | MESSAGE: Constructor 'DocumentCollection(StorageEngine storage, ITransactionHolder transactionHolder, IDocumentMapper<T> mapper, string? collectionName)' is missing XML documentation.
|
|
- LINE: 54 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: CurrentSchemaVersion | MESSAGE: Property 'CurrentSchemaVersion' is missing XML documentation
|
|
- LINE: 61 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: DocumentCollection(StorageEngine storage, ITransactionHolder transactionHolder, IDocumentMapper<TId, T> mapper, string? collectionName) | MESSAGE: Constructor 'DocumentCollection(StorageEngine storage, ITransactionHolder transactionHolder, IDocumentMapper<TId, T> mapper, string? collectionName)' is missing XML documentation.
|
|
- LINE: 169 | CATEGORY: MissingTypeParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name) | MESSAGE: Method 'CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name)' is missing <typeparam name="TKey"> documentation.
|
|
- LINE: 169 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name) | MESSAGE: Method 'CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name)' is missing <param name="name"> documentation.
|
|
- LINE: 169 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name) | MESSAGE: Method 'CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name)' is missing <param name="metric"> documentation.
|
|
- LINE: 169 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name) | MESSAGE: Method 'CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name)' is missing <param name="dimensions"> documentation.
|
|
- LINE: 169 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name) | MESSAGE: Method 'CreateVectorIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name)' is missing <param name="keySelector"> documentation.
|
|
- LINE: 191 | CATEGORY: MissingTypeParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: EnsureIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, string? name, bool unique) | MESSAGE: Method 'EnsureIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, string? name, bool unique)' is missing <typeparam name="TKey"> documentation.
|
|
- LINE: 191 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: EnsureIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, string? name, bool unique) | MESSAGE: Method 'EnsureIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, string? name, bool unique)' is missing <param name="unique"> documentation.
|
|
- LINE: 191 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: EnsureIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, string? name, bool unique) | MESSAGE: Method 'EnsureIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, string? name, bool unique)' is missing <param name="name"> documentation.
|
|
- LINE: 191 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: EnsureIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, string? name, bool unique) | MESSAGE: Method 'EnsureIndex(System.Linq.Expressions.Expression<Func<T, TKey>> keySelector, string? name, bool unique)' is missing <param name="keySelector"> documentation.
|
|
- LINE: 240 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ApplyIndexBuilder(Metadata.IndexBuilder<T> builder) | MESSAGE: Method 'ApplyIndexBuilder(Metadata.IndexBuilder<T> builder)' is missing XML documentation.
|
|
- LINE: 380 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: GetIndex(string name) | MESSAGE: Method 'GetIndex(string name)' is missing <param name="name"> documentation.
|
|
- LINE: 389 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: QueryIndex(string indexName, object? minKey, object? maxKey, bool ascending) | MESSAGE: Method 'QueryIndex(string indexName, object? minKey, object? maxKey, bool ascending)' is missing <param name="ascending"> documentation.
|
|
- LINE: 389 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: QueryIndex(string indexName, object? minKey, object? maxKey, bool ascending) | MESSAGE: Method 'QueryIndex(string indexName, object? minKey, object? maxKey, bool ascending)' is missing <param name="maxKey"> documentation.
|
|
- LINE: 389 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: QueryIndex(string indexName, object? minKey, object? maxKey, bool ascending) | MESSAGE: Method 'QueryIndex(string indexName, object? minKey, object? maxKey, bool ascending)' is missing <param name="minKey"> documentation.
|
|
- LINE: 389 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: QueryIndex(string indexName, object? minKey, object? maxKey, bool ascending) | MESSAGE: Method 'QueryIndex(string indexName, object? minKey, object? maxKey, bool ascending)' is missing <param name="indexName"> documentation.
|
|
- LINE: 837 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: InsertAsync(T entity) | MESSAGE: Method 'InsertAsync(T entity)' is missing <param name="entity"> documentation.
|
|
- LINE: 904 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: InsertBulkAsync(IEnumerable<T> entities) | MESSAGE: Method 'InsertBulkAsync(IEnumerable<T> entities)' is missing <param name="entities"> documentation.
|
|
- LINE: 1085 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FindByLocation(DocumentLocation location) | MESSAGE: Method 'FindByLocation(DocumentLocation location)' is missing XML documentation.
|
|
- LINE: 1175 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Update(T entity) | MESSAGE: Method 'Update(T entity)' is missing <param name="entity"> documentation.
|
|
- LINE: 1203 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: UpdateAsync(T entity) | MESSAGE: Method 'UpdateAsync(T entity)' is missing <param name="entity"> documentation.
|
|
- LINE: 1219 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: UpdateBulk(IEnumerable<T> entities) | MESSAGE: Method 'UpdateBulk(IEnumerable<T> entities)' is missing XML documentation.
|
|
- LINE: 1241 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: UpdateBulkAsync(IEnumerable<T> entities) | MESSAGE: Method 'UpdateBulkAsync(IEnumerable<T> entities)' is missing <param name="entities"> documentation.
|
|
- LINE: 1399 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Delete(TId id) | MESSAGE: Method 'Delete(TId id)' is missing XML documentation.
|
|
- LINE: 1416 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: DeleteAsync(TId id) | MESSAGE: Method 'DeleteAsync(TId id)' is missing <param name="id"> documentation.
|
|
- LINE: 1434 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: DeleteBulk(IEnumerable<TId> ids) | MESSAGE: Method 'DeleteBulk(IEnumerable<TId> ids)' is missing <param name="ids"> documentation.
|
|
- LINE: 1454 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: DeleteBulkAsync(IEnumerable<TId> ids) | MESSAGE: Method 'DeleteBulkAsync(IEnumerable<TId> ids)' is missing <param name="ids"> documentation.
|
|
- LINE: 1582 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: FindAll(Func<T, bool> predicate) | MESSAGE: Method 'FindAll(Func<T, bool> predicate)' is missing <param name="predicate"> documentation.
|
|
- LINE: 1594 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Find(Func<T, bool> predicate) | MESSAGE: Method 'Find(Func<T, bool> predicate)' is missing <param name="predicate"> documentation.
|
|
|
|
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/VectorSearchIndex.cs
|
|
File issues: 4 (Errors: 4, Warnings: 0)
|
|
|
|
- LINE: 25 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: VectorSearchIndex(StorageEngine storage, IndexOptions options, uint rootPageId) | MESSAGE: Constructor 'VectorSearchIndex(StorageEngine storage, IndexOptions options, uint rootPageId)' is missing XML documentation.
|
|
- LINE: 32 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: RootPageId | MESSAGE: Property 'RootPageId' is missing XML documentation
|
|
- LINE: 34 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Insert(float[] vector, DocumentLocation docLocation, ITransaction? transaction) | MESSAGE: Method 'Insert(float[] vector, DocumentLocation docLocation, ITransaction? transaction)' is missing XML documentation.
|
|
- LINE: 261 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Search(float[] query, int k, int efSearch, ITransaction? transaction) | MESSAGE: Method 'Search(float[] query, int k, int efSearch, ITransaction? transaction)' is missing XML documentation.
|
|
|
|
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Metadata/ModelBuilder.cs
|
|
File issues: 2 (Errors: 2, Warnings: 0)
|
|
|
|
- LINE: 10 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Entity() | MESSAGE: Method 'Entity()' is missing XML documentation.
|
|
- LINE: 20 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetEntityBuilders() | MESSAGE: Method 'GetEntityBuilders()' is missing XML documentation.
|
|
|
|
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/DictionaryPage.cs
|
|
File issues: 17 (Errors: 0, Warnings: 17)
|
|
|
|
- LINE: 35 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Initialize(Span<byte> page, uint pageId) | MESSAGE: Method 'Initialize(Span<byte> page, uint pageId)' is missing <param name="pageId"> documentation.
|
|
- LINE: 35 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Initialize(Span<byte> page, uint pageId) | MESSAGE: Method 'Initialize(Span<byte> page, uint pageId)' is missing <param name="page"> documentation.
|
|
- LINE: 58 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Insert(Span<byte> page, string key, ushort value) | MESSAGE: Method 'Insert(Span<byte> page, string key, ushort value)' is missing <param name="value"> documentation.
|
|
- LINE: 58 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Insert(Span<byte> page, string key, ushort value) | MESSAGE: Method 'Insert(Span<byte> page, string key, ushort value)' is missing <param name="key"> documentation.
|
|
- LINE: 58 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: Insert(Span<byte> page, string key, ushort value) | MESSAGE: Method 'Insert(Span<byte> page, string key, ushort value)' is missing <param name="page"> documentation.
|
|
- LINE: 115 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFind(ReadOnlySpan<byte> page, ReadOnlySpan<byte> keyBytes, ushort value) | MESSAGE: Method 'TryFind(ReadOnlySpan<byte> page, ReadOnlySpan<byte> keyBytes, ushort value)' is missing <param name="value"> documentation.
|
|
- LINE: 115 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFind(ReadOnlySpan<byte> page, ReadOnlySpan<byte> keyBytes, ushort value) | MESSAGE: Method 'TryFind(ReadOnlySpan<byte> page, ReadOnlySpan<byte> keyBytes, ushort value)' is missing <param name="keyBytes"> documentation.
|
|
- LINE: 115 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFind(ReadOnlySpan<byte> page, ReadOnlySpan<byte> keyBytes, ushort value) | MESSAGE: Method 'TryFind(ReadOnlySpan<byte> page, ReadOnlySpan<byte> keyBytes, ushort value)' is missing <param name="page"> documentation.
|
|
- LINE: 154 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId) | MESSAGE: Method 'TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId)' is missing <param name="transactionId"> documentation.
|
|
- LINE: 154 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId) | MESSAGE: Method 'TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId)' is missing <param name="value"> documentation.
|
|
- LINE: 154 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId) | MESSAGE: Method 'TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId)' is missing <param name="key"> documentation.
|
|
- LINE: 154 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId) | MESSAGE: Method 'TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId)' is missing <param name="startPageId"> documentation.
|
|
- LINE: 154 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId) | MESSAGE: Method 'TryFindGlobal(StorageEngine storage, uint startPageId, string key, ushort value, ulong? transactionId)' is missing <param name="storage"> documentation.
|
|
- LINE: 216 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: GetAll(ReadOnlySpan<byte> page) | MESSAGE: Method 'GetAll(ReadOnlySpan<byte> page)' is missing <param name="page"> documentation.
|
|
- LINE: 234 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: FindAllGlobal(StorageEngine storage, uint startPageId, ulong? transactionId) | MESSAGE: Method 'FindAllGlobal(StorageEngine storage, uint startPageId, ulong? transactionId)' is missing <param name="transactionId"> documentation.
|
|
- LINE: 234 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: FindAllGlobal(StorageEngine storage, uint startPageId, ulong? transactionId) | MESSAGE: Method 'FindAllGlobal(StorageEngine storage, uint startPageId, ulong? transactionId)' is missing <param name="startPageId"> documentation.
|
|
- LINE: 234 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: FindAllGlobal(StorageEngine storage, uint startPageId, ulong? transactionId) | MESSAGE: Method 'FindAllGlobal(StorageEngine storage, uint startPageId, ulong? transactionId)' is missing <param name="storage"> documentation.
|
|
|