Stack Overflow
Stack Overflow

Questions tagged [dokka]

15 questions
17
votes
1 answer

In Kotlin documentation (KDoc), is it possible to link to a specific overloaded method?

Consider the class comment of this Kotlin class: /** * This class has two methods, one that takes one parameters ([foo]), * and another one that takes two parameters ([foo]). **/ class Clazz { /* Foo with one. */ fun foo(a: Int) { } …
treesAreEverywhere
  • 3,722
  • 4
  • 28
  • 51
8
votes
0 answers

How can I generate Javadoc for my Android library with Dokka for both the main and the androidTest source sets?

I am slowly moving my library project from Java to Kotlin. I have a requirement that I also need to provide Javadoc for both the library and the Android instrumentation tests in has. I can't use Javadoc anymore as it dies when it sees a *.kt file.…
Harri
  • 828
  • 10
  • 13
6
votes
1 answer

Dokka 1.4.20 "Nothing to document"

Dokka 1.4.20 does not generate any documentation and returns the following for all tasks > Task :dokkaJavadoc Dokka 1.4.* is an alpha project Initializing plugins Validity check Creating documentation models Exiting Generation: Nothing to…
Robin GM
  • 185
  • 1
  • 8
4
votes
1 answer

How Can I publish the Docs to Github pages after generating it via Dokka (Kotlin)?

I've successfully generated the Kotlin doc using Dokka for Android projects. Now how can I publish to Github Pages.
Manu Ram V
  • 369
  • 1
  • 3
  • 23
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
2
votes
0 answers

Android Dokka and multiple markdown files

I have a module called "Machin" and I want to generate HTML documentation using ./gradlew ./gradlew dokkaHtml. It works but I have some markdown files (.md) in my documentation which I want to convert to html using Dokka. The issue is that there is…
SuperCed
  • 53
  • 5
1
vote
0 answers

"jvm" appearing everywhere while generating the markdown format documentation using Dokka

Whenever I generate markdown format (GFM or Jekyll) using dokka, it generates the documentation with "[jvm]" tag appearing everywhere in every field as show in the screenshot below. Does anyone has any idea why this is happening and what can I do to…
Siddharth Bhatheja
  • 376
  • 3
  • 10
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 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

How @sample is used in dokka API documentation in Android/Kotlin

I am generating the documentation for my public API/functions. It works well. But now I want to include the samples (Example code) also in the documentation. I know we can achieve it using @sample, but somehow I am not able to do it. /** @sample…
Jitender Kumar
  • 11
  • 6
0
votes
0 answers

Dokka does not include members and functions of Activity and Fragment classes

When I run the dokkaHtml gradle task, the generated documentation file includes the classes and their definitions, but not their functions, members and properties (that are not inherited from their classes, but defined by me). This is the dokka…
mcy
  • 1,209
  • 6
  • 25
  • 37
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

Run Gradle task on the basis of Build Variant

I have been struggling on this for past 2 days. There are several solutions on stack overflow which didn't work for me. I am trying to ignore gradle task for prod environment. To execute my task i.e. dokkaHtml on build, I am using this command…
Archi
  • 11
  • 2
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