Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing Java links in API docs for Scala #11655

Open
ashawley opened this issue Jul 30, 2019 · 2 comments

Comments

@ashawley
Copy link
Member

commented Jul 30, 2019

For example, the link to "Java Streams" on this page:

https://www.scala-lang.org/api/2.13.0/scala/jdk/StreamConverters$.html

Should link to the documentation for java.util.stream.Stream.

Building Scala, there are a bunch of warnings when running doc:

[warn] src/library/scala/jdk/StreamConverters.scala:17:1: Could not find any member to link for "java.util.stream.Stream".
[warn] /** This object provides extension methods to create [[java.util.stream.Stream Java Streams]] that
[warn] ^

This could be fixed by adding some setting to sbt, see scala/scala-xml#146

Scaladoc doesn't do the best job with generating links to entries of Javadoc, but it does ok most of the time.

@SethTisue

This comment has been minimized.

Copy link
Member

commented Jul 30, 2019

@ashawley

This comment has been minimized.

Copy link
Member Author

commented Jul 30, 2019

Yes, that would also work. That plug-in was originally meant to help with tricky situations linking to popular Scala libraries and to Scala itself, but later added Javadoc support, as well. I don't think Scala will have any Scala dependencies to cross-reference.

I've added just the lightweight solution in scala/scala#8284.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.