Hi, I've just tried to generate docs with the new shiny dokka 1.4 and it even started doing stuff, but after 10 minutes or so it just died with the following:

Execution failed for task ':dokkaHtmlMultiModule'.
> Could not resolve all files for configuration ':dokkaHtmlMultiModulePlugin'.
   > Cannot resolve external dependency org.jetbrains.dokka:dokka-base:1.4.10 because no repositories are defined.
     Required by:
         project :

I'm a bit at a loss, it was obviously running and generating module docs, but then it says it can't find itself? o_O

Greetings. I am new to android kotlin development. How can I create my plugin for dokka v1.4.0-rc and how can I debug it during development? Can I just create a DokkaPlugin heir in a new project and debug it while expanding it? Or do I have to do everything in the copied dokka sources? Is there a git repository with an example or more detailed tutorials for less experienced professionals? Thanks.

Does anybody has a sample of gradle configuration to deploy dokka-generated docs as github pages?

New dokka is a great improvement! Is there a way when generating

dokkaHtml

to customize the branding, or do we just need to have a separate gradle task to overlay with custom branding?

Another question… working on a plugin. I’d like to generate a new table of contents page that enumerates and links to classes that implement a particular type. I’m sleuthing through the code right now and struggling to come up with the right things to implement to do something like this. Any pointers?

Hey all. Don't you think it'd make sense to add platfrom-specific bubbles on common code declarations to better indicate for which platforms those are available?

Hi all, one question: in multi-module Android projects (one app that uses several android libraries) how can I configure Dokka to make the documentation for all in one command?

is it just me, or is there no way to navigate back to the top in multi-module documentiation?

does anyone know why the API docs for this class would not include any of the methods starting with

handle

...

Hi. I'm trying to port atrium ( https://github.com/robstoll/atrium ) to dokka 1.4.10.2. But I seem to be hitting some kind of size limit: when I limit the amount of source sets to 27, I get my build done in < 1 minute, typically. But adding 1 more project can make the gradle task not return in any 'normal' time (I've waited 10 minutes and more in some cases). I also get

GC overhead limit exceeded

sometimes. Code can be found here: https://github.com/jgrgt/atrium/blob/dokka-upgrade/gradle/scripts/gh-pages.gradle#L36 (on that line increasing the 27 to 28 makes the time go from <1 minute to not returning after 2 minutes (I gave up after that).

Cross post from #language-proposals

Hi there! I am still using kotlin 1.3.x and I am trying to integrate dokka 0.10.1 on my kotlin multiplatform project. Can someone show me an example of the build.gradle.kts with the dokka task for multiplatform? It’s being difficult to find examples 😞 Thanks in advance!

can anyone who works on Dokka confirm that KDoc does not have a line length limit, unlik JavaDoc?

My

includes

doesn’t seem to be getting picked up- what’s the best way to troubleshoot that? I don’t see anything in the logs that appears to be helpful, even when running with

--debug

. I’m running

./gradlew dokkaGfm

Here’s my configuration:

dokkaGfm {
  def outputPath =  //..
  outputDirectory = file(outputPath)

  dokkaSourceSets {
    named("main") {
      jdkVersion = 8
      includes.from("README.md", "packages.md")
    }
  }
}

Neither README.md nor packages.md appear to be getting picked up. If it makes a difference, this is an Android library module.

Hi there! I've added Dokka to my multiplatform + multimodule project and it works like a charm! The only problem I bumped into is that Dokka generates a file called

-modules.html

into the root directory of the resulting documentation instead of generating an

index.html

file. How can I tell Dokka to create an

index.html

instead? If I rename the file by hand it works, but I'd like to automate this.

Hello fellow kotlineers! I am looking for some help w/ some Dokka related troubles, is anyone here knowledgeable and able to provide some guidance? it seems to be related to this issue: https://github.com/Kotlin/dokka/issues/537

Hi all, I'm trying to get dokka to include documentation for files generated from AIDL, which output to the build folder. How do you include additional sources in an Android project for dokka 1.4.10.2? The README suggests I should be putting config in

