FixDocs Batch 8

Total issues: 67 (Errors: 63, Warnings: 4)

FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Indexing/BTreeStructures.cs

File issues: 14 (Errors: 14, Warnings: 0)

LINE: 13 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Key | MESSAGE: Property 'Key' is missing XML documentation
LINE: 14 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Location | MESSAGE: Property 'Location' is missing XML documentation
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.
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.
LINE: 32 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CompareTo(IndexEntry other) | MESSAGE: Method 'CompareTo(IndexEntry other)' is missing XML documentation.
LINE: 37 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CompareTo(object? obj) | MESSAGE: Method 'CompareTo(object? obj)' is missing XML documentation.
LINE: 50 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PageId | MESSAGE: Property 'PageId' is missing XML documentation
LINE: 51 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsLeaf | MESSAGE: Property 'IsLeaf' is missing XML documentation
LINE: 52 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: EntryCount | MESSAGE: Property 'EntryCount' is missing XML documentation
LINE: 53 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: ParentPageId | MESSAGE: Property 'ParentPageId' is missing XML documentation
LINE: 54 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: NextLeafPageId | MESSAGE: Property 'NextLeafPageId' is missing XML documentation
LINE: 55 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: PrevLeafPageId | MESSAGE: Property 'PrevLeafPageId' is missing XML documentation
LINE: 57 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: WriteTo(Span destination) | MESSAGE: Method 'WriteTo(Span destination)' is missing XML documentation.
LINE: 70 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ReadFrom(ReadOnlySpan source) | MESSAGE: Method 'ReadFrom(ReadOnlySpan source)' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Query/IndexOptimizer.cs

File issues: 14 (Errors: 14, Warnings: 0)

LINE: 10 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IndexName | MESSAGE: Property 'IndexName' is missing XML documentation
LINE: 11 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: MinValue | MESSAGE: Property 'MinValue' is missing XML documentation
LINE: 12 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: MaxValue | MESSAGE: Property 'MaxValue' is missing XML documentation
LINE: 13 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsRange | MESSAGE: Property 'IsRange' is missing XML documentation
LINE: 14 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsVectorSearch | MESSAGE: Property 'IsVectorSearch' is missing XML documentation
LINE: 15 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: VectorQuery | MESSAGE: Property 'VectorQuery' is missing XML documentation
LINE: 16 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: K | MESSAGE: Property 'K' is missing XML documentation
LINE: 18 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsSpatialSearch | MESSAGE: Property 'IsSpatialSearch' is missing XML documentation
LINE: 19 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: SpatialPoint | MESSAGE: Property 'SpatialPoint' is missing XML documentation
LINE: 20 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: RadiusKm | MESSAGE: Property 'RadiusKm' is missing XML documentation
LINE: 21 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: SpatialMin | MESSAGE: Property 'SpatialMin' is missing XML documentation
LINE: 22 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: SpatialMax | MESSAGE: Property 'SpatialMax' is missing XML documentation
LINE: 23 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: SpatialType | MESSAGE: Property 'SpatialType' is missing XML documentation
LINE: 28 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: TryOptimize(QueryModel model, IEnumerable indexes) | MESSAGE: Method 'TryOptimize(QueryModel model, IEnumerable indexes)' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Bson/Schema/BsonField.cs

File issues: 11 (Errors: 11, Warnings: 0)

LINE: 5 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Name | MESSAGE: Property 'Name' is missing XML documentation
LINE: 6 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Type | MESSAGE: Property 'Type' is missing XML documentation
LINE: 7 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: IsNullable | MESSAGE: Property 'IsNullable' is missing XML documentation
LINE: 8 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: NestedSchema | MESSAGE: Property 'NestedSchema' is missing XML documentation
LINE: 9 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: ArrayItemType | MESSAGE: Property 'ArrayItemType' is missing XML documentation
LINE: 11 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToBson(BsonSpanWriter writer) | MESSAGE: Method 'ToBson(BsonSpanWriter writer)' is missing XML documentation.
LINE: 32 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: FromBson(BsonSpanReader reader) | MESSAGE: Method 'FromBson(BsonSpanReader reader)' is missing XML documentation.
LINE: 69 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetHash() | MESSAGE: Method 'GetHash()' is missing XML documentation.
LINE: 80 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Equals(BsonField? other) | MESSAGE: Method 'Equals(BsonField? other)' is missing XML documentation.
LINE: 86 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Equals(object? obj) | MESSAGE: Method 'Equals(object? obj)' is missing XML documentation.
LINE: 87 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetHashCode() | MESSAGE: Method 'GetHashCode()' is missing XML documentation.

FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Collections/IDocumentMapper.cs

File issues: 9 (Errors: 9, Warnings: 0)

LINE: 15 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: CollectionName | MESSAGE: Property 'CollectionName' is missing XML documentation
LINE: 16 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: UsedKeys | MESSAGE: Property 'UsedKeys' is missing XML documentation
LINE: 17 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetSchema() | MESSAGE: Method 'GetSchema()' is missing XML documentation.
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.
LINE: 27 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Deserialize(BsonSpanReader reader) | MESSAGE: Method 'Deserialize(BsonSpanReader reader)' is missing XML documentation.
LINE: 29 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetId(T entity) | MESSAGE: Method 'GetId(T entity)' is missing XML documentation.
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.
LINE: 32 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: ToIndexKey(TId id) | MESSAGE: Method 'ToIndexKey(TId id)' is missing XML documentation.
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/Query/BTreeQueryProvider.cs

File issues: 7 (Errors: 7, Warnings: 0)

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.
LINE: 18 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateQuery(Expression expression) | MESSAGE: Method 'CreateQuery(Expression expression)' is missing XML documentation.
LINE: 33 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: CreateQuery(Expression expression) | MESSAGE: Method 'CreateQuery(Expression expression)' is missing XML documentation.
LINE: 38 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Execute(Expression expression) | MESSAGE: Method 'Execute(Expression expression)' is missing XML documentation.
LINE: 43 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: Execute(Expression expression) | MESSAGE: Method 'Execute(Expression expression)' is missing XML documentation.
LINE: 129 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Root | MESSAGE: Property 'Root' is missing XML documentation
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/Collections/SchemaVersion.cs

File issues: 4 (Errors: 4, Warnings: 0)

LINE: 7 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Version | MESSAGE: Property 'Version' is missing XML documentation
LINE: 8 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Property | SIGNATURE: Hash | MESSAGE: Property 'Hash' is missing XML documentation
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.
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/Storage/StorageEngine.Dictionary.cs

File issues: 5 (Errors: 3, Warnings: 2)

LINE: 79 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetKeyMap() | MESSAGE: Method 'GetKeyMap()' is missing XML documentation.
LINE: 80 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetKeyReverseMap() | MESSAGE: Method 'GetKeyReverseMap()' is missing XML documentation.
LINE: 86 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: GetOrAddDictionaryEntry(string key) | MESSAGE: Method 'GetOrAddDictionaryEntry(string key)' is missing documentation.
LINE: 136 | CATEGORY: MissingDoc | SEVERITY: Error | MEMBER: Method | SIGNATURE: GetDictionaryKey(ushort id) | MESSAGE: Method 'GetDictionaryKey(ushort id)' is missing XML documentation.
LINE: 195 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: RegisterKeys(IEnumerable keys) | MESSAGE: Method 'RegisterKeys(IEnumerable keys)' is missing documentation.

FILE: /Users/dohertj2/Desktop/CBDD/src/CBDD.Core/Storage/StorageEngine.Recovery.cs

File issues: 1 (Errors: 1, Warnings: 0)

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/Metadata/ValueConverter.cs

File issues: 2 (Errors: 0, Warnings: 2)

LINE: 12 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ConvertToProvider(TModel model) | MESSAGE: Method 'ConvertToProvider(TModel model)' is missing documentation.
LINE: 17 | CATEGORY: MissingParam | SEVERITY: Warning | MEMBER: Method | SIGNATURE: ConvertFromProvider(TProvider provider) | MESSAGE: Method 'ConvertFromProvider(TProvider provider)' is missing documentation.

13 KiB Raw Blame History