@@ -10,8 +10,8 @@ difficult to set up as there is no autoconfiguration, especially in multiplatfor
10
10
11
11
The CLI runner is published to Maven Central as a separate runnable artifact.
12
12
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 ) .
15
15
16
16
With the ` dokka-cli-%dokkaVersion%.jar ` file saved on your computer, run it with the ` -help ` option to see all
17
17
available configuration options and their description:
@@ -34,19 +34,17 @@ Since there is no build tool to manage dependencies, you have to provide depende
34
34
35
35
Listed below are the dependencies that you need for any output format:
36
36
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 ) |
43
41
44
42
Below are the additional dependencies that you need for [ HTML] ( dokka-html.md ) output format:
45
43
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 ) |
50
48
51
49
52
50
### Run with command line options
@@ -61,16 +59,11 @@ At the very least you need to provide the following options:
61
59
62
60
``` Bash
63
61
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" \
65
63
-sourceSet " -src /home/myCoolProject/src/main/kotlin" \
66
64
-outputDir " ./dokka/html"
67
65
```
68
66
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
-
74
67
Executing the given example generates documentation in [ HTML] ( dokka-html.md ) output format.
75
68
76
69
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:
104
97
"pluginsClasspath" : [
105
98
" ./dokka-base-%dokkaVersion%.jar" ,
106
99
" ./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" ,
110
101
" ./freemarker-2.3.31.jar"
111
102
]
112
103
}
113
104
```
114
105
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
-
120
106
See [ JSON configuration options] ( #json-configuration ) for more details.
121
107
122
108
### Other output formats
@@ -127,8 +113,8 @@ All other output formats are implemented as [Dokka plugins](dokka-plugins.md). I
127
113
on the plugins classpath.
128
114
129
115
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.
132
118
133
119
Via command line options:
134
120
@@ -255,9 +241,7 @@ with [all configuration options](#complete-configuration) applied at the bottom
255
241
"pluginsClasspath" : [
256
242
" ./dokka-base-%dokkaVersion%.jar" ,
257
243
" ./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" ,
261
245
" ./freemarker-2.3.31.jar"
262
246
]
263
247
}
@@ -841,9 +825,7 @@ Below you can see all possible configuration options applied at the same time.
841
825
"pluginsClasspath" : [
842
826
" ./dokka-base-%dokkaVersion%.jar" ,
843
827
" ./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" ,
847
829
" ./freemarker-2.3.31.jar"
848
830
],
849
831
"pluginsConfiguration" : [
0 commit comments