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.
Asked
Active
Viewed 1,112 times
4
Elnur Abdurrakhimov
- 44,533
- 10
- 148
- 133
Jens Egholm
- 2,730
- 3
- 22
- 35
-
Are there really on one who has insight in this? Darn, scaladoc needs to up their documentation ;-) – Jens Egholm Nov 02 '12 at 15:13
1 Answers
4
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.
Brian Smith
- 3,383
- 30
- 41
-
It's not in the scaladoc specific -help section in 2.9.2 (is in the section for general compile options), which is a bug. Looks like it's been fixed in master and 2.10.0 release candidates. – Brian Smith Nov 06 '12 at 15:12