模块和包文档

模块的文档作为一个整体,模块中的包也是如此。模块的文档会被分隔成一个Markdown文件,文件的路径通过-include命令、Ant参数、Maven和Gradle插件传递给Dokka。

在文件内部,模块的文档作为一个整体,每个包是分开的。文本头必须是Module <module name>,如果是包的话使用package <package qualified name>。

# Module kotlin-demo
The module shows the Dokka syntax usage.
# Package org.jetbrains.kotlin.demo
Contains assorted useful stuff.
## Level 2 heading
Text after this heading is also part of documentation for `org.jetbrains.kotlin.demo`
# Package org.jetbrains.kotlin.demo2
Useful stuff in another package.
Module and Package Documentation

results matching ""

    No results matching ""