When I want to use

1.4.30

, I run into https://github.com/Kotlin/dokka/issues/1779

Hey folks! :kotlin-intensifies: As you may noticed the current design strategy of Dokka is to make it pluggable. In other words we want to make it extendable with ease. In this round of feedback I'd like to message/talk to people who have something to say about existed API: • How does it convenient? • What about examples and docs? • Any suggestions to improve • etc This is the most critical topic right now and hope you have something to share. Please leave ➕ and I'll message you to ask some questions. Thanks in advance)

With 1.4.30, how do we configure the new

suppressObviousFunctions

feature in gradle? I don't see that flag mentioned in the docs anywhere, and it's not a property on the dokka task, the source set builder, or the plugin base configuration.

After updating to 1.4.30 I’m getting this failure while running the

dokkaGfm

task:

FAILURE: Build failed with an exception.

* What went wrong:
Received complete event for an unknown operation (id: 359761)

I’m not seeing much general guidance for this failure online- any tips on where to start looking?

Another 1.4.30 issue I’ve noticed- I’m currently mapping a module’s project path to a dokka output path, so a module with the project path

:foo:bar

would have its docs output to

/docs/foo/bar

Overall this is still working, but 1.4.30 is now generating an extra

index.md

in

/docs/foo

. It is actually copying the index.md from the last module it generates docs for, so e.g.

/docs/foo/index.md

is identical to

/docs/foo/bar/index.md

Does Dokka not generate output for Class in companion object? Dokka seems to generate for functions in companion object though. Filed an issue for details: https://github.com/Kotlin/dokka/issues/1797

How can I use Dokka with a Multiplatform project which includes Android?

No source set found for :example:dokkaJavadoc/androidMain

Hi all, I hope you are well. I have a question related to Dokka. Is there a way to build

only .kt files

? I'm trying to do this because we are currently trying to migrate to Kotlin from Java (android) and found that Javadoc HTML created by Dokka does not have 1.

@since

information (reported at Github) 2. and failed to find a way to insert headers, footers, etc. to Dokka configs (like mentioned here). Hence if we built all our sources (

java

+

kt

) using Dokka we will be losing some information we currently have. So instead we are considering building only

.kt

files using Dokka to minimize loss of information and wait for feature updates for the above. Is there a way to build only

.kt

files or exclude

.java

files from being built by Dokka? Thank you.

It doesn’t seem like Dokka’s tasks are cacheable, as of version 1.4.20. I see this PR has been open and awaiting review since august. Anyone know what priority this is for the dokka maintainers? I’m noticing that

dokkaHtml

tasks take a fairly long time, which is really noticeable when doing builds that don’t actually change any source code, and caching would help a lot.

I have a conventional plugin for single module projects which works fine so far. Now comes multi-module.. according to the readme, this should suffice

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

but it doesnt, dir doesnt exist what am I missing? Edit: I simply had to manually execute it.. it's not automatic as the usual per-module dokka documentation

Action required (❗*)* Hey folks! 👋 I'm at the homestretch, finalizing the roadmap for Dokka. Most of the questions are answered but I really need your help with these few: 1. Why is a consistent design style important? (do not confuse with navigation) 2. What navigation features are you missing in version 1.4.30? Why exactly these? 3. What Java-related features are you missing in version 1.4.30? Why exactly these? My ultimate goal is to make Dokka stable in the nearest future, but without your feedback I'm literally can't do so. 🙃 Feel free to share your thought in a thread or message me. Thanks!

I am trying to reference code from my module description. As there is no support for element linking, which would be ideal, I am trying to use normal relative markdown links. Unfortunately, the links are not correctly generated. Is that a bug or am I missing something?

Hey all, I can't seem to get multimodule working. When I add this to my top-level gradle I just get a

Unresolved reference: dokkaHtmlMultiModule

error. Any ideas?

Hello, I want to use Dokka in an open source multi-module, multiplatform and android project (all at once), and my attempts at setting up Dokka have failed (outputs empty doc), plus I'm super confused and overwhelmed by the documentation of Dokka. Would someone that is familiar with Dokka setup join me for a pair-programming session where we get that setup working sometime tomorrow? I'm in CEST, but I have high flexibility. FYI, the project in question is #splitties.

Did anyone here managed to build dokka docs for multimodule project on GH Actions? Mine keep running out of Metaspace or just hanging

Hey y'all. I have a multi-module Android project where the individual modules are building correctly, but I have nothing for the "MultModuleTask" output in my top level build file. Top-level project Gradle (Kotlin DSL) :

tasks.withType<org.jetbrains.dokka.gradle.DokkaMultiModuleTask>().configureEach {
    outputDirectory.set(File(project.projectDir, "dokka"))
}

How do I include files in the main page (all modules) of a multimodule project? I don’t see any

includes

or similar on

DokkaMultiModuleTask

Hi, I’m having trouble getting Dokka 1.4.30 to work with my multi-module project. The readme mentions that I should run

dokkaHtmlMultimodule

, however that task doesn’t exist. Also the most recent release notes mention I should use

dokkaHtmlPartial

, however that doesn’t work as then my

navigation.html

only contains the classes from one module. Am I missing something?

