如何从Scala的标准库继承Scaladoc？

Question

如果我理解正确,方法的Scaladoc应该自动继承它覆盖的父方法的Scaladoc.这似乎适用于本地类的一组,但是从Scala的标准库扩展时(并且可能是任何外部依赖项？).

class LocalParent {
  /**
   * some documentation
   */
  def foo = ???
}

class DocumentedChild extends LocalParent

class UndocumentedChild extends Iterator[Int] {
   def hasNext = ???
   def next = ???
}

有没有办法继承Scaladoc？或者我做错了什么？

另外,我正在使用sbt doc,所以不是scaladoc直接使用.

Answer 1

这是我使用的(SBT 0.13):

scalacOptions in (Compile, doc) ++=
  Seq("-diagrams",
      "-diagrams-max-classes",
      "20",
      "-external-urls:java=http://docs.oracle.com/javase/6/docs/api/," +
      "scala=http://www.scala-lang.org/api/current/")

附录1:

要解决在重写方法并希望覆盖方法的文档注释时继承标准库类的问题,可以使用inherit documentation标记对成员进行注释:

/** @inheritdoc */
override def foo(bar: String): Int = bar.length

附录2:

此SBT 0.13文档页面中记录了此功能的更现代形式.