https://kotlinlang.org logo
Docs
Join the conversationJoin Slack
Channels
100daysofcode
100daysofkotlin
100daysofkotlin-2021
advent-of-code
aem
ai
alexa
algeria
algolialibraries
amsterdam
android
android-architecture
android-databinding
android-studio
androidgithubprojects
androidthings
androidx
androidx-xprocessing
anime
anko
announcements
apollo-kotlin
appintro
arabic
argentina
arkenv
arksemdevteam
armenia
arrow
arrow-contributors
arrow-meta
ass
atlanta
atm17
atrium
austin
australia
austria
awesome-kotlin
ballast
bangladesh
barcelona
bayarea
bazel
beepiz-libraries
belgium
berlin
big-data
books
boston
brazil
brikk
budapest
build
build-tools
bulgaria
bydgoszcz
cambodia
canada
carrat
carrat-dev
carrat-feed
chicago
chile
china
chucker
cincinnati-user-group
cli
clikt
cloudfoundry
cn
cobalt
code-coverage
codeforces
codemash-precompiler
codereview
codingame
codingconventions
coimbatore
collaborations
colombia
colorado
communities
competitive-programming
competitivecoding
compiler
compose
compose-android
compose-desktop
compose-hiring
compose-ios
compose-mp
compose-ui-showcase
compose-wear
compose-web
connect-audit-events
corda
cork
coroutines
couchbase
coursera
croatia
cryptography
cscenter-course-2016
cucumber-bdd
cyprus
czech
dagger
data2viz
databinding
datascience
dckotlin
debugging
decompose
decouple
denmark
deprecated
detekt
detekt-hint
dev-core
dfw
docs-revamped
dokka
domain-driven-design
doodle
dsl
dublin
dutch
eap
eclipse
ecuador
edinburgh
education
effective-kotlin
effectivekotlin
emacs
embedded-kotlin
estatik
event21-community-content
events
exposed
failgood
fb-internal-demo
feed
firebase
flow
fluid-libraries
forkhandles
forum
fosdem
fp-in-kotlin
framework-elide
freenode
french
fritz2
fuchsia
functional
funktionale
gamedev
ge-kotlin
general-advice
georgia
geospatial
german-lang
getting-started
github-workflows-kt
glance
godot-kotlin
google-io
gradle
graphic
graphkool
graphql
graphql-kotlin
graviton-browser
greece
grpc
gsoc
gui
hackathons
hacktoberfest
hamburg
hamkrest
helios
helsinki
hexagon
hibernate
hikari-cp
hire-me
hiring
hongkong
hoplite
http4k
hungary
hyderabad
image-processing
india
indonesia
inkremental
intellij
intellij-plugins
intellij-tricks
internships
introduce-yourself
io
ios
iran
israel
istanbulcoders
italian
jackson-kotlin
jadx
japanese
jasync-sql
java-to-kotlin-refactoring
javadevelopers
javafx
javalin
javascript
jdbi
jhipster-kotlin
jobsworldwide
jpa
jshdq
juul-libraries
jvm-ir-backend-feedback
jxadapter
k2-early-adopters
kaal
kafka
kakao
kalasim
kapt
karachi
karg
karlsruhe
kash_shell
kaskade
kbuild
kdbc
kgen-doc-tools
kgraphql
kinta
klaxon
klock
kloudformation
kmdc
kmm-español
kmongo
knbt
knote
koalaql
koans
kobalt
kobweb
kodein
kodex
kohesive
koin
koin-dev
komapper
kondor-json
kong
kontent
kontributors
korau
korean
korge
korim
korio
korlibs
korte
kotest
kotest-contributors
kotless
kotlick
kotlin-asia
kotlin-beam
kotlin-by-example
kotlin-csv
kotlin-data-storage
kotlin-foundation
kotlin-fuel
kotlin-in-action
kotlin-inject
kotlin-latam
kotlin-logging
kotlin-multiplatform-contest
kotlin-mumbai
kotlin-native
kotlin-pakistan
kotlin-plugin
kotlin-pune
kotlin-roadmap
kotlin-samples
kotlin-sap
kotlin-serbia
kotlin-spark
kotlin-szeged
kotlin-website
kotlinacademy
kotlinbot
kotlinconf
kotlindl
kotlinforbeginners
kotlingforbeginners
kotlinlondon
kotlinmad
kotlinprogrammers
kotlinsu
kotlintest
kotlintest-devs
kotlintlv
kotlinultimatechallenge
kotlinx-datetime
kotlinx-files
kotlinx-html
kotrix
kotson
kovenant
kprompt
kraph
krawler
kroto-plus
ksp
ktcc
ktfmt
ktlint
ktor
ktp
kubed
kug-leads
kug-torino
kvision
kweb
lambdaworld_cadiz
lanark
language-evolution
language-proposals
latvia
leakcanary
leedskotlinusergroup
lets-have-fun
libgdx
libkgd
library-development
linkeddata
lithuania
london
losangeles
lottie
love
lychee
macedonia
machinelearningbawas
madrid
malaysia
mathematics
meetkotlin
memes
meta
metro-detroit
mexico
miami
micronaut
minnesota
minutest
mirror
mockk
moko
moldova
monsterpuzzle
montreal
moonbean
morocco
motionlayout
mpapt
mu
multiplatform
mumbai
munich
mvikotlin
mvrx
myndocs-oauth2-server
naming
navigation-architecture-component
nepal
new-mexico
new-zealand
newname
nigeria
nodejs
norway
npm-publish
nyc
oceania
ohio-kotlin-users
oldenburg
oolong
opensource
orbit-mvi
osgi
otpisani
package-search
pakistan
panamá
pattern-matching
pbandk
pdx
peru
philippines
phoenix
pinoy
pocketgitclient
polish
popkorn
portugal
practical-functional-programming
proguard
prozis-android-backup
pyhsikal
python
python-contributors
quasar
random
re
react
reaktive
realm
realworldkotlin
reductor
reduks
redux
redux-kotlin
refactoring-to-kotlin
reflect
refreshversions
reports
result
rethink
revolver
rhein-main
rocksdb
romania
room
rpi-pico
rsocket
russian
russian_feed
russian-kotlinasfirst
rx
rxjava
san-diego
science
scotland
scrcast
scrimage
script
scripting
seattle
serialization
server
sg-user-group
singapore
skia-wasm-interop-temp
skrape-it
slovak
snake
sofl-user-group
southafrica
spacemacs
spain
spanish
speaking
spek
spin
splitties
spotify-mobius
spring
spring-security
squarelibraries
stackoverflow
stacks
stayhungrystayfoolish
stdlib
stlouis
strife-discord-lib
strikt
students
stuttgart
sudan
swagger-gradle-codegen
swarm
sweden
swing
swiss-user-group
switzerland
talking-kotlin
tallinn
tampa
teamcity
tegal
tempe
tensorflow
terminal
test
testing
testtestest
texas
tgbotapi
thailand
tornadofx
touchlab-tools
training
tricity-kotlin-user-group
trójmiasto
truth
tunisia
turkey
turkiye
twitter-feed
uae
udacityindia
uk
ukrainian
uniflow
unkonf
uruguay
utah
uuid
vancouver
vankotlin
vertx
videos
vienna
vietnam
vim
vkug
vuejs
web-mpp
webassembly
webrtc
wimix_sentry
wwdc
zircon
Powered by Linen
dokka
  • e

    elect

    08/27/2021, 4:52 AM
    just a question, I'm looking to update the following platform constraints on dokka
    api("org.jetbrains.dokka:dokka-gradle-plugin:1.4.30")
    according to the docs now I should write
    api("org.jetbrains.dokka:kotlin-as-java-plugin:1.5.0")
    am I right?
    m
    • 2
    • 2
  • t

    TheOnlyTails

    08/31/2021, 12:55 PM
    How can I change the logo in the HTML docs? Trying to add the
    dokka-base
    plugin via buildscript dependencies gives me this error:
    Caused by: java.lang.NoSuchFieldError: KOTLIN_STAT_LABEl_PROPERTY
    m
    a
    • 3
    • 10
  • t

    theapache64

    09/03/2021, 3:48 PM
    How do i use Dokka with
    maven-publish
    plugin to see the documentation in IDE’s documentation popup?
    a
    j
    • 3
    • 10
  • d

    Doug Chappelle

    09/06/2021, 5:21 PM
    Is there a way to have dokka omit certain things? For example I have a Kotlin data class that gets documented but I would like to omit one of its properties from the generated documentation.
    ➕ 1
    l
    m
    • 3
    • 3
  • d

    David Rubio

    09/17/2021, 11:59 AM
    How can I configure
    separateInheritedMembers
    or
    suppressInheritedMembers
    in a multimodule Android project, in Groovy? I want to configure everything from the root project, if possible.
    m
    • 2
    • 7
  • t

    Thanos Psaridis

    09/21/2021, 5:54 PM
    I'm facing an issue that drives me crazy. I'm trying to create a reusable version of maven publish instructions for my library. I try to put some code in buildSrc and everything seems to work fine except for the dokka plugin
    DokkaTask
    cannot be resolved even though I've added the dokka plugin in plugins{} block in build.gradle.kts Any idea why is this happening and how I can fix this?
    m
    • 2
    • 6
  • t

    TheOnlyTails

    09/22/2021, 8:49 AM
    I'm trying to make a plugin for generating SvelteKit versions of Dokka HTML documentation. Where can I find the code for the
    dokkaHtml
    task? I can't find it in the repo.
    m
    • 2
    • 5
  • s

    simon.vergauwen

    09/22/2021, 6:49 PM
    Hey everyone, Does anyone know what the correct syntax is for this in Kotlin Gradle Script? I cannot find an example for it.
    j
    • 2
    • 5
  • s

    simon.vergauwen

    09/22/2021, 6:49 PM
    Untitled.kt
    • 1
    • 3
  • j

    Jan

    10/07/2021, 11:08 AM
    Can I exclude a group from the dokkaHtml task?
    v
    • 2
    • 1
  • c

    Callum Seabrook

    10/09/2021, 10:40 AM
    Anyone know if it's possible to add custom tags with a Dokka plugin? You know like how you can do it with JavaDocs.
    v
    • 2
    • 3
  • c

    Callum Seabrook

    10/09/2021, 10:42 AM
    Also, will there be any improvements to linking methods in the future so that we can properly resolve the overload we want like you can do in JavaDocs?
    v
    • 2
    • 2
  • e

    Eugene

    10/13/2021, 7:07 AM
    Hey folks! A little survey :kotlinnew: What UI do u like more for symbols that have the same declaration and docs in multiplatform projects? 1. 🍔 merged (if tabs have the same content) 2. 🍕 divided (even tabs have the same content) 3. 🤔 my variant (in comments) Please share pros and cons of solution you've chosen. Thanks!
    2️⃣ 9
    🤔 3
    🍕 8
    🍔 7
    1️⃣ 5
    a
    m
    +4
    • 7
    • 12
  • r

    René

    10/19/2021, 8:21 AM
    Is there a way to add custom links to the navigation?
    v
    • 2
    • 3
  • t

    TheOnlyTails

    10/24/2021, 6:03 PM
    I saw there was a commit to the repo which added support for dark mode: https://github.com/Kotlin/dokka/commit/742f96bdf5c0b842e68dfaf43f4ab3446e87e3df How do I enable that in my docs?
    a
    • 2
    • 5
  • s

    Sylvain Patenaude

    10/25/2021, 7:52 PM
    I just upgraded from dokka 0.10.1 to 1.4.30. Is there a simple way to migrate this code ? I'm trying to follow the migration steps, but have a hard time with this, especially the
    outputDirectory
    . Thanks in advance!
    dokka {
        outputFormat = 'html'
        outputDirectory = "$buildDir/doc"
    }
    v
    e
    j
    • 4
    • 10
  • b

    bod

    10/29/2021, 9:53 AM
    A KDoc question: if I have several versions of a method with different parameters, is there a way to link to a specific one with inline markup?
    [fooBar(String)]
    doesn't seem to work. edit: found this issue so I guess it's not possible 😅
    ⭐ 1
    ➕ 1
    m
    • 2
    • 1
  • j

    Javier

    11/04/2021, 1:53 PM
    Is there anyplace to see how create a @sample? I am getting unresolved references
    v
    • 2
    • 1
  • s

    simon.vergauwen

    11/11/2021, 5:16 PM
    Hey everyone 👋 I’m using KotlinX Knit with Dokka (html), but my README, and links seem to be broken. Any ideas? https://nomisrev.github.io/Continuation/ https://github.com/nomisRev/Continuation
    b
    • 2
    • 12
  • j

    Joffrey

    11/17/2021, 10:42 AM
    Is Dokka 1.6.0 going to follow the Kotlin release soon? Or is the release cycle independent?
    v
    • 2
    • 1
  • s

    simon.vergauwen

    11/17/2021, 10:48 AM
    Anyone has any idea on how to fix these issues between KotlinX Knit, and Kotlin Dokka?
    v
    • 2
    • 3
  • k

    Kuba Petržílka

    11/19/2021, 1:52 PM
    Hello, I m struggling with the code indentation in a module documentation: It looks OK in the markdown preview, but in the html docs generated by dokka, it is broken - there is some extra indentation if the code block has multiple lines. Also, I am not able to use relative links: [link](http://example.com/sth/) works fine, but [link](/some/relative/path) just renders "/some/relative/path" as plain text .. or how can I link to another module or a specific package?
    v
    • 2
    • 1
  • a

    Amol

    11/19/2021, 3:20 PM
    Hi I am trying to generate docs using Dokka in my kotlin project. The gradle files are defined in groovy format Gradle version: 5.6.4 Dokka version: 1.5.0 I simply added the plugin to my root build.gradle file
    plugins {
        id 'org.jetbrains.dokka' version '1.5.0'
    }
    This gradle synced successfully. When I now try to run
    ./gradlew dokkaJavadoc
    or
    ./gradlew dokkaHtml
    I get this error:
    $ ./gradlew dokkaHtml
    
    FAILURE: Build failed with an exception.
    
    * What went wrong:
    org/jetbrains/kotlin/gradle/dsl/KotlinSingleTargetExtension
    > org.jetbrains.kotlin.gradle.dsl.KotlinSingleTargetExtension
    v
    • 2
    • 2
  • k

    Kuba Petržílka

    11/19/2021, 5:04 PM
    I have another issue, Dokka is removing the generics from the code blocks.. 😞
    suspend fun sampleProcessingFunction(message: AmqpMessage<String>): Outcome<AmqpConsumingError, Unit> {
    becomes just:
    suspend fun sampleProcessingFunction(message: AmqpMessage): Outcome {
    first day I m using it and I already found 3 really bad bugs.. or am I doing something wrong?
    v
    g
    • 3
    • 13
  • k

    Kuba Petržílka

    11/19/2021, 5:07 PM
    4th bug is that on JDK16 the
    dokkaHtml
    tasks randomly (like 3 out 5 runs) throws OutOfMemory exception
    v
    • 2
    • 1
  • s

    simon.vergauwen

    11/23/2021, 5:04 PM
    Ouch… https://blog.jetbrains.com/kotlin/2021/11/dokka-beta/?utm_source=twitter&amp;utm_medium=social&amp;utm_campaign=dokka-beta Scrolling up in the comments it doesn’t look like a great beta.
    i
    • 2
    • 3
  • r

    Robert Jaros

    11/23/2021, 5:14 PM
    I would love to use 1.6.0, but I'm blocked by the two years old bug https://github.com/Kotlin/dokka/issues/537. The problem was reported as warning until 1.5.30, but now its treated as error and the task execution fails.
    👍 1
    ➕ 2
    👀 1
    v
    • 2
    • 2
  • t

    Trevor Stone

    11/23/2021, 7:25 PM
    has 1.6.0 been published to maven?
    m
    • 2
    • 5
  • s

    Stewart Stewart

    11/24/2021, 5:03 PM
    Is there a live example of dokka 1.6 generated html to try online?
    i
    s
    +4
    • 7
    • 15
  • k

    Kuba Petržílka

    11/24/2021, 8:12 PM
    tried to upgrade to 1.6.0 .. but I don't see the navigation header in the multimodule, multiplatform project, and it isn't rendering properly:
    a
    • 2
    • 2
Powered by Linen
Title
k

Kuba Petržílka

11/24/2021, 8:12 PM
tried to upgrade to 1.6.0 .. but I don't see the navigation header in the multimodule, multiplatform project, and it isn't rendering properly:
a

atyrin

11/25/2021, 10:33 AM
I’ve created an issue for rendering problems, thanks! Regarding the navigation header, could you share a screenshot of the problem and maybe a sample project configuration?
k

Kuba Petržílka

11/26/2021, 10:55 AM
It is actually not the navigation header, but the left-side bar. And I've just realized that it is missing only when I open the generated html file locally, when it is served from a http server, then it appears:
:yes: 1
View count: 11