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
2
votes
0 answers

Reference Spek Test in Kotlin documentation

I'm working with the kotlin Spek testing framework and want to link to a Spec in my documentation. But when referencing the Spec IntelliJ shows me that it doesn't find the Spec. That's understandable because the Spec is in a test root. But is there…
nikolausk
  • 31
  • 2
2
votes
1 answer

Dokka source links not created

I'm beginning development on a new library and I want to start the project right with the project setup to generate API documentation using dokka. I'm using gradle as a build tool and I've added the following to my build.gradle file: buildscript { …
Mustafa Ozturk
  • 812
  • 4
  • 19
1
vote
0 answers

How to configure Dokka for a root project and a child project

I have attempted to follow the documentation at https://kotlinlang.org/docs/dokka-gradle.html#multi-project-configuration, but I am not getting the results I want. To start with, my project is set up as: . ├── build.gradle ├── settings.gradle ├──…
Ogre
  • 781
  • 3
  • 10
  • 30
1
vote
0 answers

How to exclude certain packages from API documentation using Dokka

i have two packages "../java/abc"(.java) and "../java/xyz"(.kt) i need to exclude abc package content in dokka html document basically i could see both the package are documented in HTML by dokka. after performing './gradlew dokkaHtml' can…
Noor
  • 11
  • 2
1
vote
0 answers

dokka mess up markdown in javadoc

I am trying to find a way to enable me to use markdown in the Javadoc of my java source code. I tried markdown-doclet, and it works perfectly previously. However, it stops working after java 8, e.g. java 11. I want to give dokka a try. It generates…
Gelin Luo
  • 14,035
  • 27
  • 86
  • 139
1
vote
1 answer

How to modify build.gradle.kts sourceSets for Dokka task?

I am using the Dokka plugin in build.gradle.kts. I am able to generate the Dokka HTML for my source code but have been unable to figure out how to configure the task to include package.md files that document packages. (I am not using modules.) I…
Ellen Spertus
  • 6,576
  • 9
  • 50
  • 101
1
vote
1 answer

How to exclude a particular class in javadoc with (Kdoc Dokka tool)

In the regular Javadoc generation process, we can simply exclude a class or package by adding the below lines. exclude '**/SampleClass.java' exclude '**/com/example/java**' Question: How to exclude/suppress a single Kotlin/java class with the Dokka…
vishnu simha
  • 49
  • 8
1
vote
1 answer

Dokka generates docs with Java syntax instead of Kotlin

I have a module with Kotlin code, and Dokka integrated. When I'm running ./gradlew :core:clean :core:dokkaHtml I'm getting following output with Java syntax, while this code is pure Kotlin: Why and how to fix it?
artem
  • 16,382
  • 34
  • 113
  • 189
1
vote
0 answers

Hide child package for dokka documentation

im want make doc just for main package so i have package with name com.exam.device, but doc from dokka also generate for child package ex: com.exam.device.utils, com.exam.device.utils.breakdown, com.exam.device.list. i need expose doc for main…
Frozencode
  • 57
  • 2
  • 8
1
vote
1 answer

Android library missing documentation on Android studio Kdoc Dokka

When I import my library from maven there's no available documentation on Android Studio/IntelliSense. Even if I set up Dokka properly and javadoc.jar is present on the maven repo, still can't get it to work. This is the gradle script: task…
Emanuel Amiguinho
  • 531
  • 4
  • 12
1
vote
0 answers

Problem with Dokka documentation for specific android classes

could you help with gradle, please? I need to generate documentation only for com.example.kmpcorelib.repo package. Because now I generate all of project and not only classes in repo…
NoName222
  • 51
  • 5
1
vote
0 answers

How to only show the functions that are defined in the class for Dokka Kotlin Kdoc?

Question How to only show the functions that are defined in the class? Screenshots Installation Operating system: Windows Build tool: Gradle v6.8.2 Dokka version: 1.4.20 Additional context Please specify in my Android build.gradle file, what…
shire
  • 61
  • 5
1
vote
1 answer

Problems setting up dokka in Maven

I have added the following to my pom.xml, based on this page: https://github.com/Kotlin/dokka#using-the-maven-plugin pom.xml org.jetbrains.dokka dokka-maven-plugin …
MyName
  • 2,136
  • 5
  • 26
  • 37
1
vote
1 answer

How do you embed runnable sample code in Dokka generated documentation

I'm trying to add sample code to my API Reference. I followed the pattern highlighted here https://androidessence.com/contributing-to-kotlin Was able to create my sample project and all the code runs, duplicating the _sampleUtils that the the kotlin…
Michael Krussel
  • 2,586
  • 1
  • 14
  • 16
1
vote
1 answer

How to customize the auto generated Dokka html to include a header and a footer

I'm looking for a way to customize the html generated by Dokka to include a custom header and a footer. I've previously used Doclava in order to override the template for the generated HTML and was wondering if there was a way to do this in Dokka.…
Eric Hsiao
  • 13
  • 3
1 2 3
4
5 6