Fix code comments inheritance by removing conflicting <include> tags #73
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: #10
- Remove all <include> tags that reference build output XML files - Keep only <inheritdoc/> tags for proper documentation inheritance from ISynchronization interface - This resolves issues with DocFX failing to inherit XML documentation comments - Affects ReaderWriterLockSynchronization and Unsynchronization classes Fixes #10 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
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
This PR fixes code comments inheritance issues in the Threading library by removing conflicting
<include>tags and keeping only<inheritdoc/>tags for proper documentation inheritance.Problem
The current implementation had both
<include>tags referencing XML build output files and<inheritdoc/>tags on the same methods, causing conflicts that prevented DocFX from properly inheriting XML documentation comments from the interface methods.Solution
<include>tags that referencedbin\Release\netstandard2.0\Platform.Threading.xml<inheritdoc/>tags for clean documentation inheritance fromISynchronizationinterface methodsReaderWriterLockSynchronizationandUnsynchronizationclassesFiles Changed
csharp/Platform.Threading/Synchronization/ReaderWriterLockSynchronization.cscsharp/Platform.Threading/Synchronization/Unsynchronization.csBenefits
Testing
The changes maintain all existing
<inheritdoc/>tags (8 total) while removing problematic<include>tags that caused inheritance conflicts.Fixes #10
🤖 Generated with Claude Code