diff options
| author | Dmitry Jemerov <yole@jetbrains.com> | 2016-05-12 15:21:24 +0200 |
|---|---|---|
| committer | Dmitry Jemerov <yole@jetbrains.com> | 2016-05-12 15:21:24 +0200 |
| commit | ffd0fa4b2862b3543fae0425a3424e01e368e3df (patch) | |
| tree | be47e2e253bd9694792c57df68b0e1ad328fbdf9 /README.md | |
| parent | 46fbf8e88186a1e98c3956c2c3144aad8c2465da (diff) | |
| download | dokka-ffd0fa4b2862b3543fae0425a3424e01e368e3df.tar.gz | |
update docs for 0.9.8
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -10,7 +10,7 @@ and can generate documentation in multiple formats including standard Javadoc, H ### Using the Command Line -To run Dokka from the command line, download the [Dokka jar](https://github.com/Kotlin/dokka/releases/download/0.9.7/dokka-fatjar.jar). +To run Dokka from the command line, download the [Dokka jar](https://github.com/Kotlin/dokka/releases/download/0.9.8/dokka-fatjar.jar). To generate documentation, run the following command: java -jar dokka-fatjar.jar <source directories> <arguments> @@ -86,7 +86,13 @@ Minimal maven configuration is </plugin> ``` -by default files will be generated in `target/dokka` +By default files will be generated in `target/dokka`. + +The following goals are provided by the plugin: + + * `dokka:dokka` - generate HTML documentation in Dokka format (showing declarations in Kotlin syntax); + * `dokka:javadoc` - generate HTML documentation in JavaDoc format (showing declarations in Java syntax); + * `dokka:javadocJar` - generate a .jar file with JavaDoc format documentation. Configuring source links mapping: |