any help is appreciated, thanks!

Also I'm looking for a way as to how to tell dokka in a multimodule gradle project to automatically resolve links for other dokka generated files of all other modules in the same project. This is for the Arrow library. Our current dokka config looks like this: https://github.com/arrow-kt/arrow/blob/rr-meta-kdoc/build.gradle#L90-L112

what’s the status of Dokka’s support for multiplatform projects?

but if I wish to include samples, and things like that, I can't find any documentation on that (and dokka itself doesn't seem to have documentation on its own code…)

if I refer in the doc comment to a

private const val

in the same class , e.g

[PI]

then is this ok? or does it need to be more visible than

private

?

Last commit to the dokka repo was almost an year back. Is this still the tool going to be used for doc generation in kotlin? Would be great if the authors can merge this PR - https://github.com/Kotlin/dokka/pull/358

I'm getting random errors comming from dokka that look like this:

FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':arrow-dagger-effects-rx2:dokka'.
> Guice provision errors:
  
  1) Error injecting constructor, java.lang.RuntimeException: Exception while loading package-list from ExternalDocumentationLinkImpl(url=<http://docs.oracle.com/javase/6/docs/api/>, packageListUrl=<http://docs.oracle.com/javase/6/docs/api/package-list>)
    at org.jetbrains.dokka.ExternalDocumentationLinkResolver.<init>(ExternalDocumentationLinkResolver.kt:28)
    at org.jetbrains.dokka.ExternalDocumentationLinkResolver.class(ExternalDocumentationLinkResolver.kt:28)
    while locating org.jetbrains.dokka.ExternalDocumentationLinkResolver
      for parameter 4 at org.jetbrains.dokka.DeclarationLinkResolver.<init>(DeclarationLinkResolver.kt:13)
    while locating org.jetbrains.dokka.DeclarationLinkResolver
      for parameter 0 at org.jetbrains.dokka.PackageDocs.<init>(PackageDocs.kt:13)
    at org.jetbrains.dokka.PackageDocs.class(PackageDocs.kt:12)
    while locating org.jetbrains.dokka.PackageDocs
  
  1 error

It happens randomly and it's hard to reproduce. Maybe it blows up when the remote Oracle site is down?

Is there a good way to make the dokka maven log output quieter? especially the Classpath line and [ERROR] logging: loading modules: ?

ngl, every time I see a new message notification in here I silently pray that it’s a multiplatform-supporting release

The docs state:

// Allows linking to documentation of the project's dependencies (generated with Javadoc or Dokka)
    // Repeat for multiple links
    externalDocumentationLink {
        // Root URL of the generated documentation to link with. The trailing slash is required!
        url = new URL("<https://example.com/docs/>")
        
        // If package-list file located in non-standard location
        // packageListUrl = new URL("file:///home/user/localdocs/package-list") 
    }

And

package-list

is briefly mentioned. Isn't each module responsible for generating a

package-list

or how does a user instruct dokka to generate one for a given module that others can consume locally or remotely? Are there other docs for Dokka beside https://github.com/Kotlin/dokka#dokka----- https://kotlinlang.org/docs/reference/kotlin-doc.html ? We rely on dokka to generate the Arrow documentation and currently there is a bunch of places where it's unable to link referenced types from other modules. For example https://arrow-kt.io/docs/apidocs/arrow-mtl/arrow.mtl.extensions.option.functor-filter/arrow.-kind/index.html contains no link to

Option

because it's in a different module: https://arrow-kt.io/docs/apidocs/arrow-core-data/arrow.core/-option/index.html

For those interested in an example of how to use @sample, I’ve published a repo that is similar to how the Kotlin language library does it. I haven’t determined how they convert the ‘test’ code into code with comments. I assume some form of post-processing, but at least this demonstrates how the @sample can be used to reference real code, and ensure the code compiles. Let me know if you have questions, or know of a better way to do it. https://gitlab.com/mikezx6r/dokka-demo

Anyone else find Dokka amazing, and yet frustrating? The lack of documentation and good examples is the big thing. Anyway, perhaps someone else has figured this out. Using the approach as per above in a project. Then I realized that for the most part, my samples ARE unit tests, so why not use my unit tests directly? Less repetition and less to maintain. BUT as soon as I add my test folder to the

samples

configuration, Dokka ALSO insists my tests be documented. It doesn’t do this if the samples are in a different project (using Gradle for build). Anyone else experienced this and figured out a way to work around it?

https://github.com/Kotlin/dokka/releases/tag/0.9.18 some movement in dokka repo 🙂

my anti-virus just warned me that dokka-fatjar-0.9.17.jar might be virulent, anybody else got this message?

Hey all. Just wondering, is it possible to use Dokka with only the JVM part of a multiplatform project (for now)? I can't quite get it to function property in my buildscript.

Here is my buildscript @robstoll. I'll take a look at that utility plugin perhaps as I'm not getting anywhere at the moment.

I’ve got a project that depends on

dokka-fatjar

to make a custom output formatter, and I’m having trouble updating to 0.9.18. Intellij doesn’t seem to detect those classes, even though it shows them as available as an External Library. Using Gradle on the command line seems to work fine. Any idea why Intellij can’t find those classes?

has Dokka 0.9.18 been published to the Gradle plugins repo? I’m applying it via the

plugins

block and bumping from 0.9.17 doesn’t seem to work - the artifact can’t be resolved

Does anyone happen to know why trying to run the Dokka task on my CI would be crashing the gradle daemon, but not on my local machine? Using Gradle 5.3.1, I'm testing 5.2.1 right now to see if it's an issue with that. Wasn't happening on Gradle 4.10.2.

After some testing around, turns out my Gradle daemon was actually timing out from a

java.lang.OutOfMemoryError

caused by Gradle 5.0 switching the default heap size to 512mb from 1g. It was just running out of memory on the Dokka task repeatedly and failing to crash the daemon until my server's timeout was hit.

can i have urls in kdoc and click them in idea ? the usecase is loads of generated values twhere i would like to jump to the corresponding webpage

Surprised it wasn’t mentioned in the patch notes for 0.9.18, but Dokka can now be configured entirely in Kotlin build script!

Dokka doesn't seem to bubble down to subprojects if the plugin is applied to the root. Is this intentional?

I have the problem that dokka does not find kotlin's

Pair

instead it prints

<ERROR CLASS>

. the link to other kotin classes like

List

work. Does that sound familiar to anyone?

I got it working using this: https://discuss.kotlinlang.org/t/how-to-configure-dokka-for-kotlin-multiplatform/9834/2

is it possible to refer to a specific overload by now?

Hi everyone 👋 I’ve been running into the following error a number of times when running dokka for Arrow. It’s reproducible on the master branch, it’s not consistent but easy to reproduce with

./gradlew dokka

. When it doesn’t crash the documentation seems to be generated correctly.

Is it expected, that link doesn't work in

@see

block?

Dokka has a lot of papercuts. There are a ton of open issues on github for fairly major features (linking across modules, distinguishing between function overloads, image embedding), but very little activity on the project, especially compared to something like coroutines. Is JetBrains actually using this tool for their own documentation? Is there any roadmap to a 1.0 release?