【问题标题】:Readily available examples of documentation built with Dokka?使用 Dokka 构建的文档的现成示例?
【发布时间】:2020-07-13 10:47:40
【问题描述】:

官方documentation on Dokka表示Dokka可以输出不同格式的结果:

输出格式

  • html - 默认使用简约的 html 格式,Java 类被翻译成 Kotlin
  • javadoc - 看起来像普通的 Javadoc,Kotlin 类被翻译成 Java
  • html-as-java - 看起来像 html,但 Kotlin 类被翻译成 Java
  • markdown - markdown 结构为 html,Java 类被翻译成 Kotlin
    • gfm - GitHub 风格的降价
    • jekyll - Jekyll 兼容降价
  • kotlin-website* - 用于kotlinlang.org 文档的内部格式

虽然我在 kotlinlang.org(标准库和语言指南)上看到了一些格式,但我还没有看到其他格式。

是否有任何指向以htmljavadochtml-as-java 格式生成的文档的链接?

【问题讨论】:

    标签: kotlin kotlin-dokka


    【解决方案1】:

    当然, 对于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,所有格式都被重写并且更漂亮

    【讨论】:

      猜你喜欢
      • 2020-08-15
      • 2021-01-31
      • 2020-02-05
      • 2019-11-17
      • 2022-06-24
      • 2020-04-06
      • 2017-09-04
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多