Fix DocFX indexer comments inheritance by removing problematic include tags #85
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding CLAUDE.md with task information for AI processing. This file will be removed when the task is complete. Issue: #16
…e tags DocFX does not properly support XML include tags for documentation inheritance. This commit replaces all problematic include tags with proper inheritdoc tags. Fixed files: - DirectMemoryAsArrayMemoryAdapter.cs: Fixed indexer documentation - ArrayMemory.cs: Fixed indexer and Size property documentation - FileArrayMemory.cs: Fixed indexer and Size property documentation - ResizableDirectMemoryBase.cs: Fixed Size, Pointer, ReservedCapacity, and UsedCapacity properties - FileMappedResizableDirectMemory.cs: Fixed OnReservedCapacityChanged and DisposePointer methods - HeapResizableDirectMemory.cs: Fixed OnReservedCapacityChanged and DisposePointer methods Resolves issue #16: DocFX fails to inherit indexer comments 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
konard
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
<include>tags<include>references to external XML files with proper<inheritdoc/>tags<include>tags for documentation inheritance as mentioned in dotnet/docfx#2328Changes Made
Fixed documentation in the following files by removing problematic
<include>tags:Indexer Documentation
Property Documentation
Method Documentation
Solution Approach
The issue was caused by the combination of
/// <inheritdoc/>tags with/// <include file='...'>tags. DocFX handles standard<inheritdoc/>tags properly but fails to process the external XML file references from<include>tags.By removing the
<include>tags and relying solely on<inheritdoc/>, the documentation inheritance now works correctly as the base interfaces (likeIArrayMemory<TElement>) already contain proper XML documentation.Test Results
Resolves #16
🤖 Generated with Claude Code