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

How can I suppress Dokka documentation for specific classes?

I'm trying to generate nice API docs for a library I'm working on, and I haven't found a way to keep Dokka from generating empty documentation pages for generated code like the R class in my package. I'm already using packageOptions { prefix =…
Greg
  • 10,360
  • 6
  • 44
  • 67
3
votes
2 answers

How to generate javadoc jar for repository upload with dokka?

I have recently migrated a java component to kotlin. So far when I used the maven release plugin, it automatically generated the javadoc too and it was also uploaded to oss.sonatype.com. Dokka at the other hand does not seem to be integrated with…
kocka
  • 657
  • 6
  • 14
3
votes
0 answers

Dokka javadoc jar doesn't work with Intellij IDE

I have following configuration in build.gradle file: buildscript { ext.dokka_version='0.9.15' repositories { jcenter() } dependencies { classpath "org.jetbrains.dokka:dokka-gradle-plugin:$dokka_version" …
aleks.stan
  • 35
  • 5
3
votes
1 answer

Dokka uses fully qualified class names

I'm using dokka to auto generate javadoc for me. Though when it encounters any class not from my project it uses fully qualified names. Is it possible to use only class names and make dokka provide a link for it? For example: java.lang.String…
Mibac
  • 8,990
  • 5
  • 33
  • 57
3
votes
1 answer

What is the correct name for Kotlin inline documentation?

Since KDoc documentation generation engine is abandoned in favor of Dokka, should Kotlin documentation be referred to as "KDoc comments", or as "Dokka comments"?
gvlasov
  • 18,638
  • 21
  • 74
  • 110
2
votes
1 answer

How to distribute javadoc along with my jar library artifact using maven repository?

I have a Kotlin JVM library, which I distribute using as a .jar artifact via maven repository. I would like to provide some Kdocs for it, so that it can be used via IntelliJ Idea's quick docs tool (ctrl+q). I use dokka gradle plugin to generate html…
David Zhubrev
  • 46
  • 3
2
votes
0 answers

Execution failed for task ':app:dokkaHtml'

The build is successful, but fails when running gradlew dokkaHtml in terminal. Have tried to search for the error message, but couldn't find anything. build.gradle file (modul) plugins { id 'com.android.application' id…
raily2595
  • 21
  • 1
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
2
votes
0 answers

gradle multiple repositories doesn't work

repositories { maven { url "https://maven.aliyun.com/repository/gradle-plugin" } gradlePluginPortal() } error: > Could not resolve all files for configuration ':buildSrc:compileClasspath'. > Could not find dokka-gradle-plugin-1.5.0.jar…
FredSuvn
  • 1,869
  • 2
  • 12
  • 19
2
votes
2 answers

KDoc / Dokka: Ignore inherited methods in subclass

I am generating documentation using KDoc/Dokka for an android library. I have a custom view, which extends LinearLayout. The problem is that LinearLayout contains hundreds of public methods. Dokka generates empty documentation for all of these…
Hannes Hertach
  • 499
  • 5
  • 23
2
votes
1 answer

How to configure Dokka for package documentation using Gradle?

I am unable to configure Dokka to include the documentation of my packages without using a full absolute path from the root of the file system. I have in my Gradle file (the includes line is the one in problem): dokka { outputFormat = 'html' …
Pierre Thibault
  • 1,895
  • 2
  • 19
  • 22
2
votes
1 answer

KDoc: change parameters order

I have the following parameters in a companion object on Kotlin companion object Constants { /** * Values for the various type of connection that a device can have. */ const val CONNECTION_KEY = "Connection_type" const val…
Lore
  • 1,286
  • 1
  • 22
  • 57
2
votes
1 answer

Gradle sync file fails every time, implementing Dokka

Tried to implement Dokka in code but keep running into Gradle sync failed: Could not find method classpath() for arguments [org.jetbrains.dokka:dokka-gradle-plugin:0.9.16-eap-2] on object of type…
KKNg
  • 87
  • 1
  • 5
2
votes
2 answers

Gradle: Unsupported Modules Detected on non-Android project

I'm getting this warn/error on my gradle project: Unsupported Modules Detected: Compilation is not supported for following modules: io.github.dogo-Dogo, Dogo_main, Dogo_test. Unfortunately you can't have non-Gradle Java modules and Android-Gradle…
NathanPB
  • 685
  • 1
  • 7
  • 22
2
votes
1 answer

Android Dokka - Only generate docs for my code and skip everything else

I'm using Dokka v0.9.17 for Android. When I run ./gradlew dokka it generates the docs but it include so many packages that I don't care about like android.support.fragment and packages for all the third party libraries. How can I tell Dokka to only…
Alireza Ahmadi
  • 5,122
  • 7
  • 40
  • 67
1 2
3
4 5 6