Scaladoc external references JDK11

[ashawley]

Linking to Javadoc with JDK11 doesn't work in Scala 2.13.0-RC1 and later.

This is a build.sbt:

scalaVersion := "2.13.1"

scalacOptions in (Compile, doc) += "-Xfatal-warnings"

apiMappings ++= {
  Map(
    scalaInstance.value.libraryJar
      -> url(s"http://www.scala-lang.org/api/${scalaVersion.value}/")
  ) ++ Map(
    file("/modules/java.base")
      -> url("https://docs.oracle.com/en/java/javase/11/docs/api/java.base"),
    file("/modules/java.xml")
      -> url("https://docs.oracle.com/en/java/javase/11/docs/api/java.xml")
  )
}

A simple Scala file, A.scala:

/**
 * [[java.lang.Throwable]]
 * [[scala.AnyRef]]
 */
class A

Running doc in sbt:

[error] A.scala:1:1: Could not find any member to link for "java.lang.Throwable".
[error] /**
[error] ^
[error] one error found
[error] (Compile / doc) Scaladoc generation failed

Repository with minimal example:

https://github.com/ashawley/scala-issue-11839

[ashawley]

A git bisect tracks it down to scala/scala#7782

It could be.

There is a reference to underlyingSource in scaladoc:

https://github.com/scala/scala/blob/2d9e6ac/src/scaladoc/scala/tools/nsc/doc/model/MemberLookup.scala#L61

[steven-barnes]

I'll take a look at it

[ashawley]

Is that change your guess, or did it fix the Scaladoc reference issue for you?

I built and published Scala locally with your branch, and I get the same error:

> ++2.13.2-bin-66e2c25!
[info] Forcing Scala version to 2.13.2-bin-66e2c25 on all projects.
[info] Reapplying settings...
> doc
[info] Updating ...
[info] Done updating.
[info] Main Scala API documentation to target/scala-2.13/api...
[info] Non-compiled module 'compiler-bridge_2.13' for Scala 2.13.2-bin-66e2c25. Compiling...
7 warnings
[info]   Compilation completed in 39.319s.
[error] A.scala:1:1: Could not find any member to link for "java.lang.Throwable".
[error] /**
[error] ^
[error] one error found
[error] (Compile / doc) Scaladoc generation failed
[error] Total time: 53 s, completed Jan 15, 2020, 5:14:22 PM

I'm on Mac OS X and using Java 11.0.2

$ java -version
java version "11.0.2" 2019-01-15 LTS
Java(TM) SE Runtime Environment 18.9 (build 11.0.2+9-LTS)
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.2+9-LTS, mixed mode)

[steven-barnes]

It does resolve the issue for me, although being a newbie I may be confused. I am using Mac OS X and Java 11.0.4

steve@Stevens-MBP scala-issue-11839 % sbt -Dstarr.version=2.13.2-bin-SNAPSHOT
[info] Loading global plugins from /Users/steve/.sbt/1.0/plugins
[info] Loading project definition from /Users/steve/dev/temp/scala-issue-11839/project
[info] Loading settings for project scala-issue-11839 from build.sbt ...
[info] Set current project to scala-issue-11839 (in build file:/Users/steve/dev/temp/scala-issue-11839/)
[info] sbt server started at local:///Users/steve/.sbt/1.0/server/21275a830197acab9eff/sock
sbt:scala-issue-11839> doc
[success] Total time: 0 s, completed Jan 15, 2020, 5:32:12 PM
sbt:scala-issue-11839> exit
[info] shutting down server
steve@Stevens-MBP scala-issue-11839 % java --version
java 11.0.4 2019-07-16 LTS
Java(TM) SE Runtime Environment 18.9 (build 11.0.4+10-LTS)
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.4+10-LTS, mixed mode)
steve@Stevens-MBP scala-issue-11839 %

[steven-barnes]

OK, does not fix the problem. I put a hack into my build.sbt, then removed it. Now that I do a clean build, the problem is back.

[steven-barnes]

I had manually set a mapping that worked:

file("/Library/Java/JavaVirtualMachines/jdk-11.0.4.jdk/Contents/Home/jmods/java.base.jmod") -> url("https://docs.oracle.com/en/java/javase/11/docs/api/java.base")

[ashawley]

Ok, thanks for double-checking.

[ashawley]

This is a difficult problem to work on because there isn't a good testing story with Scaladoc in the Scala build, and even more the case for JDK11 issues.