如何覆盖子类的scaladocs中的@define

时间:2018-05-19 16:22:10

标签: scala scaladoc

我找到docs for the @define scaladoc macro,但他们没有深入探讨。

我尝试做的是以通用方式在基类/特征中编写文档,使用@define d变量,以便生成的子类文档中的措辞有意义。

我已将其提炼为一个我希望工作的例子,但不是:

/**
  * @define Word base-word
  */
class DocTestBase {

    /** Does a $Word
      *
      * @return
      */
    def foo = 1
}

/**
  * @define Word subclass word!
  */
class DocTestSubclass extends DocTestBase

通过上述内容,我希望DocTestSubclass#foo生成的文档可以说"是否是一个子类字!",但正如您在下面所看到的,它并没有'吨。

enter image description here

FWIW我也在Scala 2.12上尝试了这个,但结果是一样的。

我如何按照我的预期让它工作?这是scaladoc中的错误吗?

0 个答案:

没有答案