KDoc / Dokka：忽略子类中的继承方法

Posted 2023-04-14

【中文标题】KDoc / Dokka：忽略子类中的继承方法

【英文标题】：KDoc / Dokka: Ignore inherited methods in subclass

【发布时间】：2020-12-13 21:54:45

【问题描述】：

我正在使用 KDoc/Dokka 为 android 库生成文档。

我有一个自定义视图，它扩展了LinearLayout。

问题在于LinearLayout 包含数百个公共方法。 Dokka 为所有这些方法生成空文档，即使我没有在自己的代码中使用或覆盖它们。

这完全掩盖了我自己的任何方法，并使文档几乎毫无用处。

如何防止 dokka 为继承的方法生成文档？

【参考方案1】：

目前不支持此功能，可能我们会添加一些标志来打开/关闭它。

你可以关注这个问题：https://github.com/Kotlin/dokka/issues/1501

【参考方案2】：

根据@andrzej-ratajczak 的回答，可以使用以下内容

pluginsMapConfiguration.set(
  ["org.jetbrains.dokka.base.DokkaBase": """ "separateInheritedMembers": true"""]
)

这里是我自己的模块示例

dokkahtml 
    moduleName = "$project.name"

    dokkaSourceSets 
        configureEach 
            // Suppress a package
            perPackageOption 
                // will match all packages and sub-packages
                matchingRegex.set(".*\\.internal.*")
                suppress.set(true)
            

            // separate inherited members to avoid polluting our public API
            // https://github.com/Kotlin/dokka/issues/1501
            pluginsMapConfiguration.set(
                    ["org.jetbrains.dokka.base.DokkaBase": """ "separateInheritedMembers": true"""]
            )