Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Where/How do You Add Documentation for Kotlin Packages?

In Java, if you want to document a package, it has to be put into the package-info.class file. Is that still the same thing with Kotlin and KDoc? I've looked through some of the Kotlin source and can't find where their package documentation is written.

like image 935
Jacob Zimmerman Avatar asked Feb 04 '16 21:02

Jacob Zimmerman


1 Answers

You use the include Dokka configuration option.

See: https://github.com/Kotlin/dokka/blob/master/README.md

Example: https://github.com/JetBrains/kotlin/blob/58e93d5e1bb547c8a7e398587b6851ccf6372326/libraries/build-docs.xml

like image 64
mfulton26 Avatar answered Oct 13 '22 16:10

mfulton26