I'm not sure if this question belongs here or in #codingconventions, since it's about KDoc style. Feel free to send me there. The Javadoc style guides (Oracle and Google) contain specific rules, such as: • Method descriptions should be in 3rd person (e.g., "_Checks_ the parity"). • Descriptions of parameters and return values should not end with a period. Are best practices to apply these same rules when using KDoc unless a style guide explicitly says not to? (For example, the Android Kotlin style guide says there's no need to document obvious methods, like

getFoo()

. The examples on https://kotlinlang.org/docs/kotlin-doc.html#kdoc-syntax put periods at the end of descriptions:

/**
 * A group of *members*.
 *
 * This class has no useful logic; it's just a documentation example.
 *
 * @param T the type of a member in this group.
 * @property name the name of this group.
 * @constructor Creates an empty group.
 */

I'm teaching a capstone programming project course (in Kotlin, for the first time). Should I tell my students to follow the Javadoc rules or to emulate the example above?

I'm having trouble running dokka on a Windows 10 computer for an Android [Studio] project. I made changes to my

build.gradle

files as described here: https://medium.com/@julesrosser/auto-generate-kotlin-android-documentation-with-dokka-382248c03283 Here's what happens:

$ ./gradlew dokka
Starting a Gradle Daemon, 2 stopped Daemons could not be reused, use --status for details
java.lang.NoClassDefFoundError: Could not initialize class org.codehaus.groovy.vmplugin.v7.Java7
        at org.codehaus.groovy.vmplugin.VMPluginFactory.<clinit>(VMPluginFactory.java:43)

I suspect it has to do with a mismatched Java version:

$ java -version
java version "1.8.0_281"
Java(TM) SE Runtime Environment (build 1.8.0_281-b09)
Java HotSpot(TM) 64-Bit Server VM (build 25.281-b09, mixed mode)

Any advice?

Dokka now requires adding a space repository, but in just testing last night it doesn’t seem like these are reliable

Could not GET ‘maven.pkg.jetbrains.space/public/p/kotlinx-html/maven/org/jetbrains/kotlinx/kotlinx-html-jvm/0.7.2/kotlinx-html-jvm-0.7.2.pom’. Received status code 503 from server: Service Temporarily Unavailable

What’s preventing Jetbrains from just uploading that kotlinx-html artifact to central at this point that dokka users must add an unknown external repository?

Hi, newbie to Kotlin and Dokka here, probably a silly question... I have a

data class

for which I have documented properties using `@property`:

/**
 * Class description blah, blah, blah.
 *
 * @property property Something. Another something. And blah, blah, blah.
 * 
 * @constructor Creates a new instance, blah, blah.
 */
data class MyClass(val property: String)

The problem I have is that when I browse the class' properties I only get the first

Something.

in the description of the property (up to the first period), and then if I click on the property I get to a new page listing the property with no description at all, not even the first

Something.

. Am I doing anything wrong? Are periods forbidden in the description of a property?

Hello, I'm dealing with a huge monorepo that uses the Buck build system, and I'm trying to generate KDoc for just a tiny sliver of that codebase. I created a 

build.gradle.kts

 specifically for Dokka with a 

sourceSet

 containing just the subdirectory I'm interested in, and it generates documentation, but the problem is that any dependency outside of my 

sourceSet

 is shown as 

<ERROR CLASS>

. Obviously, Dokka can't generate docs for these classes since it can't resolve them, but is there there any way to get these class names to appear as text rather than an error? Ideally, I'd be able to link these classes to a URL containing their source code, but even just getting the raw text name would be a huge improvement. Any suggestions?

Anyone else had trouble getting

customStyleSheets

to be applied to all child projects/docs in a multimodule setup? It works for the "root"

index.html

but all subsequent pages are missing the custom style sheet

is there a complete example anywhere of writing a custom plugin? e.g. let's say I want to filter out API's and types that have a particular annotation on them, what's the easiest entry point to do this? What about customizing the HTML output? thanks!

is it possible to add custom entries to the navigation based on markdown? e.g. by default dokka adds an entry for each module, would be useful to be able to insert an entry in to the nav list that is based on markdown content (e.g. for high level API documentation, samples, etc)

Left Nav       |
-----------------------------------------------
module-1     v |       // normal docs generated from sources
   pkg1        |
   pkg2        |
module-2     v |
   pkg3        |
   pkg4        |
...
custom       v |        // based on markdown file(s)
   subpage1    |
   subpage2    |

bonus points if we could link to these pages from API content To clarify, I'm mostly wondering how to do this as a custom plugin, I wouldn't expect this to be supported as a general feature maintained by dokka developers (unless you think it's useful)

I have

dokkaGfmMultiModule

working well for me for the most part, only complaint is that right now I’m getting an extraneous module directory for each module, so if I have a

moduleA

, I get:

- docsRoot
  - moduleA
    - moduleA
      - package-list
      - [etc]
    - index.md

Is that intended?

Anyone have a good example of configuring a dokka Collector task to exclude certain modules?

Is there anyway to specify source set configuration for Collector tasks? It seems that configuration for Partial tasks is only used by MultiModule tasks, not Collectors.