diff options
| author | Kamil Doległo <kamilok1965@interia.pl> | 2019-09-17 09:43:41 +0200 |
|---|---|---|
| committer | Kamil Doległo <kamilok1965@interia.pl> | 2019-09-17 09:44:06 +0200 |
| commit | 2460b1d9fd22f5742d99ae79e9bd0eca0f791a03 (patch) | |
| tree | fd42f2c2a2ec36024b7164a80b6455aff3bfb1cb | |
| parent | dc5f41e71cb1240a19ee24c18281319cf1ee27ce (diff) | |
| download | dokka-2460b1d9fd22f5742d99ae79e9bd0eca0f791a03.tar.gz dokka-2460b1d9fd22f5742d99ae79e9bd0eca0f791a03.tar.bz2 dokka-2460b1d9fd22f5742d99ae79e9bd0eca0f791a03.zip | |
Readme update
| -rw-r--r-- | README.md | 9 |
1 files changed, 5 insertions, 4 deletions
@@ -97,7 +97,7 @@ dokka { // Do not create index pages for empty packages skipEmptyPackages = true - // See the "Platforms" section of this readme + // This is a list of platform names that will be shown in the final result. See the "Platforms" section of this readme targets = ["JVM"] // Platform used for code analysis. See the "Platforms" section of this readme @@ -259,7 +259,7 @@ dokka { prefix = "com.somePackage" suppress = true } - perPackageOption { + perPackageOption { // You can repeat this block for multiple perPackageOptions prefix = "kotlin" skipDeprecated = false reportUndocumented = true @@ -279,7 +279,7 @@ dokka { } } ``` - +The parameters from the `global` block are appended to all the other platform configurations (in the example - `js` and `jvm`) and cannot be overriden. Note that `javadoc` output format cannot be used with multiplatform. @@ -623,7 +623,8 @@ Example result and usage can be found on [kotlinlang.org](https://kotlinlang.org Each multiplatform closure has two properties: `platform` and `targets`. If you use autoconfiguration, those are filled automatically. -`targets` property is a list of platform names that will be shown in the final result. +`targets` property is a list of platform names that will be shown in the final result. Note that the value of this property +doesn't affect analysis of source code, it just changes the result. You can think of this as a `name` property `platform` property is used for the analysis of source roots. Available values are: * `jvm` |