blob: c8b224ec32932a616dbdd22dc32b2bd41327b4a6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
# Dokka MultiModule example
This example demonstrates how to apply and configure Dokka in a
[multi-project build](https://docs.gradle.org/current/userguide/multi_project_builds.html).
You can also learn how to set Dokka's version in [gradle.properties](gradle.properties) using `pluginManagement`
configuration block in [settings.gradle.kts](settings.gradle.kts).
____
You can see up-to-date documentation generated for this example on
[GitHub Pages](https://kotlin.github.io/dokka/examples/dokka-multimodule-example/htmlMultiModule/index.html).
### Running
Run `dokkaHtmlMultiModule` task to generate documentation for this example:
```bash
./gradlew dokkaHtmlMultiModule
```
It will generate complete documentation for the root project and its subprojects, with a common
Table of Contents.
|
