https://kotlinlang.org logo
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
benchmarks
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
confetti
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
lincheck
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
Title
d

David Hamilton

11/13/2018, 8:30 AM
As a regular user of the Dash offline API reference browser, I'm seeing a lot of uninstallable javadoc libraries (
httk4k
and
vavr-kotlin
for instance). Both have published javadoc jars that are empty apart from the MANIFEST, and both use Gradle to build. Also, the Kotlin stdlibs are missing from the available docsets. It feels that this is a systemic problem for Kotlin, and one that is a real negative for someone, like me, who likes to read the statement of how the code is intended to be used, rather than just relying on the current implementation (in source) Are there any plans to fix this?
a

Andreas Sinz

11/13/2018, 8:44 AM
http4k
doesn't have any documentation in the code and I'd guess that
vavr-kotlin
just adds an empty javadocs because maven-central requires it, but it doesn't really generate any documentation judging by the gradle-build-file
d

David Hamilton

11/15/2018, 8:11 AM
And Kotlin Stdlib with empty javadoc for
stdlib
and
stdlib-jdk8
?? COUGHS This feels like a systemic problem (with Dokka? Dokka + Gradle?)
g

gildor

11/15/2018, 8:36 AM
It’s possible to publish javadoc with Dokka
Why do you need javadoc for stdlib?
or any other open-source library
who likes to read the statement of how the code is intended to be used, rather than just relying on the current implementation (in source)
But javadoc generated from comments in source code, you can read this documentation in IDE, it will be just grabbed from source code, the same way as would javadoc generation work
I probably just don’t know your use case, I think javadoc should be published, just curious about use case
also generated documentation for stdlib available on Kotlin web site and description and samples part of source code
y

yole

11/15/2018, 10:34 AM
it’s no problem at all to generate javadocs for stdlib, but why? what is the scenario in which you would use them?
1
i

ilya.gorbunov

11/15/2018, 4:03 PM
@yole perhaps for offline browsing in tools like Dash or Zeal, as David said in the first message.
y

yole

11/15/2018, 4:04 PM
why is javadoc better for such tools than the current stdlib doc format?
i

ilya.gorbunov

11/15/2018, 4:07 PM
Current docs have to be crawled from our site first, while javadoc jars are available to download from maven central. So perhaps the question is not about the format, but rather about the availability of docs.
d

David Hamilton

11/15/2018, 4:09 PM
Yes, plus that JavaDocs are supported by offline readers / browsers, which other formats are not
I would also say that tools like Dash add fast search capabilities
i

ilya.gorbunov

11/15/2018, 4:10 PM
Dash supports any html as a source though https://kapeli.com/docsets#dashDocset
d

David Hamilton

11/15/2018, 4:10 PM
IDEs definitely help, but are not always available: When reviewing PRs for instance
y

yole

11/15/2018, 4:10 PM
last time I checked, Dash was perfectly capable of showing Kotlin reference documentation, which is not in Javadoc format
d

David Hamilton

11/15/2018, 4:11 PM
Downloading? Or just showing?
y

yole

11/15/2018, 4:11 PM
and if you need a reference on how to use the kotlin stdlib from kotlin code, then javadoc is a really poor way to represent this information, because it loses or distorts tons of Kotlin-specific details in the API
downloading
d

David Hamilton

11/15/2018, 4:13 PM
Also, I'm lazy - I have 50-60 lib docsets installed: I just want to search / click install / have dash autoupdate. My job is not managing doc references 😛
y

yole

11/15/2018, 4:14 PM
this is a legitimate wish, but generating javadocs for kotlin libraries is not a good way to fulfill it
d

David Hamilton

11/15/2018, 4:15 PM
So, there's a really good point about lossy translation: How best to agree / standardise a format that is supported by both artefactories and offline readers?
Surely the publication types in Maven repos is extensible? (for, say, Dokka format?)
Hmmm, turns out I have 150 docsets & cheatsheets installed... more than I thought. The point being that a modern developer has to swap rapidly between many libraries and technologies, and the lower the cost of that 'context-switch' the more productive we are.
i

ilya.gorbunov

11/15/2018, 7:00 PM
There's docset for Kotlin 1.3 here https://github.com/rojiani/kotlin-docset/releases
👍 1
d

dave

11/15/2018, 11:16 PM
@David Hamilton sorry - we didn't realise that the http4k java doc jar was empty. Will look at fixing that (we use dokka to generate our API docs - although we don't generally do extensive API docs, what we do have is online at http4k.org/api)
d

David Hamilton

11/16/2018, 7:54 AM
Thanks @dave It also helps to have something to give to people new to our project (the HTTP4K docs are great - what there is! 😉 )
That's great @ilya.gorbunov - thank you.
There is a question that comes out of this thread: How are IDEs deriving their documentation information if it isn't from JavaDoc jars? 🤔
g

gildor

11/16/2018, 8:00 AM
From KDoc comments in sources, exactly the same way as Doka/JavaDoc do
d

David Hamilton

11/16/2018, 8:02 AM
But are they packaged and installed separately? Or derived dynamically from the source code?
g

gildor

11/16/2018, 8:05 AM
there are Jars with source code which downloaded by IDE and indexed, so you have full documentation, same way as you would have it with Javadoc
d

David Hamilton

11/16/2018, 8:07 AM
Ok, thanks. So there isn't a separate packaging for Dokka/KDoc API reference which we could publish and put to use elsewhere?
g

gildor

11/16/2018, 8:07 AM
There are
I mean that you still can publish API reference using Dokka just as HTML or as Javadoc format
I suppose most of libraries don’t have empty javadoc because use default Gradle javadoc tasks that generates empty output for pure Kotlin project But still publish it, because Maven Central doesn’t allow publish libraries without javadoc
d

David Hamilton

11/16/2018, 8:15 AM
That's what I also suspect - that by default Gradle isn't doing what many would expect to be the 'right' thing
g

gildor

11/16/2018, 8:17 AM
If you generate javadoc from Maven for Kotlin project you will probably get exactly the same result
d

David Hamilton

11/16/2018, 8:17 AM
So, I see that Dash supports many formats (inc. non-Java and ScalaDoc). What format should I ask the developer to add support for?
(I.e. one that is expressive for Kotlin-specific API info, and could be publishable as another documentation type on Maven repos)
g

gildor

11/16/2018, 8:28 AM
I knew about Dash from this thread %) So don’t have advice for that. But as I understood, Dash can use any HTML as source of documentation, and this is exactly what Dokka generates by default
d

dave

11/16/2018, 11:04 AM
@David Hamilton I've just looked at fixing this in http4k. Unfortunately there is an open bug in Dokka which prevents the JavaDoc generation from working with Java 10+ (https://github.com/Kotlin/dokka/issues/294), so we're blocked on it, I've raised https://github.com/http4k/http4k/issues/196 to cover.
d

David Hamilton

11/16/2018, 11:04 AM
Many thanks for looking