Stack Overflow
Stack Overflow

Questions tagged [kotlin-dokka]

Dokka is a documentation generation engine for the Kotlin language, handling both JavaDoc and KDoc style documentation comments.

Dokka is a documentation generation engine for the Kotlin language, handling both JavaDoc and KDoc style documentation comments. It has plugins available for Maven and Gradle and the project is open-source.

See: Dokka project page

89 questions
0
votes
0 answers

API documentation for KMM modules?

I am using KMM for writing the business logic and further exporting to native ios, Android, and JS libraries. I followed the Dokka` documentation to write the documentation which is working perfectly fine for me. However, Is there a way to convert…
Amit Pal
  • 10,604
  • 26
  • 80
  • 160
0
votes
0 answers

Android dokka multi project documentation

I just start using Dokka for Android app documentation. This is the issue I'm facing: I tried dokkaHtml and dokkaHtml multi. which both are great for single module and multi module documentation, BUT we would like to generate a main dokka "website"…
arist0v
  • 79
  • 8
0
votes
2 answers

Kotlin multiplatform publish with dokka and sources

I am struggling to publish a Kotlin multiplatform project properly to maven (for now mavenLocal). I can add the dependency to another multiplatform project and use the code but I don't get any documentation and I am not sure if I am doing something…
Simon
  • 148
  • 3
  • 13
0
votes
1 answer

Dokka for data class is not displayed in Android Studio

Did anyone encounter the same issue? When using Dokka to document a data class /** * Data class for which we want documentation */ data class DokkaData( /** A String value */ val aString: String, /** An Integer value */ val anInt:…
poilu933
  • 61
  • 8
0
votes
1 answer

Linking JS stdlib to generated kdoc

Developing a Kotlin/JS project, we are generating KDoc using Dokka Maven plugin. However standard JS library classes are presented as ERROR CLASS in the generated doc. Example: having function like this: fun HTMLElement.component(label: String,…
mpts.cz
  • 221
  • 1
  • 10
0
votes
1 answer

Gradle runs out of memory on Travis

I'm trying to get this build to pass on Travis, but Gradle runs out of memory when running the ./gradlew :chronolens-test:dokkaJavadoc task. When I run the task locally, it passes. I tried increasing the Gradle memory (e.g., in in this commit), but…
Andrei Heidelbacher
  • 125
  • 3
  • 8
0
votes
1 answer

Unable to generate Kdoc using Dokka

I am trying to generate a KDoc documentation in an Android project. Following are the relevant files for adding this functionality. build.gradle (root level): buildscript { ... ext.dokka_version = "0.10.1" repositories { ... …
Ameya Deshpande
  • 71
  • 4
0
votes
1 answer

Readily available examples of documentation built with Dokka?

The official documentation on Dokka says that Dokka can output result in different formats: Output formats html - minimalistic html format used by default, Java classes are translated to Kotlin javadoc - looks like normal Javadoc, Kotlin classes…
DocumentationNerd
  • 3
  • 4
0
votes
1 answer

Gradle Dokka refuses to run again

My Project structure is a multi-module, each module has same dokka tasks The gradle dokka plugin gives me some very strange results: First of all it often need some artifacts of my build, like other modules.jar files, if those are not present if…
Kitesurfer
  • 3,438
  • 2
  • 29
  • 47
0
votes
0 answers

How to include annotations in generated kdoc

I have a spring boot project with methods that have annotations on them, e.g.: @PreAuthorize("hasPermission('organization', '$USERS_MANAGE' )") fun listUsers(userContext: UserContext): List { return…
Dambakk
  • 595
  • 4
  • 20
0
votes
1 answer

Gradle task starts without invoking

I am trying to build javadoc using Dokka for javadoc and kotlindoc task dokkaDoc(type: org.jetbrains.dokka.gradle.DokkaAndroidTask) { println("Inside the task dokkaDoc") moduleName = 'data' outputFormat = 'javadoc' outputDirectory…
dcanh121
  • 4,665
  • 11
  • 37
  • 84
0
votes
1 answer

Default buildDir for kotlin projects

I'm trying to add documentation to my project with dokka https://kotlinlang.org/docs/reference/kotlin-doc.html I'm not quite able to figure out where the javadocs are located after doing a successful ./gradlew build. It says there they should be in…
nz_21
  • 6,140
  • 7
  • 34
  • 80
0
votes
0 answers

Cannot navigate to @sample tag

In standard library of Kotlin we have Preconditions.kt that uses @sample tag: /** * Throws an [IllegalStateException] if the [value] is false. * * @sample samples.misc.Preconditions.failCheckWithLazyMessage */ @kotlin.internal.InlineOnly public…
Marek J
  • 1,364
  • 8
  • 18
  • 33
-1
votes
1 answer

Dokka not generate documentaion

In need to generate an internal documentation with Dokka, But i've that error ... I don't know why build gradle : app build gradle project the error Thanks dudes :)
Dioxygene
  • 1
  • 2
1 2 3 4 5
6