Generate scaladoc for root package

1.1k Views Asked by At

I'm curious how it's possible to document the root package, displayed as the first page in a scala-doc compilation. Can one create a package object referring to the root-package somehow, or is are there any configuration options? The descriptions on the matter are somewhat vague.

1

There are 1 best solutions below

1
On BEST ANSWER

There appears to be an option for scaladoc called -doc-root-content which was added in 2.9.2. You can see this in the ant build.xml for scala 2.9.2 and also in the compiler source code. It's not present in 2.9.1, it was added by this commit.