diff options
| author | Dmitry Jemerov <yole@jetbrains.com> | 2016-03-31 16:40:12 +0200 |
|---|---|---|
| committer | Dmitry Jemerov <yole@jetbrains.com> | 2016-03-31 16:40:12 +0200 |
| commit | c5e3635480bd7b5c1e9073870473983c0a634c7b (patch) | |
| tree | 39718b9be9f4f6f3312843a0a7a1e41a860c57e8 | |
| parent | 382f7df5b47b7b4fd5c9930b26a2e0ededdb17be (diff) | |
| download | dokka-c5e3635480bd7b5c1e9073870473983c0a634c7b.tar.gz dokka-c5e3635480bd7b5c1e9073870473983c0a634c7b.tar.bz2 dokka-c5e3635480bd7b5c1e9073870473983c0a634c7b.zip | |
clarify command line argument syntax
| -rw-r--r-- | README.md | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -17,17 +17,17 @@ To generate documentation, run the following command: Dokka supports the following command line arguments: - * `output` - the output directory where the documentation is generated - * `format` - the output format: + * `-output` - the output directory where the documentation is generated + * `-format` - the output format: * `html` - HTML (default) * `markdown` - Markdown * `jekyll` - Markdown adapted for Jekyll sites * `javadoc` - Javadoc (showing how the project can be accessed from Java) - * `classpath` - list of directories or .jar files to include in the classpath (used for resolving references) - * `samples` - list of directories containing sample code (documentation for those directories is not generated but declarations from them can be referenced using the `@sample` tag) - * `module` - the name of the module being documented (used as the root directory of the generated documentation) - * `include` - names of files containing the documentation for the module and individual packages - * `nodeprecated` - if set, deprecated elements are not included in the generated documentation + * `-classpath` - list of directories or .jar files to include in the classpath (used for resolving references) + * `-samples` - list of directories containing sample code (documentation for those directories is not generated but declarations from them can be referenced using the `@sample` tag) + * `-module` - the name of the module being documented (used as the root directory of the generated documentation) + * `-include` - names of files containing the documentation for the module and individual packages + * `-nodeprecated` - if set, deprecated elements are not included in the generated documentation ### Using the Ant task |