aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-09-01 16:31:19 +0200
committerGitHub <noreply@github.com>2023-09-01 16:31:19 +0200
commit32c88d525de89de1d0d055b2fa65b5cd48ccaec3 (patch)
tree85f037966e44a93db270387c85b475031201d632 /docs
parent83231c0781a50fdeb05ded348187ae48557a1a1f (diff)
downloaddokka-32c88d525de89de1d0d055b2fa65b5cd48ccaec3.tar.gz
dokka-32c88d525de89de1d0d055b2fa65b5cd48ccaec3.tar.bz2
dokka-32c88d525de89de1d0d055b2fa65b5cd48ccaec3.zip
Update user documentation to account for 1.9.0 changes (#3077)
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/formats/dokka-javadoc.md6
-rw-r--r--docs/topics/formats/dokka-markdown.md12
-rw-r--r--docs/topics/runners/dokka-cli.md50
3 files changed, 25 insertions, 43 deletions
diff --git a/docs/topics/formats/dokka-javadoc.md b/docs/topics/formats/dokka-javadoc.md
index 9ea78fd9..3dbd3f05 100644
--- a/docs/topics/formats/dokka-javadoc.md
+++ b/docs/topics/formats/dokka-javadoc.md
@@ -56,12 +56,12 @@ by using the following goals:
<tab title="CLI" group-key="cli">
Since the Javadoc output format is a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
-download the plugin's [JAR file](https://mvnrepository.com/artifact/org.jetbrains.dokka/javadoc-plugin/%dokkaVersion%).
+[download the plugin's JAR file](https://repo1.maven.org/maven2/org/jetbrains/dokka/javadoc-plugin/%dokkaVersion%/javadoc-plugin-%dokkaVersion%.jar).
The Javadoc output format has two dependencies that you need to provide as additional JAR files:
-* [kotlin-as-java plugin](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-as-java-plugin/%dokkaVersion%)
-* [korte-jvm](https://mvnrepository.com/artifact/com.soywiz.korlibs.korte/korte-jvm/3.3.0)
+* [kotlin-as-java plugin](https://repo1.maven.org/maven2/org/jetbrains/dokka/kotlin-as-java-plugin/%dokkaVersion%/kotlin-as-java-plugin-%dokkaVersion%.jar)
+* [korte-jvm](https://repo1.maven.org/maven2/com/soywiz/korlibs/korte/korte-jvm/3.3.0/korte-jvm-3.3.0.jar)
Via [command line options](dokka-cli.md#run-with-command-line-options):
diff --git a/docs/topics/formats/dokka-markdown.md b/docs/topics/formats/dokka-markdown.md
index 0c863f35..a8e22129 100644
--- a/docs/topics/formats/dokka-markdown.md
+++ b/docs/topics/formats/dokka-markdown.md
@@ -59,9 +59,9 @@ For more information, see the Mavin plugin documentation for [Other output forma
</tab>
<tab title="CLI" group-key="cli">
-Since GFM format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to download the
-[JAR file](https://mvnrepository.com/artifact/org.jetbrains.dokka/gfm-plugin/%dokkaVersion%) and pass it to
-`pluginsClasspath`.
+Since GFM format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
+[download the JAR file]((https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar))
+and pass it to `pluginsClasspath`.
Via [command line options](dokka-cli.md#run-with-command-line-options):
@@ -137,9 +137,9 @@ For more information, see the Maven plugin's documentation for [Other output for
</tab>
<tab title="CLI" group-key="cli">
-Since Jekyll format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to download the
-[JAR file](https://mvnrepository.com/artifact/org.jetbrains.dokka/jekyll-plugin/%dokkaVersion%). This format is also
-based on [GFM](#gfm) format, so you need to provide it as a dependency as well. Both JARs need to be passed to
+Since Jekyll format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
+[download the JAR file](https://repo1.maven.org/maven2/org/jetbrains/dokka/jekyll-plugin/%dokkaVersion%/jekyll-plugin-%dokkaVersion%.jar).
+This format is also based on [GFM](#gfm) format, so you need to provide it as a dependency as well. Both JARs need to be passed to
`pluginsClasspath`:
Via [command line options](dokka-cli.md#run-with-command-line-options):
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": [