dokkaSourceSets { named("main") { ... } }

. I've managed to get

includeNotPublic.set

working in that block, but

sourceRoots.from

and

sourceRoots.setFrom

don't do anything.

Hi all, have you tried to generate Javadoc for the sealed class? The gradle log said:

For Environment: expected 1 page, but got 2

And rendered Javadoc with 2 rows for the

Environment

sealed class. Here's class:

public sealed class Environment(internal val url: String) {
    public object QA : Environment("<https://QA>")
    public object PROD : Environment("<https://PROD>")
}

As I understand, there's

FallbackPageMergerStrategy

that spits out the line above, but I believe it is just a side-effect of having 2 of the same

PageNode

. Is this a real bug, or "undocumented behaviour"? Thanks

Hi, I am writing custom DokkaPlugin. And was wondering, is there way to get default value of field from

DProperty

? For example:

class Color{
 var r:Int = 250
}

How to get that

250

value?

Anyone using

externalDocumentationLink

and has it working? I can't get anything external to link

HI, I have multiplatform modules. My new dokkaPlugin is generating documentation for it. But I want to have generated documentation only for one platform (for example android). Could you please recommend me which of extension points will be the best one to filter data by source?

Hi all. I am still struggling configuring the multimodule dokka on android. I am calling as in the documentation :

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

It does find the

task.dokkaHtml

one. Any ideas how I can solve this? Thx.

Hi. Working on Kotlin Multiplatform project and following this example. Running any dokka task getting error:

Cannot change dependencies of dependency configuration ':iosArm64MainImplementationDependenciesMetadata' after task dependencies have been resolved

Anybody else experienced anything similar?

Is there a way to make multi module add type links between modules? At the moment it seems that only external types are linked.

Hey, I am developing JavaDoc for our Android project using Dokka.

dependencies {
    dokkaJavadocPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.10.2")
}

dokkaJavadoc.configure {
    dokkaSourceSets {
        named("main") {
            noAndroidSdkLink.set(false)
        }
    }
}

But I am facing problem when I add a class name from another package. Here is one example - Clicked Url should be:

dokka/javadoc/com/nativewaves/livesdk/root/NWLive.html

but the url is:

dokka/javadoc/com/nativewaves/livesdk/ui/com/nativewaves/livesdk/root/NWLive.html

and also when I use like -

/**
 * @see [BaseViewModel.selectedAudioEntityId]
 */

and in the JavaDoc, there is no content. It just blank in the description column. But in DokkaHtml, it’s working. Thanks…

Hi all! The Dokka docs say that: If you want to generate the documentation as seen from Java perspective, you can add the 

kotlin-as-java

 plugin to the Dokka plugins classpath, eg. in Gradle:

dependencies{
    implementation("...")
    dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:${dokka-version}")
}

Where do I put this in a multi-module multiplatform project? I'm also using

.kts

, and this doesn't compile anywhere. If any of you know anybody who can help I'm willing to pay for the proper config, I just want to get this over with as I've been struggling with Dokka for months now.

Hi all! Is it possible to use a Jekyll Theme (like https://jekyllthemes.io/theme/just-the-docs) inside Dokka when running

dokkajekyll

? Thanks in advance

Hi all! I have issues with code samples in my library documentation. I'd like to use 

@sample

 to reference sample code. Here's my setup: • build.gradle.kts • library code • sample code When running

./gradlew dokkaHtml

I get

...
Cannot find descriptor for package ChipSamples
Cannot find PsiElement corresponding to ChipSamples.chip
...

The code samples are not picked up by dokka. Neither are they visible in the documentation popups in IntelliJ projects which use my library. Some questions I have related to dokka configuration: • Do I have to specify a list of files or can I specify a directory in

samples.from(listOf())

? • Is the file or path in

samples.from(listOf())

absolute or relative (and if so relative to what directory)? • What am I doing wrong? Any help, hints or comments are highly appreciated!