diff options
author | Krystian Ujma <krystianujma@gmail.com> | 2019-03-11 17:15:12 +0100 |
---|---|---|
committer | Simon Ogorodnik <simon.ogorodnik@gmail.com> | 2019-03-11 19:15:12 +0300 |
commit | 730a56645ebac9bc8acde2f2179d86d330b584b0 (patch) | |
tree | d680c16491700f46402f0b53389ba235aa3fc10a | |
parent | 52b303d4251d54ddf9f09330f902621689a50f5d (diff) | |
download | dokka-730a56645ebac9bc8acde2f2179d86d330b584b0.tar.gz dokka-730a56645ebac9bc8acde2f2179d86d330b584b0.tar.bz2 dokka-730a56645ebac9bc8acde2f2179d86d330b584b0.zip |
Readme update (#441)
* add dokkaRuntime config to the readme, add FAQ link
* change output formats description
-rw-r--r-- | README.md | 32 |
1 files changed, 27 insertions, 5 deletions
@@ -157,6 +157,28 @@ task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) { Please see the [Dokka Gradle example project](https://github.com/JetBrains/kotlin-examples/tree/master/gradle/dokka-gradle-example) for an example. +#### Dokka Runtime +If you are using Gradle plugin and you want to change the version of Dokka, you can do it by setting `dokkaRuntime`: + +```groovy +buildscript { + ... +} + +apply plugin: 'org.jetbrains.dokka' + +repositories { + jcenter() +} + +dependencies { + dokkaRuntime "org.jetbrains.dokka:dokka-fatjar:0.9.18" +} +``` + +#### FAQ +Please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq). + #### Android If you are using Android there is a separate Gradle plugin. Just make sure you apply the plugin after @@ -396,11 +418,11 @@ Dokka supports the following command line arguments: ### Output formats<a name="output_formats"></a> - * `html` - minimalistic html format used by default - * `javadoc` - Dokka mimic to javadoc - * `html-as-java` - as `html` but using java syntax - * `markdown` - Markdown structured as `html` - * `gfm` - GitHub flavored markdown + * `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](https://kotlinlang.org) |