kdoc
Installation
SKILL.md
KDoc Generator
Add KDoc to all public Kotlin declarations (classes, interfaces, objects, functions, properties, enums, type aliases, annotations — including @Deprecated). Read the implementation, not just the signature, to write accurate descriptions.
Tag placement
| Where the declaration lives | Tag |
|---|---|
Primary-ctor val / var (public, internal, or protected) |
@property in class KDoc |
Primary-ctor name: Type (no val/var) |
@param in class KDoc |
Primary-ctor private val / private var |
@param in class KDoc |
| Body of class/object/interface/sealed interface | inline /** */ above the declaration |
| Function parameter | @param |
| Non-Unit return type | @return |