How do I inherit KDoc documentation?

后端 未结 1 777
一生所求
一生所求 2021-01-07 18:10

In Java\'s Javadoc, there is a way to inherit a method\'s documentation in a subclass using {@inheritDoc} tag.

Is there a way to do the same in Kotlin\'s KDoc?

相关标签:
1条回答
  • 2021-01-07 18:39

    Dokka always copies the documentation from a base member to an inherited one if the inherited member does not have its own documentation. There is no way to combine the base member documentation with additional text provided in the inherited member.

    (Dokka doesn't support the @inheritdoc Javadoc tag because this inevitably leads to the proliferation of comments consisting of only /** @inheritdoc */ which I find super useless and redundant.)

    0 讨论(0)
提交回复
热议问题