Skip to content

Commit 32c88d5

Browse files
Update user documentation to account for 1.9.0 changes (#3077)
1 parent 83231c0 commit 32c88d5

File tree

3 files changed

+25
-43
lines changed

3 files changed

+25
-43
lines changed

docs/topics/formats/dokka-javadoc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ by using the following goals:
5656
<tab title="CLI" group-key="cli">
5757

5858
Since the Javadoc output format is a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
59-
download the plugin's [JAR file](https://mvnrepository.com/artifact/org.jetbrains.dokka/javadoc-plugin/%dokkaVersion%).
59+
[download the plugin's JAR file](https://repo1.maven.org/maven2/org/jetbrains/dokka/javadoc-plugin/%dokkaVersion%/javadoc-plugin-%dokkaVersion%.jar).
6060

6161
The Javadoc output format has two dependencies that you need to provide as additional JAR files:
6262

63-
* [kotlin-as-java plugin](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-as-java-plugin/%dokkaVersion%)
64-
* [korte-jvm](https://mvnrepository.com/artifact/com.soywiz.korlibs.korte/korte-jvm/3.3.0)
63+
* [kotlin-as-java plugin](https://repo1.maven.org/maven2/org/jetbrains/dokka/kotlin-as-java-plugin/%dokkaVersion%/kotlin-as-java-plugin-%dokkaVersion%.jar)
64+
* [korte-jvm](https://repo1.maven.org/maven2/com/soywiz/korlibs/korte/korte-jvm/3.3.0/korte-jvm-3.3.0.jar)
6565

6666
Via [command line options](dokka-cli.md#run-with-command-line-options):
6767

docs/topics/formats/dokka-markdown.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ For more information, see the Mavin plugin documentation for [Other output forma
5959
</tab>
6060
<tab title="CLI" group-key="cli">
6161

62-
Since GFM format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to download the
63-
[JAR file](https://mvnrepository.com/artifact/org.jetbrains.dokka/gfm-plugin/%dokkaVersion%) and pass it to
64-
`pluginsClasspath`.
62+
Since GFM format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
63+
[download the JAR file]((https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar))
64+
and pass it to `pluginsClasspath`.
6565

6666
Via [command line options](dokka-cli.md#run-with-command-line-options):
6767

@@ -137,9 +137,9 @@ For more information, see the Maven plugin's documentation for [Other output for
137137
</tab>
138138
<tab title="CLI" group-key="cli">
139139

140-
Since Jekyll format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to download the
141-
[JAR file](https://mvnrepository.com/artifact/org.jetbrains.dokka/jekyll-plugin/%dokkaVersion%). This format is also
142-
based on [GFM](#gfm) format, so you need to provide it as a dependency as well. Both JARs need to be passed to
140+
Since Jekyll format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
141+
[download the JAR file](https://repo1.maven.org/maven2/org/jetbrains/dokka/jekyll-plugin/%dokkaVersion%/jekyll-plugin-%dokkaVersion%.jar).
142+
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
143143
`pluginsClasspath`:
144144

145145
Via [command line options](dokka-cli.md#run-with-command-line-options):

docs/topics/runners/dokka-cli.md

Lines changed: 16 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ difficult to set up as there is no autoconfiguration, especially in multiplatfor
1010

1111
The CLI runner is published to Maven Central as a separate runnable artifact.
1212

13-
You can find it on [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-cli/%dokkaVersion%) or by browsing
14-
[maven central repository directories](https://repo1.maven.org/maven2/org/jetbrains/dokka/dokka-cli/%dokkaVersion%) directly.
13+
You can find it on [Maven Central](https://central.sonatype.com/artifact/org.jetbrains.dokka/dokka-cli) or
14+
[download it directly](https://repo1.maven.org/maven2/org/jetbrains/dokka/dokka-cli/%dokkaVersion%/dokka-cli-%dokkaVersion%.jar).
1515

1616
With the `dokka-cli-%dokkaVersion%.jar` file saved on your computer, run it with the `-help` option to see all
1717
available configuration options and their description:
@@ -34,19 +34,17 @@ Since there is no build tool to manage dependencies, you have to provide depende
3434

3535
Listed below are the dependencies that you need for any output format:
3636

37-
| **Group** | **Artifact** | **Version** | **Link** |
38-
|-----------------------|----------------------------|----------------|-----------------------------------------------------------------------------------------------------------------|
39-
| `org.jetbrains.dokka` | `dokka-base` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-base/%dokkaVersion%) |
40-
| `org.jetbrains.dokka` | `dokka-analysis` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-analysis/%dokkaVersion%) |
41-
| `org.jetbrains.dokka` | `kotlin-analysis-compiler` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-compiler/%dokkaVersion%) |
42-
| `org.jetbrains.dokka` | `kotlin-analysis-intellij` | %dokkaVersion% | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-intellij/%dokkaVersion%) |
37+
| **Group** | **Artifact** | **Version** | **Link** |
38+
|-----------------------|-------------------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
39+
| `org.jetbrains.dokka` | `dokka-base` | %dokkaVersion% | [download](https://repo1.maven.org/maven2/org/jetbrains/dokka/dokka-base/%dokkaVersion%/dokka-base-%dokkaVersion%.jar) |
40+
| `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) |
4341

4442
Below are the additional dependencies that you need for [HTML](dokka-html.md) output format:
4543

46-
| **Group** | **Artifact** | **Version** | **Link** |
47-
|-------------------------|--------------------|-------------|--------------------------------------------------------------------------------------------------|
48-
| `org.jetbrains.kotlinx` | `kotlinx-html-jvm` | 0.8.0 | [mvnrepository](https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-html-jvm/0.8.0) |
49-
| `org.freemarker` | `freemarker` | 2.3.31 | [mvnrepository](https://mvnrepository.com/artifact/org.freemarker/freemarker/2.3.31) |
44+
| **Group** | **Artifact** | **Version** | **Link** |
45+
|-------------------------|--------------------|-------------|--------------------------------------------------------------------------------------------------------------------|
46+
| `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) |
47+
| `org.freemarker` | `freemarker` | 2.3.31 | [download](https://repo1.maven.org/maven2/org/freemarker/freemarker/2.3.31/freemarker-2.3.31.jar) |
5048

5149

5250
### Run with command line options
@@ -61,16 +59,11 @@ At the very least you need to provide the following options:
6159

6260
```Bash
6361
java -jar dokka-cli-%dokkaVersion%.jar \
64-
-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" \
62+
-pluginsClasspath "./dokka-base-%dokkaVersion%.jar;./analysis-kotlin-descriptors-%dokkaVersion%.jar;./kotlinx-html-jvm-0.8.0.jar;./freemarker-2.3.31.jar" \
6563
-sourceSet "-src /home/myCoolProject/src/main/kotlin" \
6664
-outputDir "./dokka/html"
6765
```
6866

69-
> Due to an internal class conflict, first pass `kotlin-analysis-intellij` and only then `kotlin-analysis-compiler`.
70-
> Otherwise you may see obscure exceptions, such as `NoSuchFieldError`.
71-
>
72-
{type="note"}
73-
7467
Executing the given example generates documentation in [HTML](dokka-html.md) output format.
7568

7669
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:
10497
"pluginsClasspath": [
10598
"./dokka-base-%dokkaVersion%.jar",
10699
"./kotlinx-html-jvm-0.8.0.jar",
107-
"./dokka-analysis-%dokkaVersion%.jar",
108-
"./kotlin-analysis-intellij-%dokkaVersion%.jar",
109-
"./kotlin-analysis-compiler-%dokkaVersion%.jar",
100+
"./analysis-kotlin-descriptors-%dokkaVersion%.jar",
110101
"./freemarker-2.3.31.jar"
111102
]
112103
}
113104
```
114105

115-
> Due to an internal class conflict, first pass `kotlin-analysis-intellij` and only then `kotlin-analysis-compiler`.
116-
> Otherwise you may see obscure exceptions, such as `NoSuchFieldError`.
117-
>
118-
{type="note"}
119-
120106
See [JSON configuration options](#json-configuration) for more details.
121107

122108
### Other output formats
@@ -127,8 +113,8 @@ All other output formats are implemented as [Dokka plugins](dokka-plugins.md). I
127113
on the plugins classpath.
128114

129115
For example, if you want to generate documentation in the experimental [GFM](dokka-markdown.md#gfm) output format, you need to download and
130-
pass [gfm-plugin's JAR](https://mvnrepository.com/artifact/org.jetbrains.dokka/gfm-plugin/%dokkaVersion%) into
131-
the `pluginsClasspath` configuration option.
116+
pass gfm-plugin's JAR ([download](https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar))
117+
into the `pluginsClasspath` configuration option.
132118

133119
Via command line options:
134120

@@ -255,9 +241,7 @@ with [all configuration options](#complete-configuration) applied at the bottom
255241
"pluginsClasspath": [
256242
"./dokka-base-%dokkaVersion%.jar",
257243
"./kotlinx-html-jvm-0.8.0.jar",
258-
"./dokka-analysis-%dokkaVersion%.jar",
259-
"./kotlin-analysis-intellij-%dokkaVersion%.jar",
260-
"./kotlin-analysis-compiler-%dokkaVersion%.jar",
244+
"./analysis-kotlin-descriptors-%dokkaVersion%.jar",
261245
"./freemarker-2.3.31.jar"
262246
]
263247
}
@@ -841,9 +825,7 @@ Below you can see all possible configuration options applied at the same time.
841825
"pluginsClasspath": [
842826
"./dokka-base-%dokkaVersion%.jar",
843827
"./kotlinx-html-jvm-0.8.0.jar",
844-
"./dokka-analysis-%dokkaVersion%.jar",
845-
"./kotlin-analysis-intellij-%dokkaVersion%.jar",
846-
"./kotlin-analysis-compiler-%dokkaVersion%.jar",
828+
"./analysis-kotlin-descriptors-%dokkaVersion%.jar",
847829
"./freemarker-2.3.31.jar"
848830
],
849831
"pluginsConfiguration": [

0 commit comments

Comments
 (0)