Missing code blocks on Html frontend documentation

[ikbalkaya]

Describe the bug
Documentation does not point out any example or code block on how to set a footer for each HTML document. It says that it needs to happen on base plugin configuration but there is no code block or example that shows such a usage.

Expected behaviour
Document should clearly set an example on how to modify footer and/or other frontend properties

To Reproduce
Visit this link to see the issue yourself
https://kotlin.github.io/dokka/1.5.30/user_guide/base-specific/frontend/#modifying-footer

Dokka configuration
I'm trying to configure DokkaHtmlModule with an additional footer configuration using Android project level build gradle and module level build.gradles

Installation

• Operating system: macOS
• Build tool: Gradle v7.0.2
• Dokka version: 1.4.32

Are you willing to provide a PR?
This issue is better to be tackled by someone who has knowledge of the plugin usage.

[AlexisRiksman-TomTom]

Good point, I also struggled a lot before finding this.
Our current implementation is:

subprojects {
    if ((isLibraryProject || isAndroidLibraryProject) {
        apply(plugin = "org.jetbrains.dokka")

        tasks.withType<DokkaTaskPartial>().configureEach {
            pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
                footerMessage = "Copyright © ..."
                separateInheritedMembers = true
            }
}

and:

tasks.dokkaHtmlMultiModule.configure {
    pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
        footerMessage = docsFooterMessage
        separateInheritedMembers = true
    }
}

Note:

• The configuration must be done both for the subprojects (pages generated for packages, classes, etc.) and for the overall dokka multi-module task.
• Property 'separateInheritedMembers' can also do with example code.

[ikbalkaya]

Thank you @AlexisRiksman-TomTom. That's really appreciated I'm trying to write an equivalent of this code on Groovy. I attempted

tasks.dokkaHtmlMultiModule.configure {
    pluginConfiguration {
        footerMessage = docsFooterMessage
        separateInheritedMembers = true
    }
}

I'm getting this error

This function has a reified type parameter and thus can only be inlined at compilation time, not called directly.
for pluginConfiguration function
and for the individual module configurations

tasks.withType(DokkaTaskPartial).configureEach {
    pluginConfiguration {
        footerMessage "Something something somethin"
        separateInheritedMembers = true
    }
}

I'm getting back this
Could not get unknown property 'DokkaTaskPartial' for project

I would really appreciate if you could provide any help on how to configure this on Groovy.

[AlexisRiksman-TomTom]

You should include the class names when using template pluginConfiguration<DokkaBase, DokkaBaseConfiguration>.
Also don't forget the import statements for these classes.

As for Groovy, I cannot help you there as we do everything in Kotlin.