multi module aggregation for scaladoc in maven

Question

I have a parent project with 5 modules. I am trying to figure out how to aggregate the module level scaladoc's into one cohesive site. Any help would be much appreciated.

Answer 1

You can do it easily with SBT by integrationg 'Unidoc' into your build:

• https://github.com/akka/akka/blob/master/project/Unidoc.scala

The maven plugin for scala support aggregation too, but by default only direct module, you can change the default behavior (aggregateDirectOnly, forceAggregate):

• http://davidb.github.com/scala-maven-plugin/doc-mojo.html

Answer 2

Scaladoc2 doesn't support aggregation from multi source/multi classpath (scaladoc run over scalac, so aggregation means a full compilation like if there one big project). And the scala-maven-plugin is mainly a wrapper of the scala commands.

Aggregation is only available to vscaladoc, who is now abandonned.

Sorry

Answer 3

If aggregating Scala documentation into the overall Java project documentation is an option, see my answer here: https://stackoverflow.com/a/16288487/430128.