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

发布时间：2020-12-16 09:58:45 所属栏目：安全来源：网络整理

导读：我正在尝试使用@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和@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文档,其中我的两个函数都在类的“Value Members”组中(参见截图).我究竟做错了什么？

enter image description here

解决方法

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

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

您可以将其范围限定在(编译,文档)中,但我不确定它是否重要.

像大多数与Scaladoc相关的事情一样,这基本上没有文档记录,但它确实有效.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!