👋 I'm trying to run

./gradlew dokkaJavadoc

following the multiplatform configuration specified here https://kotlin.github.io/dokka/1.6.0/user_guide/gradle/usage/#multiplatform but the following error:

Pre-generation validity check failed: Dokka Javadoc plugin currently does not support generating documentation for multiplatform project. Please, adjust your configuration

Is this a known defect?

Hey folks! I’m Anton from Dokka team. Two weeks ago we released 1.6 version of Dokka. And I would like to talk with those who have already tried 1.6 version about new experience. Especially about the new HTML output format. We’re on the way of making Dokka stable, and your opinions what should be changed/improved/fixed are extremely helpful! Leave 🏎️ reaction and I’ll contact you soon for arranging call or talking about 1.6 experience in DM

I've got multi-module docs generating and it looks swish, but: 1. Does anyone know if it's possible to apply custom CSS e.g. to change the logo image? 2. The sidebar doesn't seem to be used for anything anymore. It's always blank. What's meant to go there?

Is there a hotkey to trigger search?

Hi, are there any plans to use Dokka to format official API references, e.g. https://kotlinlang.org/api/latest/jvm/stdlib/? And if so, by when (and where)?

Attempting to use the 1.6.0 plugin and task dokkaHtml in a multiplatform library project. Using a clause like this in build.gradle.kts:

dokkaHtml {
        moduleName.set("Anything")
        dokkaSourceSets {
            named("commonMain") {
                noAndroidSdkLink.set(false)
            }
        }
        dependencies {
            dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")
        }
    }

and running dokkaHtml gradle task gets:

> Task :kmp-sc:dokkaHtml FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':kmp-sc:dokkaHtml'.
> org/jetbrains/dokka/model/ExtraModifiers$KotlinOnlyModifiers$Value

The github doc doesn't mention other dependencies to include explicitly, but since the only error shows a class name with no error cause, I can't tell if this is a dependency issue or not. Anyone else seen this or know what I'm doing wrong?

Is there any way to show each field in a (data) class on a separate line? The current everything on a single line seems a bit cluttered

Hi there! I'm using Dokka for my kotlin documentation, along with a sort of "readme" in a

module.md

file. I know that the module documentation supports markdown, but is there any way to add a table of contents that anyone has had any success with? Seems like I've tried everything and can't get anything to work.

Hi, I am trying to publish a module named

core_ds_component

of an Android project to artifactory. When I run the publish command, I get this error. I couldn’t find dokka in the dependency graph of this module. Does anyone has any idea what could be wrong?

Hi, want to get your opinion about documentation best practices with multiplatform code. Do you document both expect/actual classes? If yes, do you document functions in expect/actual as well? Also, are there any common styling/best practices you are aware of? Note. By documenting, I mean kdoc.

