Scaladoc 无法为方法和类签名中的内部类生成链接

Question

我有一个顶级特征，其中包含许多类和特征，例如:

trait Trees { self: Types =>
  trait Tree
  trait IdentifiedTree extends Tree
  trait Empty extends Tree

  /** The factory for [[TypeUse]] instances */
  trait TypeUse extends Tree
  /** AST tree to represent erroneous trees */
  object BadTree extends IdentifiedTree
  /** AST tree for empty statements and trees */
  val Empty: Empty = new Empty {}
}

trait Types

当我为它生成文档时，使用 scaladoc 我可以使用 [[CLASS_NAME]] 链接到内部类，但是 scaladoc 无法为签名和扩展中的树创建链接。

我使用 sbt 生成 scaladoc，并使用以下标志:

scalacOptions in (Compile, doc) ++= Seq("-groups", "-implicits",
     "-diagrams", "-no-prefixes", "-author", "-explaintypes",
     "-language:implicitConversions,higherKinds")

为了让您更好地了解，上述定义的 api 如下(请注意缺少的链接):



你能告诉我我做错了什么吗？

Answer 1

我认为嵌套特征的问题在于，内部特征甚至不存在于顶级特征的实例化之外。此 post可能会有一些帮助。

将顶级树更改为对象为我解决了这个问题。但是，我不确定这对您的用例是否有意义。

object Trees {
    trait Tree
    trait IdentifiedTree extends Tree
    trait Empty extends Tree
    ...
}