i am trying to use

include

via

dokkaSourceSets

, but i can't quite get it to work. code:

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

when i build, i don't see any contents from

module.md

in any of the HTML files

am i doing something that is obviously wrong?

Hi I’m having a lot of trouble with Dokka. My main aim is to provide IDE documentation to library consumers for our closed source library. My strategy so far is to create a javadoc jar for only the public api. All of the public api code is java. My publishing.gradle file is in the thread. This works, but the generated javadocs has a lot of missing documentation: @deprecated text is missing, all property docs are missing. Also, documentation for any files that are in different android build type folders are NOT suppressed. It’s unrelated to Dokka, but another strategy I tried to enable IDE documentation was to publish the sources jar, just for the public api classes. This works if minification is turned off, but fails if it is turned on, with no documentation showing at all in Android studio. I don’t know how to debug this. Do I need to ensure that absolutely everything in the classes I have sources for is not minified? Is there any way to see error logs for this?

Hi everyone 👋 Your feedback has been a tremendous help to the Dokka team, and we are very grateful to all of you! In this channel, we usually talk about specific points and only rarely discuss your overall experience. To get some more general feedback, our team has prepared the first Dokka Survey. With it, we are hoping to get a better sense of the areas in Dokka that require the most attention, as well as the types of projects in which it is being used. Please tell us about your experience here: https://surveys.jetbrains.com/s3/dokka-survey This survey should take around 7 minutes to complete. By participating, you will get the chance to win a $50 Amazon gift card. Any information you provide will be kept confidential.

Hello! I am making a Dokka plugin to render docs as Json and I am getting a bit lost on how to correctly approach this, my idea was to have a package object that has classes/interfaces objects inside, then inside those would go the members, etc. I was able to get decently far into this crazy idea, however I am unsure how to correctly proceed, for example I am trying to get the parameters of a function and its comments, and annotations, etc. If I use the

documentables

as DFunction I can get the parameters but they lack the comments and generic types are erased, ex:

test: Provider<String>

would turn into just

Provider

. Could I get some advice on how to correctly approach this? I feel like I am not doing this the correct way.

Hi folks, im having trouble to generate docs for project which mixes java and kotlin. It seems it only generates docs for java files only, im using maven. (i will post plugin config in thread). Thanks in advance for any help !

What is the recommended way of including proper non-code documentation pages in the Dokka output? As in, not just the module/package headers, but proper full-blown pages for tutorials, that have the possibility to link to code etc, like all Dokka code can do. I'm half-tempted to create a

documentation

module that just contains

object

s with documentation 😅

Hey, I am unsure if this is the right place to ask this question, but as I have asked before I am working on a json plugin for Dokka, which is pretty much complete. So my question is how does Kotlin's main repo generate the docs for the stdlib? I want to run my plugin to generate the json for the stdlib if possible, but looking at the main Kotlin repo I can't really figure how it's done. (Only JVM would be needed)

Hi! Your case is quite interesting as I believe Dokka should've added line breaks here Is this API reference public? Can you link to it?

In https://api.openrndr.org/ the version displayed at the top

0.1.0-dev.1+c35ad28

is not what I would like. How is that version string decided? is it gradle, dokka, something else? The hash part is correct coming from the latest commit. When I run the

dokkaHtmlMultimodule

gradle task locally the version in the produced html files is

0.4.1

. This and this files are involved. Dokka version is 1.7.10.

hey All, do you know if it’s possible to embed a video within the docs generated with Dokka?

📣 Folks, sincere apologies for the

here

notification, but we really need some feedback on the below survey. Our understanding of your experience strongly affects further Dokka development. Thank you. <!here> https://surveys.jetbrains.com/s3/dokka-survey

For multi-module, Is there a configuration to open a specific child module html by default(instead of the page that shows

All modules:

)?

Are you able to exclude some submodules when running

dokkaHtmlMultiModule

? I have a submodule that publishes a javadoc artifact but I don't want to include it in my unified dokka HTML

I’m looking for a working example of embedding Dokka-generated HTML (seems more mature than Markdown output) within mkdocs. Right now I just use

mkdocs gh-deploy

(here) and in a single step it builds and deploys it. What I’m looking for is having an ability to attach a directory with the generated Dokka HTML output and then deploy it, or something equivalent. Any hints greatly appreciated

I have this project structure: module1/src module2/src src If I create the dokka files using

dokkaHtmlMultiModule

I only see module1 and module2 in the created documentation. How can I include the source files of the root project?

I'm noticing that properties with private or protected setters look like they have public setters in the documentation. This is with 1.7.20.

I’d like to somehow divide the docs for entities, think: public and internal API like here. More specifically, see these docs: https://krzema12.github.io/github-workflows-kt/api-docs/ - almost all stuff in package starting with

it.krzeminski.githubactions.actions

should go somewhere else because they contain generated code. Is it possible with Dokka?

