aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKrystianUjma <kujma@virtuslab.com>2019-02-27 17:41:04 +0100
committerSimon Ogorodnik <Simon.Ogorodnik@jetbrains.com>2019-03-11 19:07:22 +0300
commit7d7e2012e35722c6c0315b2205d708ef5d4341d9 (patch)
treea8121e7fed01268999be8f8bf3091333277e6787 /README.md
parent20bd82d30881f8b8439ea49baab923bc04ff1f2e (diff)
downloaddokka-7d7e2012e35722c6c0315b2205d708ef5d4341d9.tar.gz
dokka-7d7e2012e35722c6c0315b2205d708ef5d4341d9.tar.bz2
dokka-7d7e2012e35722c6c0315b2205d708ef5d4341d9.zip
Fix test, prohibit non-unix path style for dir property
Update readme.md, allow only unix based path (dir property)
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index f0cca532..92ea9e2a 100644
--- a/README.md
+++ b/README.md
@@ -100,7 +100,7 @@ dokka {
// If provided, Dokka generates "source" links for each declaration.
// Repeat for multiple mappings
linkMapping {
- // Directory relative to the root of the project (where you execute gradle respectively).
+ // Unix based directory relative path to the root of the project (where you execute gradle respectively).
dir = "src/main/kotlin" // or simply "./"
// URL showing where the source code can be accessed through the web browser
@@ -297,7 +297,7 @@ The available configuration options are shown below:
<!-- Source directory -->
<dir>${project.basedir}/src/main/kotlin</dir>
<!-- URL showing where the source code can be accessed through the web browser -->
- <url>https://github.com/me/myrepo</url>
+ <url>https://github.com/cy6erGn0m/vertx3-lang-kotlin/blob/master/src/main/kotlin</url> <!-- //remove src/main/kotlin if you use "./" above -->
<!--Suffix which is used to append the line number to the URL. Use #L for GitHub -->
<urlSuffix>#L</urlSuffix>
</link>