Multiplatform module and package documentation

[mkrussel77]

Describe the bug
Trying to configure the module and package documentation by using the includes, creates wrong entries.

My builds have three platforms iOS, Android, and JVM. The list of platforms at the top includes

• androidJvm
• android
• common
• iosArm64
• ios
• iosX64
• jvm

The module documentation has three tabs.

• androidJvm (with the documentation there twice)
• android
• common

All the documentation is the same, so I would expect to see just the documentation or tabs for

• android
• common
• ios
• jvm

The packages list the set of platforms I would expect

• android
• common
• ios
• jvm

But only has tabs for android and common.

From debugging it seems like the main source set for android gets called android, and the debug and release versions are named androidJvm, which is where that tab comes from. Since there are two source sets that causes the text to be duplicated.

The iOS source sets have a platform set to jvm, not sure if that is why they do not show.

Expected behaviour
I would expect that there would either be no tabs for the documentation (since it is all the same) or there would be one tab for each platform and no made up platform called androidJvm.

Screenshots

To Reproduce
Create a multiplatform gradle project with ios, android, and jvm.
Add the include to each source set as shown in documentation.

Dokka configuration

dokkaHtml {
        dokkaSourceSets {
            def files = ["$projectDir/module.md"]

            configureEach {
                skipEmptyPackages.set(true)
                includeNonPublic.set(false)
                includes.from(files)
            }
        }
    }
}

kotlin {
    ios()
    jvm()
    android()
}

Installation

• Operating system: macOS
• Build tool: Gradle v6.2.2
• Dokka version: 1.4.0

Additional context
I'm able to improve things some with the following.

dokkaHtml {
    afterEvaluate {
        dokkaSourceSets {
            def files = ["$projectDir/module.md"]

            configureEach {
                skipEmptyPackages.set(true)
                includeNonPublic.set(false)
                if (it.name.contains("Main")) {
                    logger.error("${it.name}")
                    includes.from(files)
                }
                if (it.name.contains("ios")) {
                    displayName.set("iOS")
                }
                if (it.name.contains("android")) {
                    displayName.set("Android")
                }
            }
        }
    }
}

This gets the list of tabs for the module to be

• Android
• common
• iOS

But iOS gets the documentation duplicated 3 times, and jvm is still missing.
I checked that I do add the include for jvmMain. If I switch it to

dokkaHtml {
    afterEvaluate {
        dokkaSourceSets {
            def files = ["$projectDir/module.md"]

            configureEach {
                skipEmptyPackages.set(true)
                includeNonPublic.set(false)
                if (it.name == "commonMain" || it.name == "jvmMain" || it.name == "androidMain" || it.name == "iosMain") {
                    logger.error("${it.name}")
                    includes.from(files)
                }
                if (it.name.contains("ios")) {
                    displayName.set("iOS")
                }
                if (it.name.contains("android")) {
                    displayName.set("Android")
                }
            }
        }
    }
}

The iOS tab disappears on the module and package tabs.
If I change it from iosMain to iosX64Main then it gets the tab on the package section but the contents is empty.

If I add the includes to two different iOS mains (iosX64Main and iosArm64Main), then the tab on the module shows up again but has two entries and the package one is still empty.

These changes do get the filter chips to be the correct set.

[mkrussel77]

I had to wrap the updates to displayName in an afterEvalutation or else the changes got overwritten. The documentation doesn't show needing to do this.

[mkrussel77]

If I add the includes to just commonMain then the tabs show but everything but common is empty.

[pdvrieze]

My solution is to set the documentation only for the sourceSets that have the name "Main" in them (basically once per sourceSet displayname). If the content is identical (same file), this will merge the documentation.