Use <inheritdoc/> on base-class interface implementations#135
Merged
Conversation
Replace 12 hand-duplicated XML doc blocks on ExtractorBase.ExtractAsync, LoaderBase.LoadAsync, and TransformerBase.TransformAsync overloads with /// <inheritdoc/>. Docs now have a single source of truth on the interface declarations they implement. No behavior change; all 132 unit tests still pass in Release on net10.0. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Replace 12 hand-duplicated XML doc blocks with
/// <inheritdoc/>on interface implementations in the base classes. Documentation intent is unchanged — the interface declarations already carry the full<summary>,<param>,<returns>, and<exception>tags that the implementations were restating.Changed methods (all
virtual, all implement an interface method with existing docs):src/Wolfgang.Etl.Abstractions/ExtractorBase.csExtractAsyncoverloadssrc/Wolfgang.Etl.Abstractions/LoaderBase.csLoadAsyncoverloadssrc/Wolfgang.Etl.Abstractions/TransformerBase.csTransformAsyncoverloadsSystemProgressTimer.csalready uses<inheritdoc/>— untouched.Motivation
Hand-duplicated docs drift from the interface contract over time.
<inheritdoc/>gives IntelliSense, DocFX, and Sandcastle a single source of truth: if the interface doc is updated, implementations automatically pick up the change.Stats
Test plan
dotnet build -c Release -f net10.0cleandotnet test -c Release -f net10.0— 132/132 pass🤖 Generated with Claude Code