簡體   English   中英

"KDoc \/ Dokka:忽略子類中的繼承方法"

[英]KDoc / Dokka: Ignore inherited methods in subclass

我正在使用 KDoc\/Dokka 為 android 庫生成文檔。

我有一個自定義視圖,它擴展了LinearLayout<\/code> 。

問題是LinearLayout<\/code>包含數百個公共方法。 Dokka 為所有這些方法生成空文檔,即使我沒有在我自己的代碼中使用或覆蓋它們。

這完全掩蓋了我自己的任何方法,並使文檔幾乎毫無用處。

如何防止 dokka 為繼承的方法生成文檔?

目前不支持,可能我們會添加一些標志來打開/關閉它。

你可以關注這個問題: https : //github.com/Kotlin/dokka/issues/1501

從@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}"""]
            )

        }
    }
}

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM