使用 Dokka 构建的现成文档示例?
Readily available examples of documentation built with Dokka?
官方documentation on Dokka说Dokka可以输出不同格式的结果:
Output formats
html
- minimalistic html format used by default, Java classes are translated to Kotlin
javadoc
- looks like normal Javadoc, Kotlin classes are translated to Java
html-as-java
- looks like html
, but Kotlin classes are translated to Java
markdown
- markdown structured as html
, Java classes are translated to Kotlin
gfm
- GitHub flavored markdown
jekyll
- Jekyll compatible markdown
kotlin-website*
- internal format used for documentation on kotlinlang.org
虽然我在 kotlinlang.org(标准库和语言指南)上看到了一些格式,但我还没有看到其他格式。
是否有指向以 html
、javadoc
或 html-as-java
格式生成的文档的任何链接?
当然,
对于 html
,请参阅 https://gradle.github.io/kotlin-dsl-docs/api/,
javadoc
使用你的 JDK 中的 HtmlDoclet
(它目前不适用于 JDK > 8),所以它只是普通的 javadoc 而 html-as-java
看起来像 html
,唯一的区别是 Kotlin 类型被翻译成 Java(所以你得到 Foo extends Bar
而不是 Foo : Bar
)。
另请注意,我们正在开发新版本的 dokka,所有格式都已重写且更漂亮
官方documentation on Dokka说Dokka可以输出不同格式的结果:
Output formats
html
- minimalistic html format used by default, Java classes are translated to Kotlinjavadoc
- looks like normal Javadoc, Kotlin classes are translated to Javahtml-as-java
- looks likehtml
, but Kotlin classes are translated to Javamarkdown
- markdown structured ashtml
, Java classes are translated to Kotlin
gfm
- GitHub flavored markdownjekyll
- Jekyll compatible markdownkotlin-website*
- internal format used for documentation on kotlinlang.org
虽然我在 kotlinlang.org(标准库和语言指南)上看到了一些格式,但我还没有看到其他格式。
是否有指向以 html
、javadoc
或 html-as-java
格式生成的文档的任何链接?
当然,
对于 html
,请参阅 https://gradle.github.io/kotlin-dsl-docs/api/,
javadoc
使用你的 JDK 中的 HtmlDoclet
(它目前不适用于 JDK > 8),所以它只是普通的 javadoc 而 html-as-java
看起来像 html
,唯一的区别是 Kotlin 类型被翻译成 Java(所以你得到 Foo extends Bar
而不是 Foo : Bar
)。
另请注意,我们正在开发新版本的 dokka,所有格式都已重写且更漂亮