dohertj2/CBDD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5528806518d8d923ad874d451007cb6b89bb5eec
CBDD/.fixdocs_batches/batch_5.md

119 lines
18 KiB
Markdown
Raw Blame History

# FixDocs Batch 5
Total issues: 78 (Errors: 62, Warnings: 16)
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Bson/BsonBufferWriter.cs
File issues: 16 (Errors: 16, Warnings: 0)
- LINE: 17 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: BsonBufferWriter(IBufferWriter<byte> writer) | MESSAGE: Constructor 'BsonBufferWriter(IBufferWriter<byte> writer)' is missing XML documentation.
- LINE: 23 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Position | MESSAGE: Property 'Position' is missing XML documentation
- LINE: 41 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteDateTime(string name, DateTime value) | MESSAGE: Method 'WriteDateTime(string name, DateTime value)' is missing XML documentation.
- LINE: 51 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: BeginDocument() | MESSAGE: Method 'BeginDocument()' is missing XML documentation.
- LINE: 63 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: EndDocument(int sizePosition) | MESSAGE: Method 'EndDocument(int sizePosition)' is missing XML documentation.
- LINE: 72 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: BeginDocument(string name) | MESSAGE: Method 'BeginDocument(string name)' is missing XML documentation.
- LINE: 79 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: BeginArray(string name) | MESSAGE: Method 'BeginArray(string name)' is missing XML documentation.
- LINE: 86 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: EndArray(int sizePosition) | MESSAGE: Method 'EndArray(int sizePosition)' is missing XML documentation.
- LINE: 109 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteObjectId(string name, ObjectId value) | MESSAGE: Method 'WriteObjectId(string name, ObjectId value)' is missing XML documentation.
- LINE: 116 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteString(string name, string value) | MESSAGE: Method 'WriteString(string name, string value)' is missing XML documentation.
- LINE: 123 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteBoolean(string name, bool value) | MESSAGE: Method 'WriteBoolean(string name, bool value)' is missing XML documentation.
- LINE: 130 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteNull(string name) | MESSAGE: Method 'WriteNull(string name)' is missing XML documentation.
- LINE: 153 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteBinary(string name, ReadOnlySpan<byte> data) | MESSAGE: Method 'WriteBinary(string name, ReadOnlySpan<byte> data)' is missing XML documentation.
- LINE: 162 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteInt64(string name, long value) | MESSAGE: Method 'WriteInt64(string name, long value)' is missing XML documentation.
- LINE: 169 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteDouble(string name, double value) | MESSAGE: Method 'WriteDouble(string name, double value)' is missing XML documentation.
- LINE: 183 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteInt32(string name, int value) | MESSAGE: Method 'WriteInt32(string name, int value)' is missing XML documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Transactions/WriteAheadLog.cs
File issues: 18 (Errors: 12, Warnings: 6)
- LINE: 26 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: WriteAheadLog(string walPath) | MESSAGE: Constructor 'WriteAheadLog(string walPath)' is missing XML documentation.
- LINE: 43 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteBeginRecord(ulong transactionId) | MESSAGE: Method 'WriteBeginRecord(ulong transactionId)' is missing <param name="transactionId"> documentation.
- LINE: 56 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteBeginRecordAsync(ulong transactionId, CancellationToken ct) | MESSAGE: Method 'WriteBeginRecordAsync(ulong transactionId, CancellationToken ct)' is missing XML documentation.
- LINE: 99 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteCommitRecord(ulong transactionId) | MESSAGE: Method 'WriteCommitRecord(ulong transactionId)' is missing <param name="transactionId"> documentation.
- LINE: 112 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteCommitRecordAsync(ulong transactionId, CancellationToken ct) | MESSAGE: Method 'WriteCommitRecordAsync(ulong transactionId, CancellationToken ct)' is missing XML documentation.
- LINE: 154 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteAbortRecord(ulong transactionId) | MESSAGE: Method 'WriteAbortRecord(ulong transactionId)' is missing <param name="transactionId"> documentation.
- LINE: 167 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteAbortRecordAsync(ulong transactionId, CancellationToken ct) | MESSAGE: Method 'WriteAbortRecordAsync(ulong transactionId, CancellationToken ct)' is missing XML documentation.
- LINE: 209 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteDataRecord(ulong transactionId, uint pageId, ReadOnlySpan<byte> afterImage) | MESSAGE: Method 'WriteDataRecord(ulong transactionId, uint pageId, ReadOnlySpan<byte> afterImage)' is missing <param name="afterImage"> documentation.
- LINE: 209 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteDataRecord(ulong transactionId, uint pageId, ReadOnlySpan<byte> afterImage) | MESSAGE: Method 'WriteDataRecord(ulong transactionId, uint pageId, ReadOnlySpan<byte> afterImage)' is missing <param name="pageId"> documentation.
- LINE: 209 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteDataRecord(ulong transactionId, uint pageId, ReadOnlySpan<byte> afterImage) | MESSAGE: Method 'WriteDataRecord(ulong transactionId, uint pageId, ReadOnlySpan<byte> afterImage)' is missing <param name="transactionId"> documentation.
- LINE: 222 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteDataRecordAsync(ulong transactionId, uint pageId, ReadOnlyMemory<byte> afterImage, CancellationToken ct) | MESSAGE: Method 'WriteDataRecordAsync(ulong transactionId, uint pageId, ReadOnlyMemory<byte> afterImage, CancellationToken ct)' is missing XML documentation.
- LINE: 297 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FlushAsync(CancellationToken ct) | MESSAGE: Method 'FlushAsync(CancellationToken ct)' is missing XML documentation.
- LINE: 478 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Dispose() | MESSAGE: Method 'Dispose()' is missing XML documentation.
- LINE: 505 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Type | MESSAGE: Property 'Type' is missing XML documentation
- LINE: 506 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: TransactionId | MESSAGE: Property 'TransactionId' is missing XML documentation
- LINE: 507 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Timestamp | MESSAGE: Property 'Timestamp' is missing XML documentation
- LINE: 508 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PageId | MESSAGE: Property 'PageId' is missing XML documentation
- LINE: 509 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: AfterImage | MESSAGE: Property 'AfterImage' is missing XML documentation
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionIndexManager.cs
File issues: 13 (Errors: 10, Warnings: 3)
- LINE: 27 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: CollectionIndexManager(StorageEngine storage, IDocumentMapper<TId, T> mapper, string? collectionName) | MESSAGE: Constructor 'CollectionIndexManager(StorageEngine storage, IDocumentMapper<TId, T> mapper, string? collectionName)' is missing XML documentation.
- LINE: 135 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateVectorIndex(Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name) | MESSAGE: Method 'CreateVectorIndex(Expression<Func<T, TKey>> keySelector, int dimensions, VectorMetric metric, string? name)' is missing XML documentation.
- LINE: 154 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: EnsureIndex(Expression<Func<T, object>> keySelector, string? name, bool unique) | MESSAGE: Method 'EnsureIndex(Expression<Func<T, object>> keySelector, string? name, bool unique)' is missing XML documentation.
- LINE: 171 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: EnsureIndexUntyped(LambdaExpression keySelector, string? name, bool unique) | MESSAGE: Method 'EnsureIndexUntyped(LambdaExpression keySelector, string? name, bool unique)' is missing XML documentation.
- LINE: 188 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateVectorIndexUntyped(LambdaExpression keySelector, int dimensions, VectorMetric metric, string? name) | MESSAGE: Method 'CreateVectorIndexUntyped(LambdaExpression keySelector, int dimensions, VectorMetric metric, string? name)' is missing XML documentation.
- LINE: 215 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateSpatialIndexUntyped(LambdaExpression keySelector, string? name) | MESSAGE: Method 'CreateSpatialIndexUntyped(LambdaExpression keySelector, string? name)' is missing XML documentation.
- LINE: 270 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: GetIndex(string name) | MESSAGE: Method 'GetIndex(string name)' is missing <param name="name"> documentation.
- LINE: 332 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: FindBestCompoundIndex(string[] propertyPaths) | MESSAGE: Method 'FindBestCompoundIndex(string[] propertyPaths)' is missing <param name="propertyPaths"> documentation.
- LINE: 447 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PrimaryRootPageId | MESSAGE: Property 'PrimaryRootPageId' is missing XML documentation
- LINE: 449 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: SetPrimaryRootPageId(uint pageId) | MESSAGE: Method 'SetPrimaryRootPageId(uint pageId)' is missing XML documentation.
- LINE: 461 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetMetadata() | MESSAGE: Method 'GetMetadata()' is missing XML documentation.
- LINE: 469 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Dispose() | MESSAGE: Method 'Dispose()' is missing XML documentation.
- LINE: 500 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ExtractPropertyPaths(LambdaExpression expression) | MESSAGE: Method 'ExtractPropertyPaths(LambdaExpression expression)' is missing <param name="expression"> documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/CollectionIndexDefinition.cs
File issues: 13 (Errors: 9, Warnings: 4)
- LINE: 66 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Constructor | SIGNATURE: CollectionIndexDefinition(string name, string[] propertyPaths, Expression<Func<T, object>> keySelectorExpression, bool isUnique, IndexType type, bool isPrimary, int dimensions, VectorMetric metric) | MESSAGE: Constructor 'CollectionIndexDefinition(string name, string[] propertyPaths, Expression<Func<T, object>> keySelectorExpression, bool isUnique, IndexType type, bool isPrimary, int dimensions, VectorMetric metric)' is missing <param name="metric"> documentation.
- LINE: 66 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Constructor | SIGNATURE: CollectionIndexDefinition(string name, string[] propertyPaths, Expression<Func<T, object>> keySelectorExpression, bool isUnique, IndexType type, bool isPrimary, int dimensions, VectorMetric metric) | MESSAGE: Constructor 'CollectionIndexDefinition(string name, string[] propertyPaths, Expression<Func<T, object>> keySelectorExpression, bool isUnique, IndexType type, bool isPrimary, int dimensions, VectorMetric metric)' is missing <param name="dimensions"> documentation.
- LINE: 111 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: CanSupportQuery(string propertyPath) | MESSAGE: Method 'CanSupportQuery(string propertyPath)' is missing <param name="propertyPath"> documentation.
- LINE: 125 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: CanSupportCompoundQuery(string[] propertyPaths) | MESSAGE: Method 'CanSupportCompoundQuery(string[] propertyPaths)' is missing <param name="propertyPaths"> documentation.
- LINE: 144 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToString() | MESSAGE: Method 'ToString()' is missing XML documentation.
- LINE: 157 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Name | MESSAGE: Property 'Name' is missing XML documentation
- LINE: 158 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PropertyPaths | MESSAGE: Property 'PropertyPaths' is missing XML documentation
- LINE: 159 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsUnique | MESSAGE: Property 'IsUnique' is missing XML documentation
- LINE: 160 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Type | MESSAGE: Property 'Type' is missing XML documentation
- LINE: 161 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsPrimary | MESSAGE: Property 'IsPrimary' is missing XML documentation
- LINE: 162 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: EstimatedDocumentCount | MESSAGE: Property 'EstimatedDocumentCount' is missing XML documentation
- LINE: 163 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: EstimatedSizeBytes | MESSAGE: Property 'EstimatedSizeBytes' is missing XML documentation
- LINE: 165 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToString() | MESSAGE: Method 'ToString()' is missing XML documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Bson/ObjectId.cs
File issues: 7 (Errors: 6, Warnings: 1)
- LINE: 26 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: ObjectId(ReadOnlySpan<byte> bytes) | MESSAGE: Constructor 'ObjectId(ReadOnlySpan<byte> bytes)' is missing XML documentation.
- LINE: 35 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: ObjectId(int timestamp, long randomAndCounter) | MESSAGE: Constructor 'ObjectId(int timestamp, long randomAndCounter)' is missing XML documentation.
- LINE: 54 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteTo(Span<byte> destination) | MESSAGE: Method 'WriteTo(Span<byte> destination)' is missing <param name="destination"> documentation.
- LINE: 78 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Equals(ObjectId other) | MESSAGE: Method 'Equals(ObjectId other)' is missing XML documentation.
- LINE: 81 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Equals(object? obj) | MESSAGE: Method 'Equals(object? obj)' is missing XML documentation.
- LINE: 83 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetHashCode() | MESSAGE: Method 'GetHashCode()' is missing XML documentation.
- LINE: 88 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToString() | MESSAGE: Method 'ToString()' is missing XML documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.SourceGenerators/Models/DbContextInfo.cs
File issues: 5 (Errors: 5, Warnings: 0)
- LINE: 7 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: ClassName | MESSAGE: Property 'ClassName' is missing XML documentation
- LINE: 8 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Namespace | MESSAGE: Property 'Namespace' is missing XML documentation
- LINE: 9 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: FilePath | MESSAGE: Property 'FilePath' is missing XML documentation
- LINE: 10 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Entities | MESSAGE: Property 'Entities' is missing XML documentation
- LINE: 11 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: GlobalNestedTypes | MESSAGE: Property 'GlobalNestedTypes' is missing XML documentation
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/EnumerableRewriter.cs
File issues: 3 (Errors: 3, Warnings: 0)
- LINE: 14 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Constructor | SIGNATURE: EnumerableRewriter(IQueryable source, object target) | MESSAGE: Constructor 'EnumerableRewriter(IQueryable source, object target)' is missing XML documentation.
- LINE: 20 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: VisitConstant(ConstantExpression node) | MESSAGE: Method 'VisitConstant(ConstantExpression node)' is missing XML documentation.
- LINE: 30 | 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.SourceGenerators/EntityAnalyzer.cs
File issues: 1 (Errors: 1, Warnings: 0)
- LINE: 12 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Analyze(INamedTypeSymbol entityType, SemanticModel semanticModel) | MESSAGE: Method 'Analyze(INamedTypeSymbol entityType, SemanticModel semanticModel)' is missing XML documentation.
## FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/PageHeader.cs
File issues: 2 (Errors: 0, Warnings: 2)
- LINE: 55 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: WriteTo(Span<byte> destination) | MESSAGE: Method 'WriteTo(Span<byte> destination)' is missing <param name="destination"> documentation.
- LINE: 66 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ReadFrom(ReadOnlySpan<byte> source) | MESSAGE: Method 'ReadFrom(ReadOnlySpan<byte> source)' is missing <param name="source"> documentation.
Reference in New Issue View Git Blame Copy Permalink