aboutsummaryrefslogtreecommitdiff
path: root/docs/topics/runners/dokka-maven.md
diff options
context:
space:
mode:
authorfreya02 <41875020+freya022@users.noreply.github.com>2023-10-18 22:33:01 +0200
committerGitHub <noreply@github.com>2023-10-18 22:33:01 +0200
commit8016c1face1283952e228aee348487bf0421ab90 (patch)
tree5216ef6a32e01ef74329e2eaee6027f19d678daa /docs/topics/runners/dokka-maven.md
parentf225fafdf10f351d31e546b73eb511f46ffc6806 (diff)
downloaddokka-8016c1face1283952e228aee348487bf0421ab90.tar.gz
dokka-8016c1face1283952e228aee348487bf0421ab90.tar.bz2
dokka-8016c1face1283952e228aee348487bf0421ab90.zip
Fix sources not being linked when using Maven (#3046)
Diffstat (limited to 'docs/topics/runners/dokka-maven.md')
-rw-r--r--docs/topics/runners/dokka-maven.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/topics/runners/dokka-maven.md b/docs/topics/runners/dokka-maven.md
index 14551c91..bc51d5fe 100644
--- a/docs/topics/runners/dokka-maven.md
+++ b/docs/topics/runners/dokka-maven.md
@@ -407,7 +407,7 @@ function in `kotlinx.coroutines`.
<configuration>
<sourceLinks>
<link>
- <path>${project.basedir}/src</path>
+ <path>src</path>
<url>https://github.com/kotlin/dokka/tree/master/src</url>
<lineSuffix>#L</lineSuffix>
</link>
@@ -422,6 +422,9 @@ function in `kotlinx.coroutines`.
The path to the local source directory. The path must be relative to the root of the
current module.
</p>
+ <p>
+ Note: Only Unix based paths are allowed, Windows-style paths will throw an error.
+ </p>
</def>
<def title="url">
<p>