忽略基类使用Dokka查看子类文档中的公共函数 [英] Ignore base class View public functions in Subclass documentation with Dokka

问题描述

我用Dokka为View子类生成了文档.效果很好，但是文档包含了基本View类的数百个公共功能.有没有办法只记录我的子类公共功能?

I generated documentation with Dokka for a View subclass. Works well, but the docs include the hundreds of public functions of the base View class. Is there a way to only document my subclass public functions?

我尝试将这些选项添加到Gradle任务中，但我不认为这是要这样做的:

I tried adding these options to the Gradle task but I don't think this is what it was meant for:

dokkaHtml {
    dokkaSourceSets {

        create("main") {
            noAndroidSdkLink = true
            perPackageOption {
                skipEmptyPackages = true

                includeNonPublic = false

                prefix = " android.view.View"

                suppress = true
            }
        }
    }
}

推荐答案

当前，对此没有任何选择，我们计划添加专用标志以将其打开/关闭.

Currently, there is no option to that, we plan to add dedicated flag to turn it on/off.

您可以按照此问题获取该情况的当前状态: https://github.com/zh_cn.com/Kotlin/dokka/issues/1501

You can follow this issue to get current state on that case: https://github.com/Kotlin/dokka/issues/1501

这篇关于忽略基类使用Dokka查看子类文档中的公共函数的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！