KDoc / Dokka: Ignore inherited methods in subclass

Question

I am generating documentation using KDoc/Dokka for an android library.

I have a custom view, which extends LinearLayout.

The problem is that LinearLayout contains hundreds of public methods. Dokka generates empty documentation for all of these methods, even though I did not use or override them in my own code.

This completely buries any of my own methods and makes the documentation near useless.

How can I prevent dokka from generating documentation for inherited methods?

score 2 · Accepted Answer · answered Sep 22 '20 at 12:26

2

Currently this is not supported, probably we will add some flag to turn it on/off.

You can follow this issue: https://github.com/Kotlin/dokka/issues/1501

answered Sep 22 '20 at 12:26

Andrzej Ratajczak

81
2

score 0 · Answer 2 · answered Jan 25 '22 at 20:37

From the answer by @andrzej-ratajczak the following can be used

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

here an example of my own module

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

        }
    }
}

KDoc / Dokka: Ignore inherited methods in subclass

2 Answers2