aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Ogorodnik <sem-oro@yandex.ru>2017-06-07 21:40:21 +0300
committerGitHub <noreply@github.com>2017-06-07 21:40:21 +0300
commitb05a711dc2a53f865840c5f59159ca4ce7fd1b89 (patch)
treea14ddbf38b27880065f469ede3f7b205c43c0441
parent6300b94ac84133dd3ec7e87752f133832d4b7642 (diff)
downloaddokka-b05a711dc2a53f865840c5f59159ca4ce7fd1b89.tar.gz
dokka-b05a711dc2a53f865840c5f59159ca4ce7fd1b89.tar.bz2
dokka-b05a711dc2a53f865840c5f59159ca4ce7fd1b89.zip
Fix slashes in external linking documentation
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index a5ea058f..d766f1d5 100644
--- a/README.md
+++ b/README.md
@@ -103,8 +103,8 @@ dokka {
// Allows linking to documentation of the project's dependencies (generated with Javadoc or Dokka)
// Repeat for multiple links
externalDocumentationLink {
- // URL of the generated documentation
- url = new URL("https://example.com/docs")
+ // Root URL of the generated documentation to link with. The trailing slash is required!
+ url = new URL("https://example.com/docs/")
// If package-list file located in non-standard location
// packageListUrl = new URL("file:///home/user/localdocs/package-list")
@@ -287,8 +287,8 @@ The available configuration options are shown below:
<!-- Allows linking to documentation of the project's dependencies (generated with Javadoc or Dokka) -->
<externalDocumentationLinks>
<link>
- <!-- URL of the generated documentation -->
- <url>https://example.com/docs</url>
+ <!-- Root URL of the generated documentation to link with. The trailing slash is required! -->
+ <url>https://example.com/docs/</url>
<!-- If package-list file located in non-standard location -->
<!-- <packageListUrl>file:///home/user/localdocs/package-list</packageListUrl> -->
</link>
@@ -344,7 +344,7 @@ The Ant task supports the following attributes:
* `<packageOptions prefix="kotlin" includeNonPublic="false" reportUndocumented="true" skipDeprecated="false"/>` -
Per package options for package `kotlin` and sub-packages of it
* `noStdlibLink` - No default documentation link to kotlin-stdlib
- * `<externalDocumentationLink url="https://example.com/docs" packageListUrl="file:///home/user/localdocs/package-list"/>` -
+ * `<externalDocumentationLink url="https://example.com/docs/" packageListUrl="file:///home/user/localdocs/package-list"/>` -
linking to external documentation, packageListUrl should be used if package-list located not in standard location