Kotlin User Group Munich - May 22, 2018 Have you ever wanted to turn Javadoc or KDoc into a format that can easily be processed? Code documentation can not only be used to produce classic Javadoc HTML, but can also be used to enrich REST API documentation or UML diagrams. This talk will teach you everything you need to know about Kotlin's documentation engine Dokka to create custom output formats. Following our journey to get Spring Auto REST Docs to work with Kotlin, we will dive into Dokka. The result is a Dokka extension that turns KDoc into JSON.

1. All you need to know about
Kotlin's documentation
engine Dokka
Florian Benz
KUG Munich - May 22

2. @flbenz

3. DocumentationCode
Tests

7. ●
●
●
●

8. Graph of
documentation nodes
KDoc Javadoc
FormatService
(file content)
Generator
(file structure)
Output files
Extensible
Tree of content
nodes

9. ContentUnorderedList
ContentListItem
ContentListItem
ContentParagraph
ContentParagraph
ContentText
ContentText
ContentUnorderedList
ContentListItem
ContentListItem
ContentText
ContentText

10. FormatServiceGenerator
FormatDescriptor
FormattedOutputBuilder

11. FormatService
fun createOutputBuilder(...):
FormattedOutputBuilder
Generator
fun buildPages(nodes:
Iterable<DocumentationNode>)
FormatDescriptor
val formatServiceClass: KClass<out FormatService>?
val generatorServiceClass: KClass<out Generator>
...
FormattedOutputBuilder
fun appendNodes(nodes: Iterable< DocumentationNode>)

12. 1. Create a project
2. Add Dokka as a dependency
3. Implement FormatDescriptor, FormatService, FormatOutputBuilder
4. Implement Generator if needed
5. Create a fat JAR
6. Use fat JAR together with Dokka

14. ● Fat JAR required for Gradle
● Missing documentation
● Test utilities in TestAPI, but not published

15. ● Get rid of fat JAR requirement
● Publish test JAR
● Add documentation on how to build extensions
● More flexible extension points:

16. AssetAllocation.json
AssetAllocation.kt

18. Questions?
Florian Benz
@flbenz