diff options
Diffstat (limited to 'docs/topics/runners/dokka-cli.md')
| -rw-r--r-- | docs/topics/runners/dokka-cli.md | 50 |
1 files changed, 16 insertions, 34 deletions
diff --git a/docs/topics/runners/dokka-cli.md b/docs/topics/runners/dokka-cli.md index 629ea40e..a5a1832e 100644 --- a/docs/topics/runners/dokka-cli.md +++ b/docs/topics/runners/dokka-cli.md @@ -10,8 +10,8 @@ difficult to set up as there is no autoconfiguration, especially in multiplatfor The CLI runner is published to Maven Central as a separate runnable artifact. -You can find it on [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-cli/%dokkaVersion%) or by browsing -[maven central repository directories](https://repo1.maven.org/maven2/org/jetbrains/dokka/dokka-cli/%dokkaVersion%) directly. +You can find it on [Maven Central](https://central.sonatype.com/artifact/org.jetbrains.dokka/dokka-cli) or +[download it directly](https://repo1.maven.org/maven2/org/jetbrains/dokka/dokka-cli/%dokkaVersion%/dokka-cli-%dokkaVersion%.jar). With the `dokka-cli-%dokkaVersion%.jar` file saved on your computer, run it with the `-help` option to see all available configuration options and their description: @@ -34,19 +34,17 @@ Since there is no build tool to manage dependencies, you have to provide depende Listed below are the dependencies that you need for any output format: -| **Group** | **Artifact** | **Version** | **Link** | -|-----------------------|----------------------------|----------------|-----------------------------------------------------------------------------------------------------------------| -| `org.jetbrains.dokka` | `dokka-base` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-base/%dokkaVersion%) | -| `org.jetbrains.dokka` | `dokka-analysis` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-analysis/%dokkaVersion%) | -| `org.jetbrains.dokka` | `kotlin-analysis-compiler` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-compiler/%dokkaVersion%) | -| `org.jetbrains.dokka` | `kotlin-analysis-intellij` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-intellij/%dokkaVersion%) | +| **Group** | **Artifact** | **Version** | **Link** | +|-----------------------|-------------------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `org.jetbrains.dokka` | `dokka-base` | %dokkaVersion% | [download](https://repo1.maven.org/maven2/org/jetbrains/dokka/dokka-base/%dokkaVersion%/dokka-base-%dokkaVersion%.jar) | +| `org.jetbrains.dokka` | `analysis-kotlin-descriptors` | %dokkaVersion% | [download](https://repo1.maven.org/maven2/org/jetbrains/dokka/analysis-kotlin-descriptors/%dokkaVersion%/analysis-kotlin-descriptors-%dokkaVersion%.jar) | Below are the additional dependencies that you need for [HTML](dokka-html.md) output format: -| **Group** | **Artifact** | **Version** | **Link** | -|-------------------------|--------------------|-------------|--------------------------------------------------------------------------------------------------| -| `org.jetbrains.kotlinx` | `kotlinx-html-jvm` | 0.8.0 | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-html-jvm/0.8.0) | -| `org.freemarker` | `freemarker` | 2.3.31 | [mvnrepository](https://mvnrepository.com/artifact/org.freemarker/freemarker/2.3.31) | +| **Group** | **Artifact** | **Version** | **Link** | +|-------------------------|--------------------|-------------|--------------------------------------------------------------------------------------------------------------------| +| `org.jetbrains.kotlinx` | `kotlinx-html-jvm` | 0.8.0 | [download](https://repo1.maven.org/maven2/org/jetbrains/kotlinx/kotlinx-html-jvm/0.8.0/kotlinx-html-jvm-0.8.0.jar) | +| `org.freemarker` | `freemarker` | 2.3.31 | [download](https://repo1.maven.org/maven2/org/freemarker/freemarker/2.3.31/freemarker-2.3.31.jar) | ### Run with command line options @@ -61,16 +59,11 @@ At the very least you need to provide the following options: ```Bash java -jar dokka-cli-%dokkaVersion%.jar \ - -pluginsClasspath "./dokka-base-%dokkaVersion%.jar;./dokka-analysis-%dokkaVersion%.jar;./kotlin-analysis-intellij-%dokkaVersion%.jar;./kotlin-analysis-compiler-%dokkaVersion%.jar;./kotlinx-html-jvm-0.8.0.jar;./freemarker-2.3.31.jar" \ + -pluginsClasspath "./dokka-base-%dokkaVersion%.jar;./analysis-kotlin-descriptors-%dokkaVersion%.jar;./kotlinx-html-jvm-0.8.0.jar;./freemarker-2.3.31.jar" \ -sourceSet "-src /home/myCoolProject/src/main/kotlin" \ -outputDir "./dokka/html" ``` -> Due to an internal class conflict, first pass `kotlin-analysis-intellij` and only then `kotlin-analysis-compiler`. -> Otherwise you may see obscure exceptions, such as `NoSuchFieldError`. -> -{type="note"} - Executing the given example generates documentation in [HTML](dokka-html.md) output format. See [Command line options](#command-line-options) for more configuration details. @@ -104,19 +97,12 @@ At the very least, you need the following JSON configuration file: "pluginsClasspath": [ "./dokka-base-%dokkaVersion%.jar", "./kotlinx-html-jvm-0.8.0.jar", - "./dokka-analysis-%dokkaVersion%.jar", - "./kotlin-analysis-intellij-%dokkaVersion%.jar", - "./kotlin-analysis-compiler-%dokkaVersion%.jar", + "./analysis-kotlin-descriptors-%dokkaVersion%.jar", "./freemarker-2.3.31.jar" ] } ``` -> Due to an internal class conflict, first pass `kotlin-analysis-intellij` and only then `kotlin-analysis-compiler`. -> Otherwise you may see obscure exceptions, such as `NoSuchFieldError`. -> -{type="note"} - See [JSON configuration options](#json-configuration) for more details. ### Other output formats @@ -127,8 +113,8 @@ All other output formats are implemented as [Dokka plugins](dokka-plugins.md). I on the plugins classpath. For example, if you want to generate documentation in the experimental [GFM](dokka-markdown.md#gfm) output format, you need to download and -pass [gfm-plugin's JAR](https://mvnrepository.com/artifact/org.jetbrains.dokka/gfm-plugin/%dokkaVersion%) into -the `pluginsClasspath` configuration option. +pass gfm-plugin's JAR ([download](https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar)) +into the `pluginsClasspath` configuration option. Via command line options: @@ -255,9 +241,7 @@ with [all configuration options](#complete-configuration) applied at the bottom "pluginsClasspath": [ "./dokka-base-%dokkaVersion%.jar", "./kotlinx-html-jvm-0.8.0.jar", - "./dokka-analysis-%dokkaVersion%.jar", - "./kotlin-analysis-intellij-%dokkaVersion%.jar", - "./kotlin-analysis-compiler-%dokkaVersion%.jar", + "./analysis-kotlin-descriptors-%dokkaVersion%.jar", "./freemarker-2.3.31.jar" ] } @@ -841,9 +825,7 @@ Below you can see all possible configuration options applied at the same time. "pluginsClasspath": [ "./dokka-base-%dokkaVersion%.jar", "./kotlinx-html-jvm-0.8.0.jar", - "./dokka-analysis-%dokkaVersion%.jar", - "./kotlin-analysis-intellij-%dokkaVersion%.jar", - "./kotlin-analysis-compiler-%dokkaVersion%.jar", + "./analysis-kotlin-descriptors-%dokkaVersion%.jar", "./freemarker-2.3.31.jar" ], "pluginsConfiguration": [ |