Viewing Scaladoc in Eclipse

Question

In Eclipse I have set the Javadoc Location property of my Scala project to file:/D:/EclipseWorkspace/MyProject/target/scala-2.9.1/api where D:/EclipseWorkspace/MyProject is the location of my scala project.

Now, if I am in a Scala file that implements a class/trait, when I type Shift+F2, Eclipse opens the Scaladoc page of that class/trait. However, this does not work if it is an object since Eclipse tries to open <ObjectName>.html whereas the Scaladoc-generated file name is <ObjectName>$.html.

Is there any workaround?

Answer 1

Scaladoc is now integrated since release 4.0.0 RC1 of the Scala-IDE plugin. You can just hover over your term, or press F2 while the cursor is on the identifier.

Answer 2

Typesafe has announced a plugin for the Scala compiler which generates JavaDoc for your Scala API. The plugin and its documentation is available on github. Maybe this helps as a workaround.