diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-11-10 13:49:05 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-10 13:49:05 +0100 |
| commit | dab421f8d977f157ce9bdcbe0ffea7249735d847 (patch) | |
| tree | fe5535f762c01ff005e12551d765c9c8db7466a9 /docs/topics/formats | |
| parent | 4322f755c90622ed9a8ad7b9f471cd86482de03f (diff) | |
| download | dokka-dab421f8d977f157ce9bdcbe0ffea7249735d847.tar.gz dokka-dab421f8d977f157ce9bdcbe0ffea7249735d847.tar.bz2 dokka-dab421f8d977f157ce9bdcbe0ffea7249735d847.zip | |
Use versioned code links in user-facing documentation (#3327)
Diffstat (limited to 'docs/topics/formats')
| -rw-r--r-- | docs/topics/formats/dokka-html.md | 10 | ||||
| -rw-r--r-- | docs/topics/formats/dokka-javadoc.md | 4 |
2 files changed, 7 insertions, 7 deletions
diff --git a/docs/topics/formats/dokka-html.md b/docs/topics/formats/dokka-html.md index 154a2587..009ec2e1 100644 --- a/docs/topics/formats/dokka-html.md +++ b/docs/topics/formats/dokka-html.md @@ -275,8 +275,8 @@ context and thus they need to be resolved at later stages by the [MultiModule](d You can also use the following Dokka-defined [directives](https://freemarker.apache.org/docs/ref_directive_userDefined.html): -| **Variable** | **Description** | -|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `<@content/>` | The main page content. | -| `<@resources/>` | Resources such as scripts and stylesheets. | -| `<@version/>` | The module version taken from configuration. If the [versioning plugin](https://github.com/Kotlin/dokka/tree/master/plugins/versioning) is applied, it is replaced with a version navigator. | +| **Variable** | **Description** | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `<@content/>` | The main page content. | +| `<@resources/>` | Resources such as scripts and stylesheets. | +| `<@version/>` | The module version taken from configuration. If the [versioning plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/versioning) is applied, it is replaced with a version navigator. | diff --git a/docs/topics/formats/dokka-javadoc.md b/docs/topics/formats/dokka-javadoc.md index 3dbd3f05..abcfc540 100644 --- a/docs/topics/formats/dokka-javadoc.md +++ b/docs/topics/formats/dokka-javadoc.md @@ -15,11 +15,11 @@ or an exact copy. {width=706} All Kotlin code and signatures are rendered as seen from Java's perspective. This is achieved with our -[Kotlin as Java Dokka plugin](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java), which comes bundled and +[Kotlin as Java Dokka plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/kotlin-as-java), which comes bundled and applied by default for this format. The Javadoc output format is implemented as a [Dokka plugin](dokka-plugins.md), and it is maintained by the Dokka team. -It is open source and you can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc). +It is open source and you can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/javadoc). ## Generate Javadoc documentation |