Repository navigation
Make the deprecation of AbstractParser#getBasedir visible to callers - #1082
Merged
Merged
Conversation
The javadoc has carried an @deprecated tag since DOXIA-373 was raised, but without the annotation no caller ever saw a warning. Anyone subclassing AbstractParser could reach for it and never learn it does not work in multi-module builds. This surfaces four warnings inside Doxia itself, at the MacroRequest construction in the APT, FML, xdoc and XHTML5 parsers. They are left in place: there is no replacement for the basedir the parsers need, and suppressing them would hide DOXIA-373 in the one codebase able to fix it. Verified: mvn clean verify -> 667 tests pass, japicmp clean, and the only new warnings are the four expected call sites
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
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.
The javadoc on
AbstractParser#getBasedir()has carried an@deprecatedtag since DOXIA-373 was raised, but without the annotation no caller ever saw a warning. Anyone subclassingAbstractParsercould reach for it and never learn it does not work in multi-module builds.Adding the annotation is binary-compatible — japicmp passes against the 2.0.0 baseline — so this fits the 2.x line, unlike removing the method.
One judgement call worth your view. This surfaces four warnings inside Doxia itself, all at the
MacroRequestconstruction in the APT, FML, xdoc and XHTML5 parsers. I left them in place rather than adding@SuppressWarnings: there is no replacement for the basedir those parsers need, and silencing the warnings would hide DOXIA-373 in the one codebase that can actually fix it.AptParseralready carries a comment saying as much. If you would rather the build stayed quiet, suppressing at those four sites is a one-line change each — say the word.Verified:
mvn clean verify→ 667 tests pass, japicmp clean, and the only new warnings are the four expected call sites.This change was created with AI assistance.