Randomly our team hits this issue:

Cannot change dependencies of dependency configuration ':aws-runtime:dokkaGfmPlugin' after it has been resolved.

Project builds fine from cli but intellij won't load the project. Anyone have any insights how to solve?

Hello! Is there a way to load a generated markdown at the class level? If no, could we add something like

## class full.qualifier.of.ClassName

(same syntax than module/package) if it makes sense ? (context)

Happy to announce that Dokka 1.6.20 is out! 🎉 :kotlin-intensifies: Highlights: •

OutOfMemoryError: Metaspace

-related issues should now be solved for the majority of cases • New

documentedVisibilities

setting which lets you configure visibility modifiers that end up in documentation (public/private/internal/protected/package-private). This is a replacement for

includeNonPublic

which has now been deprecated. • HTML format refinements, the most noticable being ◦ vertical alignment (wrapping) of signatures when 3 and more parameters are present ◦ primary constructor signature now displays `val`/`var` keywords and shows default values • First iteration of HTML format customization through

FreeMarker

HTML templates • Bugfixes, a couple of new extension points, stability improvements Full release notes here: https://github.com/Kotlin/dokka/releases/tag/v1.6.20

How do you handle a non existing localDirectory inside sourceLinks?, eg

`
sourceLink {
    localDirectory by file("src/$sourceSetName/kotlin") // there is no watchosSimulatorArm64 because all sources are in commonMain...
    remoteUrl by uri("<https://github.com/hfhbd/RateLimit/tree/main/src/$sourceSetName/kotlin>").toURL()
    remoteLineSuffix by "#L"
}

It's weird, because it seems like a common thing to do, but I swear, I can't find any info about this, maybe you guys can help. I want to attach javadocs to a closed source sdk. The goal is for the javadoc and names to be visible in IDE, but the method bodies should be stripped. I learned that I need to have sources.jar to show javadocs in IDE. But can I configure the sources jar to strip method bodies (ideally just leave public stuff)?

java {
    withSourcesJar()
    withJavadocJar()
}

Is there a way to configure dokka to automatically put doc comments from

expect

functions in

commonMain

on the

actual

functions for each runtime? When dokka generates docs, it generates an individual (e.g.,) function doc for each runtime (jvm, js, native, ...). The common one has documentation because it has doc comments, the concrete runtime ones do not have doc comments. I'd like them to be "inherited" from the

expect

Hello, is it possible to replace the default favicon with a custom png file?

Mermaid plugin (for Dokka HTML) has been released in 0.3.1, with MermaidJs 9.1.0, adding accessibility features and improving GitGraph. Have a great day!

I want to create a dokka plugin that exports some basic information about classes/functions into a json file that is stored into the generated docs folder. My motivation to do this is to create a discord bot for searching and linking to the correct documentation. What is the best extension point to do this?

Hi folks, im trying to run

./gradlew dokkaHtml

for a simple project but im getting the error

https://github.blog/changelog/2022-05-19-render-mathematical-expressions-in-markdown/ Sounds like a new possible plugin for dokka, like mermaid :)

Hi, Is there a way to not overwrite the CSS files or index.html when I run

./gradlew dokkaHtmlMultiModule

? What I am trying to achieve is to replace the path for the logo. 🧵

Hello! I've just tried dokka plugin MathJax. I have a docstring with 2 formulas and I tried to place

@usesMathJax

in the begining and in the end of it. In both cases documentation on the page of documented symbol renders great, but not in short description of the symbol: either all documentation or formulas are not rendered respectively. (See images in the thread for details.) Is it feature, bug, or me doing something wrong?

Sorry, I found another strange case. You can write a docstring including something like "[Point] [Collector]" meaning that both braced words should be parsed as links to elements

Point

and

Collector

respectively. But no matter what space you put between them until there is no paragraph break between them it will be parsed as a word "Point" with link to

Collector

. I found a workaround by placing any element that is parsed as a space (for example,

<wbr>

,

 

, etc.). But the workaround works in IntelliJ IDEA but not in HTML version. More precisely, in HTML version the links are separated and parsed correctly, but there is no space between them (no matter what space element you put between them). It is a bug, isn't it? Is there any official solution (or at least workaround) for this?

Releasing Mermaid Html plugin 0.3.2 to get the latest 9.1.2 Mermaid.js features & bugfixes. Also announcing a new toy: generating your classes diagrams via KSP directly to your Dokka documentation! It's fancy to quickly visualize what your modules or packages contains, see the relationships between classes/interfaces/enums, and allow navigation directly from the graph. You can have a look at the live demo here Please tell me what you think!

Is there an example of custom html pages somewhere? I don't see how to change the templatesDir from gradle on my project 🤔

Is there a way to group modules by directories? I've a structure where modules are grouped, and they appear flat in the documentation, it's a bit harder to use.

Dokka 1.7.0 has been released 🎉 Highlights: • Kotlin 1.7 & Support for definitely-non-nullable types • Don't expose enum entry constructor arguments • Preserve ordering of enum entries as in source code, previously reversed • Improved support for inherited

Java

fields with accessors, now properly interpreted as `val`/`var` properties • Make rendered default value dependent on source set for expect/actual declarations • Better support for Kotlin/native libraries in KMP projects • [HTML] Render quotes as blockquotes instead of code blocks • [GFM] Support rendering of code blocks and inline code used in KDocs And a bunch of other changes and bugfixes along with stability improvements. Full release notes: https://github.com/Kotlin/dokka/releases/tag/v1.7.0

After updating Dokka from 1.6.21 to 1.7.0 my project no longer builds. More info in the thread.

I’m having a bit of trouble with Dokka on a Kotlin Multiplatform, multi-module project. Unfortunately the error message/stacktrace are pretty vague and I haven’t really got much of a clue where to start, can anyone give me some pointers? More in the thread…

Hey everyone 👋, Anyone has any idea what is causing all these

ERROR CLASS

in my generated HTML page? https://nomisrev.github.io/kotlinx-serialization-jsonpath/-kotlin-x%20-serialization%20-json-path/io.github.nomisrev/index.html It's referencing KotlinX Serialization types which is exposed through an

api

dependency 🤔

Dokka 1.7.10 has been released 🥳 This is a bugfix release that addresses several blockers and regressions. Full changelog: Gradle plugin • Do not expose Kotlin stdlib in plugin dependencies, this should fix errors like Module was compiled with an incompatible version of Kotlin when using Dokka. Thanks to @mbonnin Java sources • Fixed build failure caused by having configured source links for Java code • Fixed several exotic problems that led to build failures, all related to using annotation in Java sources • Fixed IntelliJ platform

WARN: Attempt to load key

messages that appeared when analyzing Java sources Release notes on GH: https://github.com/Kotlin/dokka/releases/tag/v1.7.10

Hello there. I am trying to set up 2 dokka tasks, so that: 1. they both generate documentation for the same multi module project 2. the first one generates html docs with kotlin definitions (that one is pretty simple) 3. the second one generates html docs with java definitions (and I want it to coexist with the first one) For a single module project adding a custom task like the one below would do the trick:

tasks.register("dokkaHtmlJava", DokkaTask::class) {
    dependencies {
        plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
    }
}

But for a multi module project I am really struggling to make it work. I believe I need to register a custom

DokkaMultiModuleTask

in my root build.gradle.kts and then some custom

DokkaTaskPartial

in my modules' build.gradle.kts files. Yet I can't seem to configure this properly. Can anyone help me with this?

Hello! Could a #dokka plugin be written which could parse code like this:

class MyClass {
@Router
fun myRouter() =
  route {
    get("/hello") {
      println("hello")
    }
    get("/bananas") {
      println("bananas")
    }
}
}

And generate an output something like this?

GET /hello com.example.MyClass
GET /bananas com.example.MyClass

I stumbled upon a medium article which suggested Dokka could do this sort of static analysis.

Hi there! Has any one seen this error with Dokka 1.7.10 and Kotlin 1.7.10 when trying to run dokkaHtml for a multi-platform-project?

Caused by: java.lang.IllegalStateException: Illegal use of flexible type deserializer.
        at org.jetbrains.kotlin.library.metadata.NullFlexibleTypeDeserializer.create(NullFlexibleTypeDeserializer.kt:19)
        at org.jetbrains.kotlin.library.metadata.NullFlexibleTypeDeserializer.create(NullFlexibleTypeDeserializer.kt:12)
        at org.jetbrains.kotlin.serialization.deserialization.TypeDeserializer.type(TypeDeserializer.kt:66)
        at org.jetbrains.kotlin.serialization.deserialization.MemberDeserializer.loadProperty(MemberDeserializer.kt:57)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedMemberScope$OptimizedImplementation.computeProperties(DeserializedMemberScope.kt:314)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedMemberScope$OptimizedImplementation.access$computeProperties(DeserializedMemberScope.kt:228)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedMemberScope$OptimizedImplementation$properties$1.invoke(DeserializedMemberScope.kt:253)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedMemberScope$OptimizedImplementation$properties$1.invoke(DeserializedMemberScope.kt:253)
        at org.jetbrains.kotlin.storage.LockBasedStorageManager$MapBasedMemoizedFunction.invoke(LockBasedStorageManager.java:578)
        at org.jetbrains.kotlin.storage.LockBasedStorageManager$MapBasedMemoizedFunctionToNotNull.invoke(LockBasedStorageManager.java:651)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedMemberScope$OptimizedImplementation.getContributedVariables(DeserializedMemberScope.kt:338)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedMemberScope$OptimizedImplementation.addFunctionsAndPropertiesTo(DeserializedMemberScope.kt:352)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedMemberScope.computeDescriptors(DeserializedMemberScope.kt:115)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedClassDescriptor$DeserializedClassMemberScope$allDescriptors$1.invoke(DeserializedClassDescriptor.kt:301)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedClassDescriptor$DeserializedClassMemberScope$allDescriptors$1.invoke(DeserializedClassDescriptor.kt:300)
        at org.jetbrains.kotlin.storage.LockBasedStorageManager$LockBasedLazyValue.invoke(LockBasedStorageManager.java:408)
        at org.jetbrains.kotlin.storage.LockBasedStorageManager$LockBasedNotNullLazyValue.invoke(LockBasedStorageManager.java:527)
        at org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedClassDescriptor$DeserializedClassMemberScope.getContributedDescriptors(DeserializedClassDescriptor.kt:311)
        at org.jetbrains.kotlin.resolve.scopes.ResolutionScope$DefaultImpls.getContributedDescriptors$default(ResolutionScope.kt:50)
        at org.jetbrains.kotlin.resolve.scopes.SubstitutingScope$_allDescriptors$2.invoke(SubstitutingScope.kt:38)
        at org.jetbrains.kotlin.resolve.scopes.SubstitutingScope$_allDescriptors$2.invoke(SubstitutingScope.kt:38)
        at kotlin.SynchronizedLazyImpl.getValue(LazyJVM.kt:74)
        at org.jetbrains.kotlin.resolve.scopes.SubstitutingScope.get_allDescriptors(SubstitutingScope.kt:38)
        at org.jetbrains.kotlin.resolve.scopes.SubstitutingScope.getContributedDescriptors(SubstitutingScope.kt:87)
        at org.jetbrains.kotlin.resolve.scopes.ResolutionScope$DefaultImpls.getContributedDescriptors$default(ResolutionScope.kt:50)
        at org.jetbrains.kotlin.resolve.lazy.descriptors.LazyClassMemberScope.computeExtraDescriptors(LazyClassMemberScope.kt:115)
        at org.jetbrains.kotlin.resolve.lazy.descriptors.LazyClassMemberScope.doDescriptors(LazyClassMemberScope.kt:72)
        at org.jetbrains.kotlin.resolve.lazy.descriptors.LazyClassMemberScope.access$doDescriptors(LazyClassMemberScope.kt:51)
        at org.jetbrains.kotlin.resolve.lazy.descriptors.LazyClassMemberScope$getContributedDescriptors$2.invoke(LazyClassMemberScope.kt:108)
        at org.jetbrains.kotlin.resolve.lazy.descriptors.LazyClassMemberScope$getContributedDescriptors$2.invoke(LazyClassMemberScope.kt:107)
        at org.jetbrains.kotlin.storage.LockBasedStorageManager.compute(LockBasedStorageManager.java:290)
        at org.jetbrains.kotlin.storage.LockBasedLazyResolveStorageManager.compute(LockBasedLazyResolveStorageManager.kt)
        at org.jetbrains.kotlin.resolve.lazy.descriptors.LazyClassMemberScope.getContributedDescriptors(LazyClassMemberScope.kt:107)
        at org.jetbrains.kotlin.resolve.scopes.ResolutionScope$DefaultImpls.getContributedDescriptors$default(ResolutionScope.kt:50)
        at org.jetbrains.dokka.base.translators.descriptors.DokkaDescriptorVisitor.getDescriptorsWithKind(DefaultDescriptorToDocumentableTranslator.kt:820)
        at org.jetbrains.dokka.base.translators.descriptors.DokkaDescriptorVisitor.getDescriptorsWithKind$default(DefaultDescriptorToDocumentableTranslator.kt:819)
        at org.jetbrains.dokka.base.translators.descriptors.DokkaDescriptorVisitor$classDescriptor$2.invokeSuspend(DefaultDescriptorToDocumentableTranslator.kt:383)
        at org.jetbrains.dokka.base.translators.descriptors.DokkaDescriptorVisitor$classDescriptor$2.invoke(DefaultDescriptorToDocumentableTranslator.kt)
        at kotlinx.coroutines.intrinsics.UndispatchedKt.startUndispatchedOrReturn(Undispatched.kt:89)
        at kotlinx.coroutines.CoroutineScopeKt.coroutineScope(CoroutineScope.kt:264)
        at org.jetbrains.dokka.base.translators.descriptors.DokkaDescriptorVisitor.classDescriptor(DefaultDescriptorToDocumentableTranslator.kt:382)
        at org.jetbrains.dokka.base.translators.descriptors.DokkaDescriptorVisitor.access$classDescriptor(DefaultDescriptorToDocumentableTranslator.kt:132)
        at org.jetbrains.dokka.base.translators.descriptors.DokkaDescriptorVisitor$classDescriptor$1.invokeSuspend(DefaultDescriptorToDocumentableTranslator.kt)
        at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
        at kotlinx.coroutines.internal.ScopeCoroutine.afterResume(Scopes.kt:33)
        at kotlinx.coroutines.AbstractCoroutine.resumeWith(AbstractCoroutine.kt:102)
        at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46)
        at kotlinx.coroutines.internal.ScopeCoroutine.afterResume(Scopes.kt:33)
        at kotlinx.coroutines.AbstractCoroutine.resumeWith(AbstractCoroutine.kt:102)
        at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46)
        at kotlinx.coroutines.internal.ScopeCoroutine.afterResume(Scopes.kt:33)
        at kotlinx.coroutines.AbstractCoroutine.resumeWith(AbstractCoroutine.kt:102)
        at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:46)
        at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:106)
        at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)
        at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:750)
        at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)
        at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)

Is there a way to create an empty docs.jar? I need to publish an artifact, but it must have the docs.jar attached, otherwise maven.org will not accept the it. Any idea how I could do this for the time being? (until the thing above is fixed)

Is the Dokka version bound to the Kotlin plugin version? I.e. can I use Dokka 1.7.10 with Kotlin 1.6.21? (or the other way around)

Hi, I would like to extract comments from Kotlin code using Dokka and produce a JSON or something similar. My goal is to use those comments together with other information to generate domain specific documentation. Is this something possible? Any pointer to share?

Hi! I'm trying to configure Dokka 1.7.10 for a multi-module project that uses Gradle 7.4 with conventions plugins. The repository is at https://github.com/andreihh/chronolens. If I add

implementation(libs.dokka.gradle)

to

buildSrc/build.gradle.kts

dependencies section and

id("org.jetbrains.dokka")

to

buildSrc/src/main/kotlin/chronolens.common-conventions.gradle.kts

plugins section, then I get the following error when running any Gradle task (compiling the conventions plugins seems to fail):

e: /home/andrei/.gradle/caches/modules-2/files-2.1/org.jetbrains.kotlin/kotlin-stdlib-common/1.7.10/bac80c520d0a9e3f3673bc2658c6ed02ef45a76a/kotlin-stdlib-common-1.7.10.jar!/META-INF/kotlin-stdlib-common.kotlin_module: Module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.7.1, expected version is 1.5.1.
e: /home/andrei/.gradle/caches/modules-2/files-2.1/org.jetbrains.kotlin/kotlin-stdlib-jdk7/1.7.10/1ef73fee66f45d52c67e2aca12fd945dbe0659bf/kotlin-stdlib-jdk7-1.7.10.jar!/META-INF/kotlin-stdlib-jdk7.kotlin_module: Module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.7.1, expected version is 1.5.1.
e: /home/andrei/.gradle/caches/modules-2/files-2.1/org.jetbrains.kotlin/kotlin-stdlib-jdk8/1.7.10/d70d7d2c56371f7aa18f32e984e3e2e998fe9081/kotlin-stdlib-jdk8-1.7.10.jar!/META-INF/kotlin-stdlib-jdk8.kotlin_module: Module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.7.1, expected version is 1.5.1.
e: /home/andrei/.gradle/caches/modules-2/files-2.1/org.jetbrains.kotlin/kotlin-stdlib/1.7.10/d2abf9e77736acc4450dc4a3f707fa2c10f5099d/kotlin-stdlib-1.7.10.jar!/META-INF/kotlin-stdlib.kotlin_module: Module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.7.1, expected version is 1.5.1.

Does anyone have any idea how to fix this problem? I tried deletng the

.gradle/caches

, but to no avail.