diff options
| author | Sergey Mashkov <sergey.mashkov@jetbrains.com> | 2015-07-10 15:51:59 +0300 |
|---|---|---|
| committer | Sergey Mashkov <sergey.mashkov@jetbrains.com> | 2015-07-13 17:57:56 +0300 |
| commit | b3c4292f209511e79c84dd76d42355baa04e16ba (patch) | |
| tree | a2ad0970fb3b5aeed1005173c2ffb241eaaca0fa | |
| parent | 3d25df6c3c68b43431abbed326b17c50717a18f7 (diff) | |
| download | dokka-b3c4292f209511e79c84dd76d42355baa04e16ba.tar.gz dokka-b3c4292f209511e79c84dd76d42355baa04e16ba.tar.bz2 dokka-b3c4292f209511e79c84dd76d42355baa04e16ba.zip | |
Maven plugin getting started
| -rw-r--r-- | README.md | 48 |
1 files changed, 48 insertions, 0 deletions
@@ -106,3 +106,51 @@ Build dokka and install maven plugin (do not require maven installed) ```bash ant build-and-install ``` + +### Using Maven plugin + +Minimal maven configuration is + +```xml +<plugin> + <groupId>org.jetbrains.dokka</groupId> + <artifactId>dokka-maven-plugin</artifactId> + <version>${dokka.version}</version> + <executions> + <execution> + <phase>pre-site</phase> + <goals> + <goal>dokka</goal> + </goals> + </execution> + </executions> +</plugin> +``` + +by default files will be generated in `target/dokka` + +Configuring source links mapping + +```xml +<plugin> + <groupId>org.jetbrains.dokka</groupId> + <artifactId>dokka-maven-plugin</artifactId> + <version>${dokka.version}</version> + <executions> + <execution> + <phase>pre-site</phase> + <goals> + <goal>dokka</goal> + </goals> + </execution> + </executions> + <configuration> + <sourceLinks> + <link> + <dir>${project.basedir}/src/main/kotlin</dir> + <url>http://github.com/me/myrepo</url> + </link> + </sourceLinks> + </configuration> +</plugin> +```
\ No newline at end of file |