I’m working on the Dokka Gradle Plugin refactor, and I’ve got safe cross-project configuration working, except it looks like some of the HTML processing isn’t working. In the HTML files I can see

PathToRootSubstitutionCommand

comments, but the

###

substitution isn’t triggered

<!--[+]cmd:{"@class":"org.jetbrains.dokka.base.templating.PathToRootSubstitutionCommand","pattern":"###","default":""}-->    <link href="###images/logo-icon.svg" rel="icon" type="image/svg">

I also see in the Dokka logs that some of the ‘extension points’ aren’t working

Unused extension points found: ExtensionPoint: org.jetbrains.dokka.base.DokkaBase/externalClasslikesTranslator, ExtensionPoint: org.jetbrains.dokka.base.DokkaBase/externalDocumentablesProvider, ExtensionPoint: org.jetbrains.dokka.base.DokkaBase/immediateHtmlCommandConsumer

I’ll put the full JSON config that’s being used to trigger the Dokka Generator in the thread - is it missing something?

Hello! I'm wondering, how do people document files or packages? For functions there's the /** doc */ syntax, but what if I want to document what's inclided in a given file or a package? Do people write a README.md file inside the package, or what is the convention? I didn't see any guidance about that in the Kotlin documentation style guide. Thanks!

As dokka matures the HTML it generates changes. Will major changes to it break the versioning plugin?

I hope I'm missing something but the design of the

older_version_dir

for the versioning plugin seems to have a scaling problem. I did three versions.

1.0.0

was 41.6 MB I made some small changes and created 1.0.1.

1.0.1

was 84.4 MB I then made no changes but built a 1.0.2

1.0.2

was 127.2 MB So after the first release the

older_versions_dir

was 41.6 MB, after the second release it was 126.0 MB, after the third release it was 253.2 MB. This is scaling exponentially. I understand that each version contains a copy of all the other versions, but should we be storing each copy so many times. Do we just need the latest version since it contains all the others, or is there something in each version we can copy out that doesn't have the other versions.

Not sure if this is the right channel to ask, but can you manipulate where

knit

generates it's files 🤔 Currently I have some snippets

md

inside a

docusaurus

project,

rootDir/content/blog/my-doc.md

and I have a Gradle project with KotlinX Knit setup in

rootDir

. My goal is to have a

rootDir/guide

submodule with Kotlin setup, and have KotlinX Knit generate the code in there. Currently the only way I found. to do this is to move the generated Knit files into the

rootDir/guide

, but that seems like a ugly hack 😞

in the dokka-multimodule-example, how do childProjectA and childProjectB end up in the output directory? Are they copied there by the Dokka Gradle Plugin, or by DokkaGenerator? I found there is a ‘copyChild’ utility, but this isn’t used anywhere https://github.com/Kotlin/dokka/blob/e8423ecf9f430758398eabc0d35077fff17f1f6c/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaMultiModuleFileLayout.kt#L51-L55C2

Is Dokka 1.8 going to be released anytime soon? Will it be supporting Gradle 8?

I'm a bit unsure how to achieve a multi-module build setup with the following structure:

/build-logic/src/main/kotlin/dokka-conventions.gradle.kts
/build.gradle.kts                        (applies dokka-conventions)
/subproject-A/module-1/builds.gradle.kts (applies dokka-conventions + kotlin-jvm)
/subproject-A/module-2/builds.gradle.kts (applies dokka-conventions + kotlin-jvm)
/subproject-B/module-1/builds.gradle.kts (applies dokka-conventions + kotlin-jvm)
/subproject-B/module-2/builds.gradle.kts (applies dokka-conventions + kotlin-jvm)
/subproject-C/builds.gradle.kts          (applies dokka-conventions + kotlin-jvm)

my multi-module index page in

/build/dokka/index.html

only contains docs for

subproject-A

. Sometimes I manage to get it to output all modules, but it's incredibly flaky - not sure what causes the failure/success.. Perhaps worth mentioning: using Kotlin 1.8.10 and tried with both Gradle 7.6 and 8.0.

How can I use inline markup to document parameters of a primary constructor? If I use the usual

[param]

syntax, IntelliJ show the references as unresolved.

Hi all 👋 I have been working on re-writing the Dokka Gradle plugin to make it more compatible with the Gradle API. Today I finished compatibility with the Gradle Configuration Cache 🎉 The plugin is called Dokkatoo :dokkatoo:, and it’s published on the Gradle Plugin Portal https://github.com/adamko-dev/dokkatoo It’s very rough around the edges, so please consider it an alpha. I’d really appreciate it if you could give it a go and make a GitHub issue if there are any problems, especially if you’re Gradle-savvy, or if (like me) you’ve been avoiding using Dokka because of the Gradle plugin compatibility. I’ve been working with @Ignat Beresnev on this (a shout out for his help!), and our goal is to merge Dokkatoo into the main Dokka repo.