JFYI: it seems like gradle plugin portal is experiencing partial outage (https://status.gradle.com/) and older versions of dokka might be affected. Some users report that versions

1.5.X

are missing, but

1.6.X

are available, probably stored on different nodes or something. Good time to update? 😅

What would be the best extension point for simply adding additional top level markdown files?

Is there an easy way to be able to refer to specific classes and methods in the documentation through a link in the

module.md

documentation without putting the full url each time? for example: Instead of:

Refer to the documentation for the [Resource](<http://localhost:8080/core/com.example.core/-resource/index.html>) class.

Something like:

Refer to the documentation for the [Resource] class.

Hello all 👋 I’m really struggling with generating Dokka docs for a multimodule maven project. I’ve found

Dokka Maven plugin does not support multi-platform projects.

on the docs, does this mean it’s not yet supported? If so, is there any workaround for generating the docs for the modules and merge them together?

I'm trying to figure out the correct way to use dokka in a gradle composite build. My main gradle project has no subprojects (only included builds) so the MultiProject tasks aren't added by default and I create them manually. However I am now stuck on trying to figure out the correct way to add the child/partial tasks to childDokkaTasks. Any help would be appreciated!

hi everyone, it’s my first time using Dokka in my project, so I had some questions regarding that. My project implementing multi-module 1. is there someway for me to exclude certain package in a module? let say I had package

b

c

d

in module

a

, I want to exclude

b

and

c

so it won’t generated. Excluding certain module is working fine 2. if you see the attach image, you can find some functions. the problem is, I’m not implement any of those function explicitly in my class (in this case

CameraMaskingActivity

). Moreover, I found these functions also included in other class. I don’t want this in my report, is there anyway to exclude or remove this? 3. The report folder is big, like really big, I only include 2 modules but the size already 300++mb, is there someway to reduce the size? I know it might be related to each class that bloated, but the report file size could related to my question number 2 4. (Regarding design) in the attached image, I don’t find navigation menu that on the left, for me to go to other class in the report file, at least in the same module, is there any implementation that I’m not implement? Thank you and sorry for asking a lot of question. Cool library btw. Have a great day 😄

I'm interested in adding opengraph (https://ogp.me/) support to dokka. I have the following 2 questions: 1. Is there an existing extension point a plugin could use to implement this? If not, would you consider adding one that allows this and similar things to be implemented as plugins? 2. Would this be a feature that you are interested in having in dokka? If so I would be willing to develop it as a PR to dokka.

Also, I see a plugin

all-modules-page-plugin

in the Dokka repository but I can't find any documentation on how to properly configure Dokka to use this

I want to use

@sample

to reference some example code and I cannot get it to work. I'm looking at https://github.com/JetBrains/kotlin/blob/bd4d8479430a3ebda030ce4856886e9985cacd75/libraries/stdlib/src/kotlin/collections/Iterators.kt#L8 as an example but I can't figure out how to make it work.

Hoping to get some troubleshooting tips. Trying to use dokka for a multi-module gradle project (with both java and kotlin sourcesets), and some projects are failing with the following error (full stacktrace in thread):

java.lang.ClassCastException: class com.intellij.psi.PsiArrayType cannot be cast to class com.intellij.psi.impl.source.PsiClassReferenceType (com.intellij.psi.PsiArrayType and com.intellij.psi.impl.source.PsiClassReferenceType are in unnamed module of loader java.net.URLClassLoader @7dcea628)

Gradle version: 7.3.3 kotin/dokka plugin version: 1.5.31 and 1.6.10 (tried upgrading, same result on both) jdk: 11.0.13 platform: Intel Mac

Hi all, I’m trying to generate JSON files in order to feed spring-auto-restdocs, which is still using dokka v0.10.1 at the moment. I’m a bit lost in dokka’s plugin model, maybe someone of you can help: is it possible to generate files in pure JSON format with the currently existing extension points? if yes, what would be needed to do so?

I’ve got an Android project, and docs are being generated, but they do not contain source links? I think I have dokka configured correctly, so I’m not sure what’s going on. Any ideas? I’m using 1.6.10. Here’s my config for Gfm:

tasks.dokkaGfm {
    moduleName.set("app")
    outputDirectory.set(projectDir.resolve("../docs"))
    suppressObviousFunctions.set(true)

    dokkaSourceSets {
        configureEach {
           displayName.set("app")

            sourceLink {
                // Unix based directory relative path to the root of the project (where you execute gradle respectively).
                localDirectory.set(file("src/main/kotlin"))

                // URL showing where the source code can be accessed through the web browser
                remoteUrl.set(URL("<https://github.com/bradleycorn/resume-android/blob/master/app/src/main/kotlin>"))
                // Suffix which is used to append the line number to the URL. Use #L for GitHub
                remoteLineSuffix.set("#L")
            }
        }
    }
}

Hello! As github is now officially supporting mermaid, I assume there will be more and more of mermaid graphs in the documentation. Is there a plan to support it in Dokka? Could be really great for us.

It looks like dokka html docs are missing the

<!DOCTYPE html>

tag, which is required for browsers to use standard mode for rendering documents. Is this just a mistake or does dokka intentionally use quirks mode? If this is a bug, should I open an issue/pull request for it?

Hi, could some one help out with a simple question? If I want to document

interface MySDK {

and I have a global factory method

fun MySdk()

how do I refernce the method from the interface KDoc? The obvious approach is ambigouos and dokka chooses to resolves to the interface, not the method.

/**
 * An implementation of this interface can be instantiated by calling the factory method [MySdk]()
 */

Hey, does anyone know why KDoc in the latest IDE plugin doesn't seem to recognize constructor parameters in class docs when used as links, but does in

@param

tags?

Hello! I've just released a Mermaid plugin for Dokka. It's drawing images via mermaid.js (embedded) in comment blocks. Feel free to open issues with ideas or bugs you found. https://github.com/glureau/dokka-mermaid

It's a little frustrating that the documentation for Gradle configuration shows

includeNonPublic

as deprecated in favor of

documentedVisibilities

when

documentedVisibilities

has not been released in the version the documentation is saying to use.

Hi there! I don’t know what I changed but for some reason my dokkaHtml docs have started building using the older dokka style/theme. Our library used to always build nicely using the more modern theme… is there a configuration for turning this on/off? _Edit_: ok it’s somehow related to my upgrade of the Android Gradle plugin. the

7.0.4

builds the latest theme of Dokka and the

7.1.2

builds the old version.

Hi! I was playing around with KSP and Mermaid, thinking that I could generate the relationship graphs of classes (mainly public classes/fields that are visible in the API, ignoring technical details). Is there an existing tool doing the same kind of stuff that could be integrated with Dokka ? If not, knowing that Mermaid can handle clicks, maybe we could have a more visual way to navigate documentation ?