Готовые примеры документации, созданной с помощью Dokka?

В официальной документации по Dokka говорится, что Dokka может выводить результат в разных форматах. :

Выходные форматы

  • html - минималистичный формат html, используемый по умолчанию, классы Java переведены на Kotlin
  • javadoc - выглядит как обычный Javadoc, классы Kotlin переведены на Java
  • html-as-java — выглядит как html, но классы Kotlin переведены на Java
  • markdown - markdown structured as html, Java classes are translated to Kotlin
    • gfm - GitHub flavored markdown
    • jekyll - уценка, совместимая с Jekyll
  • kotlin-website* — внутренний формат, используемый для документации на kotlinlang.org

Хотя я видел некоторые форматы на kotlinlang.org (Стандартная библиотека и Руководство по языку), другие мне еще предстоит увидеть.

Есть ли ссылки на документацию, созданную в форматах html, javadoc или html-as-java?


person DocumentationNerd    schedule 01.04.2020    source источник


Ответы (1)


Конечно, для html см. https://gradle.github.io/kotlin-dsl-docs/api/, javadoc использует HtmlDoclet из вашего JDK (в настоящее время он не работает с JDK > 8), поэтому это обычный javadoc, а html-as-java выглядит как html, единственная разница в том, что типы Kotlin переводятся в Java (так что вы получите Foo extends Bar вместо Foo : Bar). Также обратите внимание, что мы работаем над новой версией dokka, в которой все форматы переписаны и улучшены.

person Kamil Doległo    schedule 04.04.2020