I'm looking at a dokka example project for MPP projects and I'm trying to figure out how to use this:

val global by creating {
    // this is a special block for passing perPackageOptions,
    // externalDocumentationLinks and sourceLinks to all other platforms
    perPackageOption {
        // suppress a package on all platforms
        prefix = "shouldbesuppressed"
        suppress = true
    }
}

How do I add external documentation links and source links to other platforms?

Anyway to bold something in KDoc comments?

My CI fails on downloading https://kotlinlang.org/api/latest/jvm/stdlib/package-list. The exception is

sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

, it seems to be a SSL error. Anyone knows how to fix this ?

I'm trying to set up Dokka for my multimodule & multiplatform. This is the configuration I have in the root project. the kotlin multiplatform plugin is applied in all projects, and I only apply Dokka in the root:

tasks {
    withType<DokkaTask> {

        outputFormat = "html"
        outputDirectory = "docs"

        subProjects = rootProject.childProjects.map { it.key }
        multiplatform {
            rootProject.childProjects.forEach { (name, project) ->
                register(name) {
                    targets = listOf("JVM", "JS")
                    listOf("commonMain", "jvmMain", "jsMain").forEach { dir ->
                        val sourceDir = "${projectDir}/$name/src/$dir/kotlin"
                        if (File(sourceDir).exists()) {
                            sourceRoot {
                                path = "${projectDir}/$name/src/$dir/kotlin"
                            }
                        }
                    }
                }
            }
        }
    }
}

What am I doing wrong? I'm trying to register each module and their corresponding sources, but it is not working. The docs are generated but it is not grouped by subprojects and I also get hundreds of errors stating that

Found an unresolved type

and other errors stating that

Cannot extract sources from subProjects. Do you have the Kotlin plugin in version 1.3.30+ and the Kotlin plugin applied in the root project?

and

Could not find target with name: myproject

. How am I supposed to use Dokka for my setup?

Is there a way to specify where to output the generated documentation, for instance a url or a file share location?

Hi guys, there is anyway to set a markdown page the main Dokka page? I have a README for that library and explain how to use it and I want to add to Dokka, is possible? I'm trying with includes but I don't know if this is the use case.

I'm using Dokka to generate doc. It works locally, but it fails when the project runs on the server (DevOps). Here is the error I get (see below). Someone has a clue? Do I need to specifically refer to 'dokka-fatjar' in my build.gradle or is

plugins {
    ...
    id 'org.jetbrains.dokka' version '0.10.1'
    ...
}

enough?

Looking through the Dokka issues list I see many, many tasks scheduled for 0.11.0. I would judge it may be many months until such a release sees the light of day and can begin being tested by the community.

Meanwhile the community is suffering from some major issues like not working on Java 11, bugs, etc. Is there a way to reduce the scope of 0.11 and stabilise what's been done so far, or at least prioritise keeping it maintained and working on newest JDKs?

what could be causing this warning and should I be worried about it?

> Task :genJavadoc
WARN: Failed to initialize native filesystem for Windows
java.lang.RuntimeException: Could not find installation home path. Please make sure bin/idea.properties is present in the installation directory.

the file is, in fact, present, although I have no clue why it's even trying to get there

Hi, how can I get the output with better format?, like the attached screenshot I'm looking in the docs but nothing found about css edit or similar

Anybody tried dokka 0.11.0 (git) see if it can build for JDK>8 already?

I feel like I am probably doing something wrong, but it seems like the

dokka

task created by the plugin requires jars to be assembled, however it does not actually seem to configure the gradle dependency graph correctly because if I run

dokka

after a

clean

I get errors about jars not being found for depended-on modules. I’m using dokka 0.10.0 with gradle 6.3 on a multi-module project. Is it expected to have to configure these dependencies manually?

Hi all, im looking for public projects that have used Dokka for documentation. Are you aware of any?

It looks like dokka 0.10 won’t run on anything post Java 9 and 0.11.0-dev-41 gives me errors about multiple extensions being registered even without any explicit configuration in my pom. any suggestions on how to resolve this?

