Scaladoc web pages generation

Posted on by Dmitry Naydanov

This feature is available from build 0.5.142. Now you can generate Scaladoc html documentation for the entire project or custom scope from the IntelliJ IDEA.

To use it, select “Generate Scaladoc” from Tools menu. Then you will see configuration dialog:

After choosing output directory you can press OK and get documentation for your project.

Comments below can no longer be edited.

7 Responses to Scaladoc web pages generation

  1. Nathaniel Novod says:

    November 21, 2012

    The @constructor tag is being marked as invalid in my scala code (@param works fine). Is there a way to allow @constructor tags in the code (the scala doc is generated correctly and the compiled code is fine it just shows up as an error when viewing the source).

    Thanks,
    Nathaniel

    • Nathaniel Novod says:

      November 21, 2012

      To add a bit – @constructor occasionally works but usually doesn’t with the error “under construction”

  2. Dmitry Naydanov says:

    November 21, 2012

    It is bug, fixed in the latest nightly (.327): http://confluence.jetbrains.net/display/SCA/Scala+Plugin+Nightly+Builds+for+Leda

    • Nathaniel Novod says:

      November 21, 2012

      Thanks – is there a fix for 11.1.4 (build 117.963)?

  3. Pat says:

    May 17, 2014

    When I run the scaladoc generator on my whole project it does nothing. Scala works fine, I can debug, get I/O and it seems that all is fine otherwise. I have a maven build and include the Scala 2.10.3 jars in its pom as dependencies.

    Is there some other setup I have to do to make it work? I user Scala 2.11 from the command line and it was installed through Mac brew.

    • Locutius says:

      May 22, 2014

      I have the same problem running with Scala 2.10 and IntelliJ 13.1.2 under Windows. Everything works great except the “Generate Scaladoc” option under Tools doesn’t work. It brings up the “Specify Generate Scaladoc Scope” dialog box but pressing OK does nothing. No error messages of any kind. Anyone know what we are missing?

  4. Locutius says:

    May 23, 2014

    Well, I went to the idea.log to find the error message (see below). Any ideas?

    2014-05-22 20:18:01,371 [15821569] ERROR – llij.ide.plugins.PluginManager – IntelliJ IDEA 13.1.2 Build #IC-135.690
    2014-05-22 20:18:01,371 [15821569] ERROR – llij.ide.plugins.PluginManager – JDK: 1.7.0_40
    2014-05-22 20:18:01,371 [15821569] ERROR – llij.ide.plugins.PluginManager – VM: Java HotSpot(TM) Server VM
    2014-05-22 20:18:01,371 [15821569] ERROR – llij.ide.plugins.PluginManager – Vendor: Oracle Corporation
    2014-05-22 20:18:01,371 [15821569] ERROR – llij.ide.plugins.PluginManager – OS: Windows 7
    2014-05-22 20:18:01,371 [15821569] ERROR – llij.ide.plugins.PluginManager – Last Action: Scala.GenerateScaladoc
    2014-05-22 20:21:32,568 [16032766] ERROR – llij.ide.plugins.PluginManager – Argument 0 for @NotNull parameter of com/intellij/execution/runners/ExecutionEnvironmentBuilder.setRunProfile must not be null