Fixed scaladoc failure on @throws tag when -implicits flag is on #9105
Conversation
This file contains 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
|
Signed the CLA. |
forketyfork
changed the title
lrytz
reviewed
Jul 13, 2020
There was a problem hiding this comment.
Hi @forketyfork, welcome, and thank you for the fix!
One idea: did you try changing conversions to be a lazy val instead?
The issue was due to incompatibility of the two features (one is parsing @hideImplicitConversion to filter out unwanted conversions, another is parsing @throws tag to add a link to a referenced exception). The code that filters out the hidden implicit conversions tries to parse the comment in search for the @hideImplicitConversion tag. Previously this happened during ModelFactory.makeModel(). But if a comment contains a @throws tag, the code that parses this tag assumes the model is already finished (ModelFactory.modelFinished == true), since it needs to lookup the exception. Solved by moving the implicit handling to the ModelFactory.completeModel() stage, after the model is already finished.
|
@lrytz thanks for the tip, I applied it. That's definitely a better way to fix the issue! |
lrytz
approved these changes
Jul 13, 2020
SethTisue
added
the
tool:scaladoc
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.
This fixes scala/bug#11021
The issue was due to incompatibility of the two features (one is parsing
@hideImplicitConversionto filter out unwanted conversions, another is parsing@throwstag to add a link to a referenced exception).The code that filters out the hidden implicit conversions tries to parse the comment in search for the
@hideImplicitConversiontag. Previously this happened duringModelFactory.makeModel().But if a comment contains a
@throwstag, the code that parses this tag assumes the model is already finished (ModelFactory.modelFinished == true), since it needs to lookup the exception.Solved by moving the
@hideImplicitConversionfiltering to theModelFactory.completeModel()stage, after the model is already finished.