diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/topics/dokka-introduction.md | 2 | ||||
| -rw-r--r-- | docs/topics/formats/dokka-html.md | 4 | ||||
| -rw-r--r-- | docs/topics/runners/dokka-gradle.md | 25 | ||||
| -rw-r--r-- | docs/topics/runners/dokka-maven.md | 2 |
4 files changed, 8 insertions, 25 deletions
diff --git a/docs/topics/dokka-introduction.md b/docs/topics/dokka-introduction.md index cc5cef78..9286a77f 100644 --- a/docs/topics/dokka-introduction.md +++ b/docs/topics/dokka-introduction.md @@ -11,7 +11,7 @@ multiple flavors of [Markdown](dokka-markdown.md), and Java's [Javadoc HTML](dok Here are some libraries that use Dokka for their API reference documentation: -* [kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/) +* [kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/) * [Bitmovin](https://cdn.bitmovin.com/player/android/3/docs/index.html) * [Hexagon](https://hexagonkt.com/api/index.html) * [Ktor](https://api.ktor.io/) diff --git a/docs/topics/formats/dokka-html.md b/docs/topics/formats/dokka-html.md index dd81b2d9..ec8c335b 100644 --- a/docs/topics/formats/dokka-html.md +++ b/docs/topics/formats/dokka-html.md @@ -1,6 +1,8 @@ [//]: # (title: HTML) -HTML is Dokka's default and recommended output format. You can see an example of the final result by browsing documentation +HTML is Dokka's default and recommended output format. It is currently in Beta and approaching the Stable release. + +You can see an example of the output by browsing documentation for [kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/). ## Generate HTML documentation diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md index 21a42322..81e0a2f7 100644 --- a/docs/topics/runners/dokka-gradle.md +++ b/docs/topics/runners/dokka-gradle.md @@ -72,24 +72,7 @@ See [Configuration examples](#configuration-examples) if you are not sure where > If you are using Dokka in a > [precompiled script plugin](https://docs.gradle.org/current/userguide/custom_plugins.html#sec:precompiled_plugins), > you need to add the [Kotlin Gradle plugin](https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin) -> as a dependency for it to work properly: -> -> <tabs group="build-script"> -> <tab title="Kotlin" group-key="kotlin"> -> -> ```kotlin -> implementation(kotlin("gradle-plugin", "%kotlinVersion%")) -> ``` -> -> </tab> -> <tab title="Groovy" group-key="groovy"> -> -> ```groovy -> implementation 'org.jetbrains.kotlin:kotlin-gradle-plugin:%kotlinVersion%' -> ``` -> -> </tab> -> </tabs> +> as a dependency for it to work properly. > {type="note"} @@ -107,7 +90,7 @@ and [multi-project](#multi-project-builds) builds. Use the following tasks to build documentation for simple, single-project applications and libraries: -#### Stable formats +#### Beta formats | **Task** | **Description** | |----------------|-------------------------------------------------------------------------------------| @@ -138,13 +121,13 @@ cross-project references. Dokka creates the following tasks for **parent** projects automatically: -#### Stable formats +#### Beta formats (multi-module) | **Task** | **Description** | |--------------------------|------------------------------------------------------------------------| | `dokkaHtmlMultiModule` | Generates multi-module documentation in [HTML](dokka-html.md) output format. | -#### Experimental formats +#### Experimental formats (multi-module) | **Task** | **Description** | |--------------------------|---------------------------------------------------------------------------------------------------------| diff --git a/docs/topics/runners/dokka-maven.md b/docs/topics/runners/dokka-maven.md index 9bedc517..252abb6f 100644 --- a/docs/topics/runners/dokka-maven.md +++ b/docs/topics/runners/dokka-maven.md @@ -38,8 +38,6 @@ To apply Dokka, you need to add `dokka-maven-plugin` to the `plugins` section of The following goals are provided by the Maven plugin: -### Stable - | **Goal** | **Description** | |---------------|----------------------------------------------------------------------------------------| | `dokka:dokka` | Generates documentation with Dokka plugins applied. [HTML](dokka-html.md) format by default. | |