生成根包的scaladoc [英] Generate scaladoc for root package

问题描述

我很好奇如何记录根包，作为第一页显示在 scala-doc 编译。可以以某种方式创建引用根包的包对象，还是有任何配置选项？

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.

推荐答案

似乎有一个称为-doc-root-content的scaladoc选项在2.9.2中被添加。您可以在 ant build.xml for scala 2.9.2中看到这一点以及编译器源代码。它不在2.9.1中，它由此提交添加。

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.

这篇关于生成根包的scaladoc的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！