Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to add top level KDoc for a file?

Tags:

kotlin

kdoc

Is there a way to add a piece of top level KDoc for a Kotlin file?

Since Kotlin supports multiple variables, functions, classes, etc. in a single file, it makes sense to document the file as a whole. However, Documenting Kotlin Code - Kotlin Programming Language seems not to have any instructions on this.

like image 888
Shreck Ye Avatar asked Dec 30 '19 16:12

Shreck Ye


1 Answers

There's no such feature; however, packages and modules can be documented like in Java

In Dokka, additional documentation files are added with include property (e.g. Gradle configuration).

like image 184
Commander Tvis Avatar answered Jan 04 '23 04:01

Commander Tvis