aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrzej Ratajczak <32793002+BarkingBad@users.noreply.github.com>2020-10-07 16:39:02 +0200
committerGitHub <noreply@github.com>2020-10-07 16:39:02 +0200
commit2d1dc01ca208bfba33265238a01c5239f1dbebd2 (patch)
treec58e17b554acbd302b547c35379f632e82ce4c9b
parente9f5da45c0fcfec5f7c150229301904d7915e090 (diff)
downloaddokka-2d1dc01ca208bfba33265238a01c5239f1dbebd2.tar.gz
dokka-2d1dc01ca208bfba33265238a01c5239f1dbebd2.tar.bz2
dokka-2d1dc01ca208bfba33265238a01c5239f1dbebd2.zip
Fix typos and 404 links in manuals (#1460)
-rw-r--r--README.md2
-rw-r--r--docs/src/doc/docs/developer_guide/data_model.md2
-rw-r--r--docs/src/doc/docs/user_guide/cli/usage.md20
-rw-r--r--docs/src/doc/docs/user_guide/gradle/usage.md4
4 files changed, 23 insertions, 5 deletions
diff --git a/README.md b/README.md
index bb5a19a2..1635e787 100644
--- a/README.md
+++ b/README.md
@@ -169,7 +169,7 @@ Please see the [Dokka Maven example project](https://github.com/JetBrains/kotlin
### Using the Command Line
-To run Dokka from the command line, download the [Dokka CLI runner](https://github.com/Kotlin/dokka/releases/download/v1.4.10/dokka-cli-1.4.10.jar).
+To run Dokka from the command line, download the [Dokka CLI runner](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-cli).
To generate documentation, run the following command:
```
java -jar dokka-cli.jar <arguments>
diff --git a/docs/src/doc/docs/developer_guide/data_model.md b/docs/src/doc/docs/developer_guide/data_model.md
index 3da3f98e..3f8d4645 100644
--- a/docs/src/doc/docs/developer_guide/data_model.md
+++ b/docs/src/doc/docs/developer_guide/data_model.md
@@ -6,7 +6,7 @@ There a four data models that Dokka uses: Documentable Model, Documentation Mode
Documentable model represents parsed data, returned by compiler analysis. It retains basic order structure of parsed `Psi` or `Descriptor` models.
-After creation, it is a collection of trees, each with `DModel` as a root. After the Merge step, all trees are folded into one.
+After creation, it is a collection of trees, each with `DModule` as a root. After the Merge step, all trees are folded into one.
The main building block of this model is `Documentable` class, that is a base class for all more specific types that represents elements of parsed Kotlin and Java classes with pretty self-explanatory names: `DPackage`, `DFunction` and so on. `DClasslike` is a base for class-like elements, such as Classes, Enums, Interfaces and so on.
diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md
index e6bedf5e..6f9ca84a 100644
--- a/docs/src/doc/docs/user_guide/cli/usage.md
+++ b/docs/src/doc/docs/user_guide/cli/usage.md
@@ -1,6 +1,6 @@
# Using command line
-To run Dokka from the command line, download the [Dokka CLI runner](https://github.com/Kotlin/dokka/releases/download/v1.4.10/dokka-cli-1.4.10.jar).
+To run Dokka from the command line, download the [Dokka CLI runner](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-cli).
To generate documentation, run the following command:
```
java -jar dokka-cli.jar <arguments>
@@ -47,3 +47,21 @@ You can also use a JSON file with Dokka configuration:
## Applying plugins
To apply a Dokka plugin you have to provide it and all its dependencies in the `pluginsClasspath` parameter
+
+## Base plugin
+
+Using CLI runner to generate default documentation requires providing all dependencies manually on classpath.
+For Base plugins these are:
+
+* [dokka-base.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-base)
+* [dokka-analysis.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-analysis)
+* [kotlin-analysis-compiler.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-compiler)
+* [kotlin-analysis-intellij.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-intellij)
+* [kotlinx-coroutines-core.jar](https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-coroutines-core/1.3.9)
+* [kotlinx-html-jvm.jar](https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-html-jvm?repo=kotlinx)
+
+All of them are published on maven central.
+To get them on classpath one should add them via `pluginsClasspath` argument, e. g.
+```
+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" ...
+```
diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md
index e0f84e96..2bdb7d2e 100644
--- a/docs/src/doc/docs/user_guide/gradle/usage.md
+++ b/docs/src/doc/docs/user_guide/gradle/usage.md
@@ -213,8 +213,8 @@ tasks.withType<DokkaTask>().configureEach {
}
register("differentName") { // Different name, so source roots must be passed explicitly
- displayName = "JVM"
- platform = "jvm"
+ displayName.set("JVM")
+ platform.set(org.jetbrains.dokka.Platform.jvm)
sourceRoots.from(kotlin.sourceSets.getByName("jvmMain").kotlin.srcDirs)
sourceRoots.from(kotlin.sourceSets.getByName("commonMain").kotlin.srcDirs)
}