Initialize CBDD solution and add a .NET-focused gitignore for generated artifacts.
This commit is contained in:
Joseph Doherty
108
.fixdocs_batches/batch_3.md
Normal file
108
.fixdocs_batches/batch_3.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# FixDocs Batch 3
|
||||
|
||||
Total issues: 68 (Errors: 63, Warnings: 5)
|
||||
|
||||
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/BaseMappers.cs
|
||||
File issues: 17 (Errors: 17, Warnings: 0)
|
||||
|
||||
- LINE: 16 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: CollectionName | MESSAGE: Property 'CollectionName' is missing XML documentation
|
||||
- LINE: 17 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Serialize(T entity, BsonSpanWriter writer) | MESSAGE: Method 'Serialize(T entity, BsonSpanWriter writer)' is missing XML documentation.
|
||||
- LINE: 18 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Deserialize(BsonSpanReader reader) | MESSAGE: Method 'Deserialize(BsonSpanReader reader)' is missing XML documentation.
|
||||
- LINE: 19 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetId(T entity) | MESSAGE: Method 'GetId(T entity)' is missing XML documentation.
|
||||
- LINE: 20 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: SetId(T entity, TId id) | MESSAGE: Method 'SetId(T entity, TId id)' is missing XML documentation.
|
||||
- LINE: 22 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToIndexKey(TId id) | MESSAGE: Method 'ToIndexKey(TId id)' is missing XML documentation.
|
||||
- LINE: 23 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FromIndexKey(IndexKey key) | MESSAGE: Method 'FromIndexKey(IndexKey key)' is missing XML documentation.
|
||||
- LINE: 25 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: UsedKeys | MESSAGE: Property 'UsedKeys' is missing XML documentation
|
||||
- LINE: 26 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetSchema() | MESSAGE: Method 'GetSchema()' is missing XML documentation.
|
||||
- LINE: 34 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToIndexKey(ObjectId id) | MESSAGE: Method 'ToIndexKey(ObjectId id)' is missing XML documentation.
|
||||
- LINE: 35 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FromIndexKey(IndexKey key) | MESSAGE: Method 'FromIndexKey(IndexKey key)' is missing XML documentation.
|
||||
- LINE: 43 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToIndexKey(int id) | MESSAGE: Method 'ToIndexKey(int id)' is missing XML documentation.
|
||||
- LINE: 44 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FromIndexKey(IndexKey key) | MESSAGE: Method 'FromIndexKey(IndexKey key)' is missing XML documentation.
|
||||
- LINE: 52 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToIndexKey(string id) | MESSAGE: Method 'ToIndexKey(string id)' is missing XML documentation.
|
||||
- LINE: 53 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FromIndexKey(IndexKey key) | MESSAGE: Method 'FromIndexKey(IndexKey key)' is missing XML documentation.
|
||||
- LINE: 61 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToIndexKey(Guid id) | MESSAGE: Method 'ToIndexKey(Guid id)' is missing XML documentation.
|
||||
- LINE: 62 | 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/Indexing/IndexOptions.cs
|
||||
File issues: 12 (Errors: 12, Warnings: 0)
|
||||
|
||||
- LINE: 45 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Type | MESSAGE: Property 'Type' is missing XML documentation
|
||||
- LINE: 46 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Unique | MESSAGE: Property 'Unique' is missing XML documentation
|
||||
- LINE: 47 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Fields | MESSAGE: Property 'Fields' is missing XML documentation
|
||||
- LINE: 50 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Dimensions | MESSAGE: Property 'Dimensions' is missing XML documentation
|
||||
- LINE: 51 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Metric | MESSAGE: Property 'Metric' is missing XML documentation
|
||||
- LINE: 52 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: M | MESSAGE: Property 'M' is missing XML documentation
|
||||
- LINE: 53 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: EfConstruction | MESSAGE: Property 'EfConstruction' is missing XML documentation
|
||||
- LINE: 55 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateBTree(string[] fields) | MESSAGE: Method 'CreateBTree(string[] fields)' is missing XML documentation.
|
||||
- LINE: 62 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateUnique(string[] fields) | MESSAGE: Method 'CreateUnique(string[] fields)' is missing XML documentation.
|
||||
- LINE: 69 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateHash(string[] fields) | MESSAGE: Method 'CreateHash(string[] fields)' is missing XML documentation.
|
||||
- LINE: 76 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateVector(int dimensions, VectorMetric metric, int m, int ef, string[] fields) | MESSAGE: Method 'CreateVector(int dimensions, VectorMetric metric, int m, int ef, string[] fields)' is missing XML documentation.
|
||||
- LINE: 87 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateSpatial(string[] fields) | MESSAGE: Method 'CreateSpatial(string[] fields)' is missing XML documentation.
|
||||
|
||||
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Bson/Schema/BsonSchema.cs
|
||||
File issues: 10 (Errors: 10, Warnings: 0)
|
||||
|
||||
- LINE: 5 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Title | MESSAGE: Property 'Title' is missing XML documentation
|
||||
- LINE: 6 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Version | MESSAGE: Property 'Version' is missing XML documentation
|
||||
- LINE: 7 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Fields | MESSAGE: Property 'Fields' is missing XML documentation
|
||||
- LINE: 9 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToBson(BsonSpanWriter writer) | MESSAGE: Method 'ToBson(BsonSpanWriter writer)' is missing XML documentation.
|
||||
- LINE: 26 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FromBson(BsonSpanReader reader) | MESSAGE: Method 'FromBson(BsonSpanReader reader)' is missing XML documentation.
|
||||
- LINE: 59 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetHash() | MESSAGE: Method 'GetHash()' is missing XML documentation.
|
||||
- LINE: 70 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Equals(BsonSchema? other) | MESSAGE: Method 'Equals(BsonSchema? other)' is missing XML documentation.
|
||||
- LINE: 76 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Equals(object? obj) | MESSAGE: Method 'Equals(object? obj)' is missing XML documentation.
|
||||
- LINE: 77 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetHashCode() | MESSAGE: Method 'GetHashCode()' is missing XML documentation.
|
||||
- LINE: 79 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetAllKeys() | MESSAGE: Method 'GetAllKeys()' is missing XML documentation.
|
||||
|
||||
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/CDC/ChangeStreamEvent.cs
|
||||
File issues: 9 (Errors: 9, Warnings: 0)
|
||||
|
||||
- LINE: 11 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Timestamp | MESSAGE: Property 'Timestamp' is missing XML documentation
|
||||
- LINE: 12 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: TransactionId | MESSAGE: Property 'TransactionId' is missing XML documentation
|
||||
- LINE: 13 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: CollectionName | MESSAGE: Property 'CollectionName' is missing XML documentation
|
||||
- LINE: 14 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Type | MESSAGE: Property 'Type' is missing XML documentation
|
||||
- LINE: 15 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: DocumentId | MESSAGE: Property 'DocumentId' is missing XML documentation
|
||||
- LINE: 28 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Timestamp | MESSAGE: Property 'Timestamp' is missing XML documentation
|
||||
- LINE: 29 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: TransactionId | MESSAGE: Property 'TransactionId' is missing XML documentation
|
||||
- LINE: 30 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: CollectionName | MESSAGE: Property 'CollectionName' is missing XML documentation
|
||||
- LINE: 31 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Type | MESSAGE: Property 'Type' is missing XML documentation
|
||||
|
||||
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BTreeQueryable.cs
|
||||
File issues: 7 (Errors: 7, Warnings: 0)
|
||||
|
||||
- LINE: 9 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: BTreeQueryable(IQueryProvider provider, Expression expression) | MESSAGE: Constructor 'BTreeQueryable(IQueryProvider provider, Expression expression)' is missing XML documentation.
|
||||
- LINE: 15 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: BTreeQueryable(IQueryProvider provider) | MESSAGE: Constructor 'BTreeQueryable(IQueryProvider provider)' is missing XML documentation.
|
||||
- LINE: 21 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: ElementType | MESSAGE: Property 'ElementType' is missing XML documentation
|
||||
- LINE: 22 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Expression | MESSAGE: Property 'Expression' is missing XML documentation
|
||||
- LINE: 23 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Provider | MESSAGE: Property 'Provider' is missing XML documentation
|
||||
- LINE: 25 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetEnumerator() | MESSAGE: Method 'GetEnumerator()' is missing XML documentation.
|
||||
- LINE: 30 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetEnumerator() | MESSAGE: Method 'GetEnumerator()' is missing XML documentation.
|
||||
|
||||
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/CDC/ChangeStreamObservable.cs
|
||||
File issues: 4 (Errors: 4, Warnings: 0)
|
||||
|
||||
- LINE: 21 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: ChangeStreamObservable(ChangeStreamDispatcher dispatcher, string collectionName, bool capturePayload, IDocumentMapper<TId, T> mapper, ConcurrentDictionary<ushort, string> keyReverseMap) | MESSAGE: Constructor 'ChangeStreamObservable(ChangeStreamDispatcher dispatcher, string collectionName, bool capturePayload, IDocumentMapper<TId, T> mapper, ConcurrentDictionary<ushort, string> keyReverseMap)' is missing XML documentation.
|
||||
- LINE: 35 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Subscribe(IObserver<ChangeStreamEvent<TId, T>> observer) | MESSAGE: Method 'Subscribe(IObserver<ChangeStreamEvent<TId, T>> observer)' is missing XML documentation.
|
||||
- LINE: 114 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: CompositeDisposable(IDisposable dispatcherSubscription, CancellationTokenSource cts, ChannelWriter<InternalChangeEvent> writer, Task bridgeTask) | MESSAGE: Constructor 'CompositeDisposable(IDisposable dispatcherSubscription, CancellationTokenSource cts, ChannelWriter<InternalChangeEvent> writer, Task bridgeTask)' is missing XML documentation.
|
||||
- LINE: 122 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Dispose() | MESSAGE: Method 'Dispose()' is missing XML documentation.
|
||||
|
||||
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.cs
|
||||
File issues: 5 (Errors: 3, Warnings: 2)
|
||||
|
||||
- LINE: 39 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: StorageEngine(string databasePath, PageFileConfig config) | MESSAGE: Constructor 'StorageEngine(string databasePath, PageFileConfig config)' is missing XML documentation.
|
||||
- LINE: 78 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: IsPageLocked(uint pageId, ulong excludingTxId) | MESSAGE: Method 'IsPageLocked(uint pageId, ulong excludingTxId)' is missing <param name="excludingTxId"> documentation.
|
||||
- LINE: 78 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: IsPageLocked(uint pageId, ulong excludingTxId) | MESSAGE: Method 'IsPageLocked(uint pageId, ulong excludingTxId)' is missing <param name="pageId"> documentation.
|
||||
- LINE: 117 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: RegisterCdc(CDC.ChangeStreamDispatcher cdc) | MESSAGE: Method 'RegisterCdc(CDC.ChangeStreamDispatcher cdc)' is missing XML documentation.
|
||||
- LINE: 122 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Cdc | MESSAGE: Property 'Cdc' is missing XML documentation
|
||||
|
||||
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/BsonExpressionEvaluator.cs
|
||||
File issues: 1 (Errors: 1, Warnings: 0)
|
||||
|
||||
- LINE: 8 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: TryCompile(LambdaExpression expression) | MESSAGE: Method 'TryCompile(LambdaExpression expression)' is missing XML documentation.
|
||||
|
||||
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/VectorSearchExtensions.cs
|
||||
File issues: 3 (Errors: 0, Warnings: 3)
|
||||
|
||||
- LINE: 22 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: VectorSearch(IEnumerable<float[]> vectors, float[] query, int k) | MESSAGE: Method 'VectorSearch(IEnumerable<float[]> vectors, float[] query, int k)' is missing <param name="k"> documentation.
|
||||
- LINE: 22 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: VectorSearch(IEnumerable<float[]> vectors, float[] query, int k) | MESSAGE: Method 'VectorSearch(IEnumerable<float[]> vectors, float[] query, int k)' is missing <param name="query"> documentation.
|
||||
- LINE: 22 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: VectorSearch(IEnumerable<float[]> vectors, float[] query, int k) | MESSAGE: Method 'VectorSearch(IEnumerable<float[]> vectors, float[] query, int k)' is missing <param name="vectors"> documentation.
|
||||
|
||||
Reference in New Issue
Block a user