From 2ddd3e86cd8a348792492b67ad57d457ba990e65 Mon Sep 17 00:00:00 2001 From: Cedric Beust Date: Mon, 16 Nov 2015 22:48:33 -0800 Subject: [PATCH] Update dokka doc. --- plug-ins/index.html | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/plug-ins/index.html b/plug-ins/index.html index 1baae44..24d51cc 100644 --- a/plug-ins/index.html +++ b/plug-ins/index.html @@ -322,17 +322,34 @@ $ ./kobaltw uploadJcenter // ... dokka { - args("-output", "markdown") - linkMapping { + outputFormat = "markdown" + sourceLinks { dir = "src/main/kotlin" url = "https://github.com/cy6erGn0m/vertx3-lang-kotlin/blob/master/src/main/kotlin" - suffix = "#L" + urlSuffix = "#L" } }

- You can then generate your documentation by running the dokka task. + You can then generate your documentation by running the dokka task. Here is the full list of configuration parameters allowed:

+
+
samplesDir
+
The list of directories containing sample code (documentation for those directories is not generated but declarations from them can be referenced using the @sample tag).
+
includeDirs
+
The names of directories containing the documentation for the module and individual packages.
+
outputDir
+
The output directory where the documentation is generated.
+
outputFormat
+
The output format: html, markdown, jekyll, + or javadoc.
+
sourceLinks
+
The source link mappings.
+
moduleName
+
The name of the module being documented (used as the root directory of the generated documentation).
+
skip
+
If true, don't generate anything.
+