Is Dokka abandoned? Not really much activity going on. Is there an alternative to Dokka out there, I haven’t been able to find anything

Dokka is being redesigned, there is a talk about it next week @ Kotliners

I want to confidently assure you all that Dokka as a project is not abandoned. The opposite is true. The team working on it right now is the biggest it has ever been. Dokka started as a rather small project but quickly grew as there always has been a demand for new features. Adding support for multiplatform projects was a straw that broke the camel’s back. Right now, Dokka is undergoing a long-overdue major rewrite. You can track its progress on the dev-0.11.0 branch and get dev releases - published at least once every two weeks - from a public bintray. All major features are already in place. The only thing missing from the dev releases right now is Javadoc support, which we are working on right now and should be available in a week or two. Our frontend is also undergoing rapid changes right now, so you may be sure to get better and better-looking documentation with every new snapshot. Nevertheless, I can confidently say that we are on the final stretch. I cannot promise any release date, as right now, as we are part of the kotlin release cycle, so there are many factors outside of our team knowledge and influence. However, I can assure you that you will soon get the best looking, most consistent, and flexible Dokka release ever.

I don’t know gradle well enough to configure the latest dev version of dokka (which I’d like to do since the release version didn’t work for me). I added this to my module’s

build.gradle

file:

implementation 'org.jetbrains.dokka:dokka-base:0.11.0-dev-45'

but don’t know what else to add to get a dokka task.

I’m watching the Dokka talk from the Kotliners conference – wow! The new dokka is super cool.

Hey all, so I'm new to dokka. I'm trying out the default html output format and I'm not sure that I like the format. (Some things aren't align and are hard to read, etc.) Is there any custom CSS or some alternative that styles everything more cleanly?

Will the new Dokka engine also eventually be used in the Kotlin IntelliJ plugin to render documentation in the IDE? Any chance that will be available in Kotlin 1.4?

Hi! I'm trying to use Dokka 0.11.0-dev-45 build with an android library project but when I add it to the classpath, it starts giving errors about the android gradle plugin 😕 . When I comment out the Android gradle plugin id, it gives errors about not being able to find the kotlin-android plugin too.

An exception occurred applying plugin request [id: 'com.android.library']
> Failed to apply plugin [id 'com.android.internal.version-check']
   > Could not create plugin of type 'VersionCheckPlugin'.
      > Could not initialize class com.android.build.gradle.internal.plugins.VersionCheckPlugin

any idea why this might be? I had two modules (app and lib, but I've removed the app module since). Would really appreciate it because I would like to figure out a way to do ((or contribute) an output format that does Markdown with Java signatures using Dokka 🙂. Thanks

Hi! I’m evaluating Dokka for internal documentation of an Android project. My initial feeling has been highly positive thanks to gradle plugin. However, there is something that is really important to us that I couldn’t manage to do. There are multiple

README.md

files scattered around the project, mainly serving as package summaries. I want to include these markdown files, not necessarily named

README

, under package pages in Dokka. It should feel like browsing the project on Github. Is this at all possible or is there any other way that you would suggest?

Hi, I am using dokka 0.10.1 and I noticed that the file

index-outline.html

contains absolute links which means I can’t share this file (put it on github). It is the only file generated by dokka with absolute urls to my machine (

/users/me/project/path/docfolder/module/index

). Is this working as intended? (Hopefully not, or there’s a config I missed) I found this PR which could be related: https://github.com/Kotlin/dokka/pull/325

I'm trying

id("org.jetbrains.dokka") version "1.4.0-M3-dev-54"

from https://dl.bintray.com/kotlin/kotlin-dev But I keep having an error from gradle: Could not find org.jetbrains.dokka:gradle-plugin:1.4.0-M3-dev-54

Hey 👋 We are currently updating the dokka examples inside the kotlin-examples repoistory. Is there anything you are interested in? Any configuration that we should show? The current PR only shows very basic examples. https://github.com/Kotlin/kotlin-examples/pull/127

Is it feasible? If not, do you know any other way of doing that even by the compiler, IntelliJ or any other tool?

Out of curiosity: Would somebody be interested in nightly builds from the current development state?