Scaladoc no longer contains Java class documentation

scala / bug

Scala 2 bug reports only. Please, no questions — proper bug reports only.

https://scala-lang.org

232 stars 21 forks source link

Scaladoc no longer contains Java class documentation #6322

Open scabug opened 12 years ago

scabug commented 12 years ago

Scaladoc for Java classes that Scala uses (e.g., String) no longer appear in Scaladoc as of 2.8. Is that intentional?

scabug commented 12 years ago

Imported From: https://issues.scala-lang.org/browse/SI-6322?orig=1 Reporter: Dianne Marsh (dmarsh) Affected Versions: 2.8.0, 2.9.2, 2.10.0-M7

scabug commented 12 years ago

@VladUreche said (edited on Oct 4, 2012 1:30:50 PM UTC): To Dianne who reported the bug: it's probably a build script issue, as we could include the Java library source code when building the API site and we'd get java.lang.String among the members. But in the future we'll have much nicer solutions for linking to java.lang.String or getting the documentation on the fly.

Assigned to Eugene because this bug is related to the IDE scaladoc requirements.

scabug commented 11 years ago

@vigdorchik said: To Vlad: I can't see how we should proceed with this bug. If we have to do something on the compiler side, I'd like to know what it is. If not, I would close this issue. If something is needed from the IDE, I'd file there instead.

scabug commented 11 years ago

@VladUreche said: I think there are two sides to this bug:

in the static pages, we can use @template to document external Java classes
in the ide, we should be able to generate some info for external Java classes

som-snytt commented 1 year ago

oh man, I just missed the 10-year statute of limitations. Or delimitations, which govern continuation of the issue.

Edit: the clock ran out last year.

SethTisue commented 1 year ago

For types such as AnyRef and String, it would be neat to at least have a stub page with a link to the Javadoc.