Workaround bugs in doc tools #9
Merged
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
Both Scaladoc and genjavadoc take exception to this project.
- raw types in the generated mixin composition befuddle
scaladoc (lodged as https://issues.scala-lang.org/browse/SI-8449)
- implicit classes seem to mess up genjavadoc
- as do private[pack] classes
Finally, I had to remove parameter documentation from the
`toJava` and `toScala` decorators, as the reference parameter
was the argument to the implicit conversion, not to the documented
method.
All said an done, we end up with:
https://dl.dropboxusercontent.com/u/106552/genjavadoc-scala-java8-compat/genjavadoc-api/index.html
Contributor
|
LGTM, thanks again; I’ll try to fix genjavadoc, but that might not happen this week. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Both Scaladoc and genjavadoc take exception to this project.
scaladoc (lodged as https://issues.scala-lang.org/browse/SI-8449)
Finally, I had to remove parameter documentation from the
toJavaandtoScaladecorators, as the reference parameterwas the argument to the implicit conversion, not to the documented
method.
All said an done, we end up with:
https://dl.dropboxusercontent.com/u/106552/genjavadoc-scala-java8-compat/genjavadoc-api/index.html
Review by @rkuhn. I'm still tossing up wheter to just code this in
Java (we'd have to drop or move the implicit conversions in that case.)