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
  • m

    mkobit

    02/13/2018, 8:25 PM
    have other people ran into the
    Can't find node by signature ...
    for enum values like
    [StandardOpenOption.APPEND]
    (for https://docs.oracle.com/javase/8/docs/api/java/nio/file/StandardOpenOption.html#APPEND )?
    • 1
    • 1
  • s

    sdeleuze

    02/15/2018, 1:39 PM
    Hey, any plan to release 0.9.16 ? (I still can't use EAP in Spring build)
    s
    • 2
    • 2
  • s

    sebastien.rouif

    02/27/2018, 1:11 PM
    Hi, I'm building and sdk which gets shipped with documentation. We used to create the documentation with regular Javadoc. Now that we have koltin classes we are migrating to Dokka. Some classes should not be documented. In Koltin it's easy as they are marked as
    internal
    withe the flag
    includeNonPublic = false
    in my Dokka configuration. In Java I can't find a way to do the same (previously we had a list of files or directory to document). Is there anything I missed in the documentation ?
    s
    c
    • 3
    • 9
  • m

    madorb

    02/27/2018, 8:45 PM
    Can't find node by signature not implemented for value-parameter vararg errors
    function is:
    fun createErrors(vararg errors: Error): Set<Error> =...
    s
    • 2
    • 4
  • s

    salomonbrys

    03/06/2018, 1:57 PM
    Hi there, I'd like to know if dokka is still officially supported by JB, and what is the agenda. At the moment, dokka does not support multi-platform modules, which is kind of amazing, considering how much you guys are pushing it. The github repo lists 10 commits in 2 month and 72 issues, some being critical (ex: NullPointerException in Gradle). My understanding is that JB is promoting Kotlin tools as much as the language itself, which is an excellent thing. But I find baffling that a tool so critical as the one allowing you to properly document your code is so far behind.
    👍 4
    • 1
    • 1
  • a

    adrik77

    03/23/2018, 2:18 PM
    @semoro 👆, sorry to pointing directly to you, but according to @tapchicoma you are the only active maintainer of dokka
    s
    • 2
    • 6
  • h

    holgerbrandl

    03/28/2018, 4:23 PM
    Can I tell dokka to inherit the docs of another method. Like in the example I’d like to simply reuse the javadoc for the second impl:
    k
    s
    • 3
    • 3
  • a

    adam-mcneilly

    04/02/2018, 6:37 PM
    Is there a standard for documenting sealed classes? Should I write the kdocs above each class declaration, or would it be done just once at the top sealed class? I think the former makes more sense, as different sealed classes can have different properties, but I want to be sure.
    👍 1
    s
    • 2
    • 3
  • z

    Zac Sweers

    04/28/2018, 10:26 PM
    lots of un-ack’d issues, PRs, doesn’t work with the current major version of the android gradle plugin, etc 😕
    s
    • 2
    • 9
  • a

    andrei.heidelbacher

    05/05/2018, 12:53 PM
    Hello! Does anyone have any news on this issue? https://github.com/Kotlin/dokka/issues/165
    s
    • 2
    • 1
  • r

    robfletcher

    05/07/2018, 4:23 PM
    Is there a way to include source code snippets in Dokka? I’m working on a library and I really like the idea of having very rich API docs, however, I’m also super-paranoid of having broken code samples or it just being a chore to maintain as I evolve the API. I know ratpack.io does something like that with Javadocs but it’s a custom layer over the regular tooling.
    s
    • 2
    • 3
  • t

    tvede

    05/16/2018, 7:18 PM
    Hey guys, So I have kinda hit a dead spot like this issue: https://github.com/Kotlin/dokka/issues/160 and wanted to know if there is anything obvious that Im missing ? I cannot find anywhere, any way to add nullability annotations to the resulting javadoc…
    s
    • 2
    • 4
  • s

    sebastien.rouif

    06/07/2018, 5:39 PM
    Hi there, This is parly related to dokka. As partof an SDK which we created and documented, we manage to generate documentation. However the SDK is obfuscated and the documentation removed when it's published. Is there a way to import the javadoc/markdown into intelliJ/AndroidStudio ?
    s
    • 2
    • 9
  • c

    christophsturm

    06/13/2018, 8:33 AM
    is there something like this planned for kdoc? is it easy to do with dokka? https://github.com/tkawachi/sbt-doctest
    s
    • 2
    • 9
  • j

    jrider

    06/13/2018, 1:55 PM
    Is it possible to include images in the generated docs similar to the doc-files directory in javadoc?
    s
    • 2
    • 3
  • s

    snowe

    07/01/2018, 4:16 PM
    Hmm. it appears if you provide a documentation section the sample will only show up on the individual page instead of the summary page.
    s
    • 2
    • 2
  • j

    jeggy

    07/24/2018, 7:45 PM
    I just found Dokka and I'm new to generating static documentation pages. How do you guys theme up or somewhat make it look nice?
    s
    • 2
    • 4
  • p

    pardom

    07/26/2018, 3:13 PM
    Does someone know how to populate the
    Summary
    for packages? https://github.com/pardom/kombinators/blob/master/docs/kombinators/index.md
    • 1
    • 3
  • p

    pardom

    07/26/2018, 3:14 PM
    Also, I can’t figure out why source links aren’t being generated: https://github.com/pardom/kombinators/blob/master/build.gradle#L18-L22
    r
    • 2
    • 4
  • r

    robstoll

    09/13/2018, 2:25 PM
    any plans to bring in more contributors with the right to merge things? Dokka is moving so slowly. Way too slowly IMO. I fixed a bug in June and the corresponding pull-request is good to merge but nothing happens.
    ➕ 1
    👍 2
    s
    s
    • 3
    • 2
  • e

    egorand

    09/13/2018, 7:58 PM
    also, any updates on Dokka + multiplatform? is it gonna be supported when 1.3 gets released?
    s
    • 2
    • 2
  • s

    sdeleuze

    09/17/2018, 5:53 PM
    How should I make Dokka code samples working correctly in IDEA?
    s
    • 2
    • 3
  • s

    sdeleuze

    09/19/2018, 6:57 PM
    @semoro Any chance to have a feedback on the PR to merge for proper Kotlin DSL support and the issue described above that I need to fix before my upcoming talks?
    s
    • 2
    • 1
  • e

    eskatos

    09/27/2018, 9:50 AM
    @semoro could you or anyone else in charge of Dokka please consider https://github.com/Kotlin/dokka/pull/358 soon?
    s
    • 2
    • 7
  • r

    robfletcher

    10/02/2018, 10:55 PM
    Is there a way to discriminate between method overloads in KDoc?
    s
    r
    s
    • 4
    • 3
  • r

    robstoll

    10/11/2018, 1:43 PM
    does doc inheritance not work for expected -> actual as it works with interface -> class?
    s
    e
    • 3
    • 2
  • r

    raulraja

    11/17/2018, 4:09 AM
    Hi, loving Dokka and what I'm able to do with it in the Arrow docs. I have a question about overriding default labels. Can the default labels such as
    Inheritors
    that appear in a type's doc be modified to something else through configuration or some other way? Thanks!
    s
    • 2
    • 2
  • r

    raulraja

    11/18/2018, 3:52 AM
    Is there a way to override in Dokka the default generation it does for markdown, html or jekyll files? I would like to remove some sections and add new ones in the lists of types in a given package.
    s
    • 2
    • 2
  • s

    sdeleuze

    12/02/2018, 10:15 PM
    @semoro The fact that https://github.com/Kotlin/dokka/pull/358 is still not merged and not available in a release is frustrating. Is there anything that prevents merging it and releasing a new version of Dokka to provide us a usable Kotlin Gradle DSL support (kindly contributed by Gradle team which is now final with Gradle 5.0)?
    ☝️ 2
    s
    • 2
    • 6
  • r

    raulraja

    12/03/2018, 12:16 PM
    Can Dokka be used to access programmatically the kdocs comments via reflection or though some other way given a fqn classed name?
    s
    • 2
    • 2
Powered by Linen
Title
r

raulraja

12/03/2018, 12:16 PM
Can Dokka be used to access programmatically the kdocs comments via reflection or though some other way given a fqn classed name?
s

semoro

12/03/2018, 12:24 PM
No, KDoc’s aren’t persisted in compiled code
r

raulraja

12/03/2018, 12:26 PM
ok, thanks
View count: 7