Latest Builds • 1.4.10-dev-21 • 1.4.0-rc-21 Short Update • We are currently working on resolving types from native libraries • We are implementing more features of the javadoc format • We are working on largely simplifying the experience and implementation with/of our Gradle plugin • We are working on improving the rendering for unresolved types (will render class name instead of <ERROR CLASS> in the future

The day has come! https://blog.jetbrains.com/kotlin/2020/08/dokka-preview-based-on-kotlin-1-4-0-rc/

Haven’t been able to find anything by googling, is it possible to put a backquote in a backquoted string in kdoc? I have never seen any docs about escaping in kdoc backquoted strings.

Hi guys & girls 👋 I am currently trying out dokka

1.4.0-RC

at my company. We had dokka

0.10.0

before and it worked, but with

1.4.0-RC

I get the following error in the

Creating documentation models

phase:

Couldn't get delegate for class

Does anyone have an idea what that could be or how to get any information what class causes this problem?

Hi there! I've read on twitter that now it is possible to document multimodule & multiplatform projects. I can't find examples however. Is there a good code example for a project that is both multiplatform & multimodule?

Feedback welcome We have a new

dev

build available that we would be very happy to get feedback for 🎉 _Build_: 1.4.0-dev-35 _____ Gist of changes: 1. Gradle Plugin Our Gradle Plugin had some very hard to fix issues and we put a lot of effort into • Reducing complexity of its implementation • Fixing internal issues e.g. (bad UP-TO-DATE) behaviour,... • Fixing UX issues like "re-declaring source sets for mulitplatform projects", replacing paths with java.io.File, using Gradles Property/Provider APIs etc... We hope that "just applying the dokka plugin" is all that most build authors need. The plugin can be seen as companion to the Kotlin Gradle Plugin. See the pull-request for further details: Simplify Gradle Plugin Feel free to drop me dm's if you need any help migrating or experience any issues! 2. Merging visible source sets Issue: DokkaCollectorTask: Merge source set bubbles This was noticed while running the collector task on larger projects like the Spring framework. Source sets with the same displayName and platform will now be represented as one in the frontend. We hope that this unblocks some of you that rely on the collector task. 3. Updated compiler to 1.4.0 4. A lot of smaller bugfixes Further details are available in our milestones: • 1.4.0 • Stable __ Some comment on version numbers You already noticed, that we aligned our version number to the compiler version we bundle. (e.g. 1.4.0, 1.4.0-rc, ...). There were some minor hick-ups when we changed to this numbering schema, but I would like to clarify some things. Dokka 1.4.* is not a stable project. It is still considered alpha! For now, we agreed on using the following naming schema • `{comiler-version}-dev-{build-number}`: for preview builds •

{compiler-verison}

for releases and pre-releases (no dokka maturity included) •

{compiler-version}-{patch number}

for patch releases __ Some comment on kotlin-dev This will probably be the last build we push to the

kotlin-dev

repository. We will migrate dev builds to space packages in the near future.

📣 For everyone that wants to try out 1.4.0-dev-35, but has issues migrating • I pushed a pull request to the kotlin-examples repository, updating all examples to the new APIs (PULL REQUEST) Common Issues: • Make sure to use the new Provider/Property API:

jdkVersion = 8

->

jdkVersion.set(8)

• Any path of type

String

is now represented as

<http://java.io|java.io>.File

• Any collection of files/directories is now represented as Gradles

ConfigurableFileCollection

• Make sure (especially in Android Projects) to configure Dokka tasks lazy:

tasks.withType<DokkaTask>() { // config }

->

tasks.withType<DokkaTask>().configureEach { }

,

tasks.getByName

->

tasks.named

,etc. Good read https://docs.gradle.org/current/userguide/task_configuration_avoidance.html • Note: MPP projects will have all source sets automatically configured. No need for

register

yourself! • Tip: Use

./gradlew --stacktrace

to get better error messages of what is wrong. I noticed, that the short error message for Groovy scripts is not useful at all And as always: Feel free to drop me a DM at any time you encounter an issue ☺️ Have fun, folks. Enjoy Kotlin 1.4.0 ☺️ 🎊

Hey everyone! I have the following config of dokka

tasks.dokkaHtml {
  outputDirectory = "$buildDir/dokka"
  dokkaSourceSets {
    register("commonMain") {
      displayName = "common"
      platform = "common"
    }
    register("jvmMain") {
      displayName = "jvm"
      platform = "jvm"
    }
    register("androidMain") {
      noAndroidSdkLink = true
      displayName = "android"
      platform = "android"
    }
  }
}

but when I run

./gradlew dokkaJavadoc

I got

No source set with name 'main' found

In the main directory is the

AndroidManifest.xml

without a source! So how can I unregister the

main

?

hey, is it possible to have the generated html dokka docs directly accessible on Github?

To generate the javadoc in previous versions I was using this code:

val dokkaJar by tasks.creating(Jar::class) {
    archiveClassifier.set("javadoc")
    from(tasks.dokka)
    dependsOn(tasks.dokka)
}

Yes, you have to set up Dokka to include *Test (I use *SampleTest) in its samples lookup

Feedback welcome ☺️ • 1.4.0-dev-62

maven("<https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev>")

I just learnt how to use

@sample

. I find cumbersome adding file by file in

build.gradle.kts

under

samples: List

. Wouldn't be possible for the plugin to group all the

@sample

from the sources and find the least necessary common group of files to be used for doc inlining?

Hi, Is it possible to use older dokka versions (like

0.10.0

) with Kotlin 1.4.0? After upgrading Kotlin version only (without upgrading dokka) I see some errors for KMP project.

I have been experiencing with

dokkaJavadocJar

a

java.lang.OutOfMemoryError: Metaspace

never ever saw this before, is it normal? It seems

org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m

in

gradle.properties

solves the issue

First time Dokka user. Using 1.4.0-rc, dokkaHtml task. (1) My understanding was inline markdown was supported, but using bold doesn't seem to do anything in my function docs. [linking] does work though. (2) By default it seems Dokka documents only public members, but I also want to document protected members. It seems there's only includeNonPublic which in turn also includes private and internal, which is exactly what I don't want. Any options here I missed? (3) Continuing on point 2, I've tried using @suppress on private members, but everything still happily shows up in the docs anyway?

It's unfortunate that build.gradle.kts files are almost but not quite the same as the Groovy equivalents, meaning it's often not obvious how to translate

Anyone else getting a StackOverflowError with version 1.4.0-rc? Message is

Has anyone managed to apply dokka-gradle-plugin in a precompiled script plugin (buildSrc/src/main/kotlin) when using Gradle Kotlin DSL? I'm getting a version conflict between Kotlin 1.3.72 (required by Gradle) and Kotlin 1.4 (required by dokka-gradle-plugin).

Hi 👋 I'd like to test Dokka again 🙌 please, would you recommend to test 1.4.0 Alpha -Gradle plugin overhaul or the latest DEV version? Thanks in advance!!

Hey guys, I’m trying to set up Dokka in a mono-repo that contains multiple Kotlin (v1.3.72) libraries and uses Gradle (v6.4.1). I have a top-level 

build.gradle.kts

 script in which I apply the Dokka plugin to all libraries -

configure(subprojects.filter { it.parent?.name == "libs" }) {
    apply {
        plugin("org.jetbrains.dokka")
    }
}

I’ve also added the following block that is mentioned in the docs for multi module support -

tasks.dokkaHtmlMultiModule.configure {
    outputDirectory.set(buildDir.resolve("dokkaCustomMultiModuleOutput"))
    documentationFileName.set("README.md")
}

I also have a 

README.md

 file under each of my libraries under 

libs

 folder, and I added the following to the 

build.gradle.kts

 script of each of the libraries which I want to include in the generated docs -

tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
    dokkaSourceSets.configureEach {
        includes.from("README.md")
    }
}

After running 

dokkaHtmlMultiModule

, it seems like I get a folder for each library under 

build/dokkaCustomMultiModuleOutput/libs

 (with all generated docs inside), but I can’t seem to find any top-level 

index.html

 file. In addition, none of the libraries are listed in the top level 

-modules.html

 file. Am I missing something, or doing something wrong? Thanks in advance 🙏

Am I doing something wrong when private members show up in derived classes or is this a (known?) bug? I turned off

includeNonPublic

, which works for the base class, but prints the property for any and all derived classes:

When upgrading dokka from 1.4.0-rc to 1.4.0 in Kotlin/JS project I have this error:

Execution failed for task ':dokkaHtml'.
> There was a failure while populating the build operation queue: NPM project resolved without org.jetbrains.kotlin.gradle.targets.js.npm.KotlinNpmResolutionManager@5fdc639

Anyone else has this issue?

With dokka 1.4.0 and no submodules in the project, is there any way to make the

dokkaHtml

task create index.html at the top level rather than nested in a project folder? It's not clear how to publish the output as a static site (e.g. github pages) without having the root 404.

Hi, is anyone available to help me with the above? ^ 🙂

Is there a way to customise the generated HTML when using dokka, such as defining the copyright footer message?

Is it possible to set the overview page of the javadocs generated from KDoc comments?

I've noticed that the generated

dokka/html

doesn't have any

index.html

in the root folder (only a

navigation.html

without any include stylesheet). The first

index.html

appears only inside the module. Is this supposed to be this way?

dokka just runs out of metaspace when running the gradle tasks or randomly fails with no error

Hello! I setup my gradle file with Dokka 1.4.0 , but in the list of available tasks I only see dokka, not dokkaHtml, any idea why?