Don't fail for deprecated lazy vals, fixes #85. #113
Closed
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
This somewhat fixes lightbend#85 so that genjavadoc does at least not fail. However, like in the case for deprecated lazy vals with preexisting scaladoc, the preexisting comment might be lost under some Scala versions. The reason seems to be that starting from Scala 2.12 positions are reported in a way that puts the original position on the private `$lzycompute` method instead of on the accessor. To fix that additional considerations are necessary to somehow reconcile position information from the lzycompute with the actual accessor so that existing and generated scaladoc can be merged.
|
I filed the remaining issue with lazy vals under #114. I still think this is at least an incremental improvement over failing hard like before. |
|
Looks like the |
|
(we ended up working around this problem by replacing the |
|
Is this still something that needs to be fixed? |
|
I haven't seen it for a while but the problem might still be there. The fix here only works under very specific circumstances so maybe we can just close the PR for now and reinvestigate if it should be necessary. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 somewhat fixes #85 so that genjavadoc does at least not fail. However,
like in the case for deprecated lazy vals with preexisting scaladoc, the
preexisting comment might be lost under some Scala versions.
The reason seems to be that starting from Scala 2.12 positions are reported
in a way that puts the original position on the private
$lzycomputemethodinstead of on the accessor. To fix that additional considerations are necessary
to somehow reconcile position information from the lzycompute with the actual
accessor so that existing and generated scaladoc can be merged.