blob: 3401e8e96c59eb73f6efb448abbf4c9ef77436d7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
# Dokka Gradle example
This example demonstrates how to apply Dokka in a simple single-project Gradle build, as well as how to configure it.
Configuration changes:
* Custom project name used in the header, `Dokka Gradle Example`.
* Description for the project and the packages taken from [Module.md](Module.md).
* Documentation contains source links that lead to declarations in this GitHub repository.
You can see up-to-date documentation generated for this example on
[GitHub Pages](https://kotlin.github.io/dokka/examples/dokka-gradle-example/html/index.html).
### Running
Run `dokkaHtml` task to generate documentation for this example:
```bash
./gradlew dokkaHtml
```
|
