Scaladoc:@group 标签未显示在 API 文档中

Question

我正在尝试使用 @groupname 和 @group 标签在我的库 API 文档中组织类的成员，但它不起作用(我使用的是 sbt 0.13.11)

我的玩具 build.sbt :

name := "test"
scalaVersion := "2.10.5"

我的玩具代码 src/main/scala/test.scala :

package test
/** Test class
 *
 * @groupname print Printer
 * @groupname throw Thrower
 */
class TestClass {
  /** @group print */
  def trivialPrint: Unit = print("Hello")
  /** @group throw */
  def trivialError: Unit = throw new Exception("Hello")
}

sbt doc编译一个 API 文档，其中我的两个函数都在类的“值成员”组中(参见屏幕截图)。我究竟做错了什么？

Answer 1

在 Scala 2.11 之前，您必须在 build.sbt 中明确要求 Scaladoc 分组支持。 :

name := "test"
scalaVersion := "2.10.5"
scalacOptions += "-groups"

您可以将其范围设置为 in (Compile, doc) ，但我不确定这是否重要。

像大多数与 Scaladoc 相关的事情一样，这基本上没有记录，但它有效。