blob: d605f31a481cd356ea14a4f6434a3f18a78400a5 (
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
[//]: # (title: Get started with Dokka)
Below you can find simple instructions to help you get started with Dokka.
<tabs group="build-script">
<tab title="Gradle Kotlin DSL" group-key="kotlin">
Apply the Gradle plugin for Dokka in the root build script of your project:
```kotlin
plugins {
id("org.jetbrains.dokka") version "%dokkaVersion%"
}
```
When documenting [multi-project](https://docs.gradle.org/current/userguide/multi_project_builds.html) builds, you need
to apply the Gradle plugin within subprojects as well:
```kotlin
subprojects {
apply(plugin = "org.jetbrains.dokka")
}
```
To generate documentation, run the following Gradle tasks:
* `dokkaHtml` for single-project builds
* `dokkaHtmlMultiModule` for multi-project builds
By default, the output directory is set to `/build/dokka/html` and `/build/dokka/htmlMultiModule`.
To learn more about using Dokka with Gradle, see [Gradle](dokka-gradle.md).
</tab>
<tab title="Gradle Groovy DSL" group-key="groovy">
Apply the Gradle plugin for Dokka in the root build script of your project:
```groovy
plugins {
id 'org.jetbrains.dokka' version '%dokkaVersion%'
}
```
When documenting [multi-project](https://docs.gradle.org/current/userguide/multi_project_builds.html) builds, you need
to apply the Gradle plugin within subprojects as well:
```groovy
subprojects {
apply plugin: 'org.jetbrains.dokka'
}
```
To generate documentation, run the following Gradle tasks:
* `dokkaHtml` for single-project builds
* `dokkaHtmlMultiModule` for multi-project builds
By default, the output directory is set to `/build/dokka/html` and `/build/dokka/htmlMultiModule`.
To learn more about using Dokka with Gradle, see [Gradle](dokka-gradle.md).
</tab>
<tab title="Maven" group-key="mvn">
Add the Maven plugin for Dokka to the `plugins` section of your POM file:
```xml
<build>
<plugins>
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
<version>%dokkaVersion%</version>
<executions>
<execution>
<phase>pre-site</phase>
<goals>
<goal>dokka</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
```
To generate documentation, run the `dokka:dokka` goal.
By default, the output directory is set to `target/dokka`.
To learn more about using Dokka with Maven, see [Maven](dokka-maven.md).
</tab>
</tabs>
<a href="https://surveys.jetbrains.com/s3/dokka-survey">
<img src="dokka-devx-survey-banner.png" width="700" alt="Dokka devX survey"/>
</a>
|
