我正在尝试使用@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文档,其中我的两个函数都在该类的“值成员”组中(请参见屏幕截图)。我究竟做错了什么?

Scaladoc:@group标记未显示在API文档中-LMLPHP

最佳答案

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

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

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

像大多数与Scaladoc有关的东西一样,这基本上是无证的,但确实有效。

关于Scaladoc:@group标记未显示在API文档中,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/39835244/

10-11 08:40