@@ -61,11 +61,96 @@ For Base plugins these are:
61
61
* [ dokka-analysis.jar] ( https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-analysis )
62
62
* [ kotlin-analysis-compiler.jar] ( https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-compiler )
63
63
* [ kotlin-analysis-intellij.jar] ( https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-intellij )
64
- * [ kotlinx-coroutines-core.jar] ( https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-coroutines-core/1.3.9 )
65
64
* [ kotlinx-html-jvm.jar] ( https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-html-jvm?repo=kotlinx )
66
65
67
- All of them are published on maven central.
66
+ All of them are published on maven central. Another dependencies of Base plugin (e.g. ` kotlinx-coroutines-core ` and so on) are already included in ` dokka-cli.jar ` .
68
67
To get them on classpath one should add them via ` pluginsClasspath ` argument, e. g.
69
68
```
70
- java -jar dokka-cli.jar -pluginsClasspath "dokka-base.jar;dokka-analysis.jar;kotlin-analysis-compiler.jar;kotlin-analysis-intellij.jar;kotlinx-coroutines-core.jar;kotlinx- html-jvm.jar" ...
69
+ java -jar dokka-cli.jar -pluginsClasspath "dokka-base.jar;dokka-analysis.jar;kotlin-analysis-compiler.jar;kotlin-analysis-intellij.jar;kotlinx-html-jvm.jar" ...
71
70
```
71
+
72
+ ## Example using JSON
73
+
74
+ To run Dokka with JSON configuration:
75
+ ```
76
+ java -jar dokka-cli.jar dokkaConfiguration.json
77
+ ```
78
+ Option values of JSON correspond to [ Gradle ones] ( ../gradle/usage#configuration-options ) .
79
+ The content of JSON file ``` dokkaConfiguration.json ``` :
80
+ ``` json
81
+ {
82
+ "moduleName" : " Dokka Example" ,
83
+ "moduleVersion" : null ,
84
+ "outputDir" : " build/dokka/html" ,
85
+ "cacheRoot" : null ,
86
+ "offlineMode" : false ,
87
+ "sourceSets" : [
88
+ {
89
+ "displayName" : " jvm" ,
90
+ "sourceSetID" : {
91
+ "scopeId" : " :dokkaHtml" ,
92
+ "sourceSetName" : " main"
93
+ },
94
+ "classpath" : [
95
+ " libs/kotlin-stdlib-1.6.0.jar" ,
96
+ " libs/kotlin-stdlib-common-1.6.0.jar"
97
+ ],
98
+ "sourceRoots" : [
99
+ " /home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin"
100
+ ],
101
+ "dependentSourceSets" : [],
102
+ "samples" : [],
103
+ "includes" : [
104
+ " Module.md"
105
+ ],
106
+ "includeNonPublic" : false ,
107
+ "reportUndocumented" : false ,
108
+ "skipEmptyPackages" : true ,
109
+ "skipDeprecated" : false ,
110
+ "jdkVersion" : 8 ,
111
+ "sourceLinks" : [
112
+ {
113
+ "localDirectory" : " /home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin" ,
114
+ "remoteUrl" : " https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-gradle-example/src/main/kotlin" ,
115
+ "remoteLineSuffix" : " #L"
116
+ }
117
+ ],
118
+ "perPackageOptions" : [],
119
+ "externalDocumentationLinks" : [
120
+ {
121
+ "url" : " https://docs.oracle.com/javase/8/docs/api/" ,
122
+ "packageListUrl" : " https://docs.oracle.com/javase/8/docs/api/package-list"
123
+ },
124
+ {
125
+ "url" : " https://kotlinlang.org/api/latest/jvm/stdlib/" ,
126
+ "packageListUrl" : " https://kotlinlang.org/api/latest/jvm/stdlib/package-list"
127
+ }
128
+ ],
129
+ "noStdlibLink" : false ,
130
+ "noJdkLink" : false ,
131
+ "suppressedFiles" : [],
132
+ "analysisPlatform" : " jvm"
133
+ }
134
+ ],
135
+ "pluginsClasspath" : [
136
+ " plugins/dokka-base-1.6.0.jar" ,
137
+ " libs/kotlinx-html-jvm-0.7.3.jar" ,
138
+ " libs/dokka-analysis-1.6.0.jar" ,
139
+ " libs/kotlin-analysis-intellij-1.6.0.jar" ,
140
+ " libs/kotlin-analysis-compiler-1.6.0.jar"
141
+ ],
142
+ "pluginsConfiguration" : [
143
+ {
144
+ "fqPluginName" : " org.jetbrains.dokka.base.DokkaBase" ,
145
+ "serializationFormat" : " JSON" ,
146
+ "values" : " {\" separateInheritedMembers\" :false,\" footerMessage\" :\" © 2021 Copyright\" }"
147
+ }
148
+ ],
149
+ "modules" : [],
150
+ "failOnWarning" : false ,
151
+ "delayTemplateSubstitution" : false ,
152
+ "suppressObviousFunctions" : true ,
153
+ "includes" : [],
154
+ "suppressInheritedMembers" : false
155
+ }
156
+ ```
0 commit comments