I’m trying to generate Dokka documentation for an Android project with custom Views, and the supertype’s declarations being dumped into the docs make them completely unusable at the moment 😞

View

and

ViewGroup

have their own documentation on the Android Developer website, there’s no need to show their hundreds of methods in our docs. Our custom methods are essentially impossible to find this way. I found an already open issue for this with no responses https://github.com/Kotlin/dokka/issues/1501 Any chance that this will be addressed soon, or is there any workaround to this problem?

If you use the development version, there is an option to have inherited functions in a separate tab:

separateInheritedMembers

that might help for now. See here for documentation. Not sure in which release that will be.

That would actually be really helpful - what do I need to do to get on the dev version?

you need to add

repositories {
    maven {
        url  "<https://dl.bintray.com/kotlin/kotlin-dev>" 
    }
}

to your maven repositories.

I was gonna ask how to set this up, pulled in this version, added this config

dokkaHtml.configure {
    dokkaSourceSets {
        configureEach {
            separateInheritedMembers = true
        }
    }
}

But I still get all the superclass stuff in the same view.

this needs to go in the

pluginsMapConfiguration

. Do you have

.gradle

or

.gradle.kts

?

Regular

.gradle

files

Bad luck. Now it is getting ugly. 😬 You need to add the following:

Hmm, where do I add this? It’s an Android project, so there’s a top level Gradle build file, and then per-module ones as well.

see https://github.com/Kotlin/dokka/blob/39cceaa3af6df5c419b9cd1f3d880ac8cf7d94a5/integration-tests/gradle/projects/it-basic/build.gradle.kts#L51 for reference.

Ah, got it, within the Dokka task config - I’ll give it a spin, fingers crossed 😄

I had to change the maven repo and the dependency on my side:

maven {
            url '<https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev>'
        }

and

classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.4.20.2-dev-62")

I got this new version, and have this as my config in each of my modules:

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

But I don’t get the separate tab yet 😞

For me it looks like this:

tasks.withType(dokkaHtml.getClass()).configureEach { 
 dokkaSourceSets {
....
}
 pluginsMapConfiguration.set(
            [
                    "org.jetbrains.dokka.base.DokkaBase": """{ "separateInheritedMembers" : true, "customStyleSheets": ["${file("../documentation/logo-styles.css")}","${file("../documentation/styles.css")}"], "customAssets" : ["${file("../documentation/docs_logo.svg")}", "${file("../documentation/logo-icon.svg")}"]}"""
            ]
    )
}

Ah, awesome, got it to work

😂 good luck. Disclaimer: There is nothing officially documented as far as I know. I just found it by looking trough code. So use at your own risk. 🚀

Understood, thank you for all the help! 🙇 I found two stable configs. I’m running

gradlew dokkaHtmlMultimodule

which runs

dokkaHtmlPartial

in each module, so I need either of these config blocks for this to work:

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

tasks.withType(dokkaHtmlPartial.getClass()).configureEach {
    pluginsMapConfiguration.set(
            ["org.jetbrains.dokka.base.DokkaBase": """{ "separateInheritedMembers": true}"""]
    )
}

Quick not:

dokkaHtmlPartial.getClass()

is just a way to get the

DokkaTask

class. I did not find any other solution. So this runs for all tasks of type

DokkaTask

.

Apparenty it matters whether it’s

dokkaHtml.getClass()

or

dokkaHtmlPartial.getClass()

, the former doesn’t work

Oh, good to know!