aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKamil Doległo <kamilok1965@interia.pl>2019-08-27 16:20:16 +0200
committerKamil Doległo <kamilok1965@interia.pl>2019-08-27 16:20:16 +0200
commitfc93d14549ca4d14f1f45fbe143d87ac6dc2fdd9 (patch)
treefb4c2cf6493cdd36d83f52423deb168f1a23987d
parent895148ff5d597248c039c08d6efbaeb316b72d00 (diff)
downloaddokka-fc93d14549ca4d14f1f45fbe143d87ac6dc2fdd9.tar.gz
dokka-fc93d14549ca4d14f1f45fbe143d87ac6dc2fdd9.tar.bz2
dokka-fc93d14549ca4d14f1f45fbe143d87ac6dc2fdd9.zip
Fix typo in readme
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 353a5928..b662a556 100644
--- a/README.md
+++ b/README.md
@@ -183,13 +183,13 @@ dokka {
#### Multiplatform
Since version 0.9.19 dokka supports multiplatform projects. For a general understanding how a multiplatform documentation is generated, please consult the [FAQ](https://github.com/Kotlin/dokka/wiki/faq).
-In the multiplatform mode, the `configuration` block is replaced by a `multiplatform` block which has inner blocks for each platform. The inner blocks can be named arbitrary, however if you want to use source roots and classpath provided by Kotlin Multiplatform plugin, they must have the same names. See the example blow:
+In the multiplatform mode, the `configuration` block is replaced by a `multiplatform` block which has inner blocks for each platform. The inner blocks can be named arbitrarly, however if you want to use source roots and classpath provided by Kotlin Multiplatform plugin, they must have the same names. See an example below:
Groovy
```groovy
kotlin { // Kotlin Multiplatform plugin configuration
jvm()
- js("customName")
+ js("customName") // Define a js platform named "customName" If you want to generate docs for it, you need to have this name in dokka configuration below
}
dokka {