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

How can I add a footer to Kotlin Dokka docs?

I am looking for a way to include text in the footer of all Dokka generated docs. I am not seeing this option being advertised by the Gradle or Maven plugins for Dokka. Is this possible? Can you point me to a sample?
Antoine Toulme
  • 937
  • 4
  • 15
5
votes
2 answers

How do I make a nested list in Dokka?

Trying to document some Kotlin code with a pretty routine structure: A numbered list. With a bulleted sublist. Where the numbers continue correctly at the top level of the list. What I take to be the official Dokka page doesn't even have the…
0xbe5077ed
  • 4,565
  • 6
  • 35
  • 77
5
votes
1 answer

How to have Dokka generate a deployable github wiki?

As part of building my project, I am looking to have Dokka's maven plugin build a markdown wiki that I can deploy to github without modification. I have no problem building the markdown, and viewing the documentation through intellij, but I am…
Mackenzie Bligh
  • 61
  • 2
5
votes
0 answers

KDoc Annotations not rendered in Dokka generated HTML

I am currently testing the Dokka documentation and some of the annotations I have made are not being rendered. Here are my findings: Classes don't show @sample, and html tags

,

: See SimpleCalculator class documentation If a…
Paula Kristin
  • 813
  • 2
  • 11
  • 27
4
votes
1 answer

How is `@sample` used in ktdoc?

I want to offer code samples in my Kotlin documentation and I found there's a @sample keyword in the documentation. But I'm not sure what I'm supposed to do.
helios
  • 13,574
  • 2
  • 45
  • 55
4
votes
1 answer

Could not determine the dependencies of task ':app:dokka'

I'm trying to use dokka on my android project to generate kdoc. But I have this error when I'm running the script 'modules:app [dokka]' : Could not determine the dependencies of task ':app:dokka'. kotlin.KotlinNullPointerException (no error…
Alan
  • 1,264
  • 1
  • 11
  • 21
4
votes
2 answers

Suppress Dokka complaints about "No documentation for com.foo.Bar$toString()"?

I'm using the Gradle Dokka plugin version 0.9.16-eap-1 to generate documentation for some Kotlin code. I'm a no broken windows kind of person and consequently a bit frustrated that the plugin generates a tonne of messages for classes for which I…
0xbe5077ed
  • 4,565
  • 6
  • 35
  • 77
4
votes
2 answers

Generate kdoc and watch in browser

I don't know how to watch the generated kdoc in my Browser. I'm developing for Android with Kotlin and added dokka as dependency in gradle. The new dokka Task runs without Errors. I added dokka as dependency in my Projects build.gradle dependencies…
lampenlampen
  • 947
  • 6
  • 21
4
votes
1 answer

What version of Dokka goes with what version of Kotlin?

Whenever the Kotlin and Dokka versions are not compatible, things might break oddly in Gradle and Maven builds. I cannot find anywhere a list of the compatible versions between the two. What is the version compatibility? Note: this question is…
Jayson Minard
  • 84,842
  • 38
  • 184
  • 227
4
votes
1 answer

kotlin unresolved KDoc link but IntelliJ doesn't like the import that fixes it

import abc.MyClass.MyEnum; /// from Java /** * [MyClass.MyEnum] */ class efg () : MyClass.MyEnum { return MyClass.MyEnum.BiGNUMBER; } I have something similar to the above in IntelliJ... but it will identify the import as unused - so…
ycomp
  • 8,316
  • 19
  • 57
  • 95
3
votes
1 answer

How does Gradle find org.jetbrains.kotlinx:kotlinx-html-jvm:0.7.2?

I have been trying for hours to get dokka to work under gradle, but I cannot find any combination of versions that is able to resolve dependencies. For example ekolotyluk@MacBook-Pro microservices % ./gradlew dokkaHtml > Task :dokkaHtml…
Eric Kolotyluk
  • 1,958
  • 2
  • 21
  • 30
3
votes
1 answer

Ignore base class View public functions in Subclass documentation with Dokka

I generated documentation with Dokka for a View subclass. Works well, but the docs include the hundreds of public functions of the base View class. Is there a way to only document my subclass public functions? I tried adding these options to the…
P Fuster
  • 2,224
  • 1
  • 20
  • 30
3
votes
1 answer

Consumer of Android library module having to add classpath dependencies

I have an Android app (app module) and an Android library module (lib module), each being a separate Android Studio project, but the app project added lib in as a module dependency in its project. The lib uses JetBrain's Dokka to generate HTML…
Chee-Yi
  • 880
  • 10
  • 17
3
votes
1 answer

How to use Dokka to generate Docs like Kotlinlang.org

AFAIK Kotlin's Documentation was made using Dokka. But the Examples stated in Dokka's Readme is only generating ultra basic webpages/markdown files with no elegance whatsoever. It just looks like this Here's another one by Atrium, docs link. I'm…
Zonily Jame
  • 5,053
  • 3
  • 30
  • 56
3
votes
2 answers

Exclude samples from dokka documentation

I pointed the dokka samples directory to my test sources so I could refer test methods with @sample in my documentation and have examples that are tested. This works, except now dokka generates documentation for my tests as well, which is obviously…
Jilles van Gurp
  • 7,927
  • 4
  • 38
  • 46
1
2
3 4 5 6