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
1
vote
1 answer

Upload Dokka Docs to maven with gitlab pages

I have a multi module project, which I have used dokka to generate KDocs/Javadocs for each of the libraries(modules). I have a private gitlab with multiple projects and I want to use gitlab pages to somehow upload all of these generated index.html…
Kyle
  • 695
  • 6
  • 24
1
vote
2 answers

Using KDoc to document group of variables

So I have this group of constants in a companion object: /** * Lists that can be associated to various media elements */ const val MEDIA_NAME = "Media_name" const val SONGS_IDS = "Songs_ids" const…
Lore
  • 1,286
  • 1
  • 22
  • 57
1
vote
1 answer

How to run Dokka offline in Android

I want to run Dokka offline to generate the documentation as the build running system doesn't need internet access so the document need to be generated offline. Is it possible? If yes, plz suggest the same. Thanks Binay As it doesn't seems working…
Binay Kumar Rana
  • 11
  • 2
1
vote
0 answers

How to add third-party library reference to documentation

I've implemented dokka in top build.gradle apply plugin: 'org.jetbrains.dokka-android' dokka { // These tasks will be used to determine source directories and classpath // see https://github.com/Kotlin/dokka/blob/master/README.md …
Alexey Lariushkin
  • 13
  • 3
1
vote
1 answer

Dokka failure: com.intellij.psi.impl.source.PsiClassImpl cannot be cast to com.intellij.psi.PsiJavaFile

I have a build that generates Android artefacts (mainly an .aar) and bundles in dokka-generated docs (codebase is Kotlin+Java). With some recent changes dokka started failing with this cryptic error: > Task :mylib:dokka FAILED FAILURE: Build failed…
d4vidi
  • 2,407
  • 26
  • 27
1
vote
0 answers

How to set output html global lang attribute in Dokka?

If I run the Dokka gradle script on a PC with English as system language, javadoc/kdoc html files have at the top, but if I do it with the system language set to Spanish, it will replace it with everywhere. Is there…
DuckN'Bear
  • 365
  • 1
  • 4
  • 19
1
vote
1 answer

How to add Dokka to Android project without additional classpath in the dependencies section?

How to add Dokka documentation engine support to Android project without adding to dependencies section additional classpath. I have compatibility issues... Dokka documentation suggests following, but it's classpath breaks my build.. buildscript { …
Alexander Savin
  • 1,952
  • 1
  • 15
  • 30
1
vote
2 answers

Plugin itself can't add buildscript dependencies and then apply dokka-android plugin

We have created GradleMavenPush plugin that performs upload Artifacts (Gradle Android Artifacts, Gradle Java Artifacts and Gradle Kotlin Artifacts) to Maven repositories (JCenter, Maven Central, Corporate staging/snapshot servers and local Maven…
Alexander Savin
  • 1,952
  • 1
  • 15
  • 30
1
vote
2 answers

How do I use multiple source paths with dokka's fatjar?

I'm using dokka to generate some code for a multi-module project. I have successfully been able to generate documentation for a single module with their cli fatjar, but the module is dependent on another one. Let me note that the only difference…
fuzzyweapon
  • 51
  • 6
1
vote
2 answers

Error while Generating Javadoc Kdoc for Kotlin Project using Dokka in Android Studio

I am using Dokka plugin to generate documentation for my kotlin project Here is the plugin url https://github.com/Kotlin/dokka I have followed the instructions this is how my Project.gradle looks like buildscript { ext.kotlin_version =…
KK_07k11A0585
  • 2,381
  • 3
  • 26
  • 33
0
votes
0 answers

How to configure Dokka to generate documentation only for specific classes?

I am working on an SDK, and I noticed that when using Dokka, it generates documentation for all interfaces. However, I only want to generate documentation for the interfaces that are exposed to developers. How can I configure this in my build.gradle…
Colder
  • 1
0
votes
1 answer

Dokka is not generating documentation for test package

I have KDoc style comments in my tests code and I want to generate documentation using Kotlin DSL Gradle dokkaHtml tasks. But after successfully executing the task it says "Exiting Generation: Nothing to document". I have tried to set sources but…
miluni
  • 3
  • 1
0
votes
1 answer

Problems with Dokka for private functions

With Dokka 1.8.10 i got Problemsto show the private functions of my classes. I tried includeNonPublic.set(true) with an older version (which worked) but for 1.8.10 this mehtod is deprecated... I'm searchin for an solution, that shows my private…
Niklas
  • 1
0
votes
0 answers

How to add additional markdown content to Dokka-generated (Kotlin KDoc) documentation?

I'm trying to add additional documentation pages (not tied to a class or package element) to a Dokka-generated documentation tree. I know that I can add a module.md or a file for each package, but if I want to add additional pages (e.g. an…
LBushkin
  • 129,300
  • 32
  • 216
  • 265
0
votes
0 answers

How can we Create/Generate UML or Class Diagrams in Kotlin Language Android Studio

I have getting issue to generate UML diagram in kotlin code. I have some java classes for java classes I have used to PlantUML parser plugin in android Studio to generate java code to UML diagrams but I'm facing problem to generate Kotlin code to…
Santosh Bachkar
  • 460
  • 4
  • 14
1 2 3 4
5
6