aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-11-10 13:49:05 +0100
committerGitHub <noreply@github.com>2023-11-10 13:49:05 +0100
commitdab421f8d977f157ce9bdcbe0ffea7249735d847 (patch)
treefe5535f762c01ff005e12551d765c9c8db7466a9
parent4322f755c90622ed9a8ad7b9f471cd86482de03f (diff)
downloaddokka-dab421f8d977f157ce9bdcbe0ffea7249735d847.tar.gz
dokka-dab421f8d977f157ce9bdcbe0ffea7249735d847.tar.bz2
dokka-dab421f8d977f157ce9bdcbe0ffea7249735d847.zip
Use versioned code links in user-facing documentation (#3327)
-rw-r--r--docs/topics/dokka-module-and-package-docs.md2
-rw-r--r--docs/topics/dokka-plugins.md16
-rw-r--r--docs/topics/formats/dokka-html.md10
-rw-r--r--docs/topics/formats/dokka-javadoc.md4
-rw-r--r--docs/topics/runners/dokka-gradle.md24
5 files changed, 28 insertions, 28 deletions
diff --git a/docs/topics/dokka-module-and-package-docs.md b/docs/topics/dokka-module-and-package-docs.md
index 9bf78619..d6c7af0b 100644
--- a/docs/topics/dokka-module-and-package-docs.md
+++ b/docs/topics/dokka-module-and-package-docs.md
@@ -45,7 +45,7 @@ It also appears under the first-level heading on your package's page.
Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo2`
```
-To explore an example project with Gradle, see [Dokka gradle example](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-gradle-example).
+To explore an example project with Gradle, see [Dokka gradle example](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/examples/gradle/dokka-gradle-example).
## Pass files to Dokka
diff --git a/docs/topics/dokka-plugins.md b/docs/topics/dokka-plugins.md
index d8d9d249..172b6ad5 100644
--- a/docs/topics/dokka-plugins.md
+++ b/docs/topics/dokka-plugins.md
@@ -24,7 +24,7 @@ From there, the plugin extends Dokka by itself - no further action is needed.
>
{type="note"}
-Let's have a look at how you can apply the [mathjax plugin](https://github.com/Kotlin/dokka/tree/master/plugins/mathjax)
+Let's have a look at how you can apply the [mathjax plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/mathjax)
to your project:
<tabs group="build-script">
@@ -266,13 +266,13 @@ If you are using [JSON configuration](dokka-cli.md#run-with-json-configuration),
Here are some notable Dokka plugins that you might find useful:
-| **Name** | **Description** |
-|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
-| [Android documentation plugin](https://github.com/Kotlin/dokka/tree/master/plugins/android-documentation) | Improves the documentation experience on Android |
-| [Versioning plugin](https://github.com/Kotlin/dokka/tree/master/plugins/versioning) | Adds version selector and helps to organize documentation for different versions of your application/library |
-| [MermaidJS HTML plugin](https://github.com/glureau/dokka-mermaid) | Renders [MermaidJS](https://mermaid-js.github.io/mermaid/#/) diagrams and visualizations found in KDocs |
-| [Mathjax HTML plugin](https://github.com/Kotlin/dokka/tree/master/plugins/mathjax) | Pretty prints mathematics found in KDocs |
-| [Kotlin as Java plugin](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java) | Renders Kotlin signatures as seen from Java's perspective |
+| **Name** | **Description** |
+|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
+| [Android documentation plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/android-documentation) | Improves the documentation experience on Android |
+| [Versioning plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/versioning) | Adds version selector and helps to organize documentation for different versions of your application/library |
+| [MermaidJS HTML plugin](https://github.com/glureau/dokka-mermaid) | Renders [MermaidJS](https://mermaid-js.github.io/mermaid/#/) diagrams and visualizations found in KDocs |
+| [Mathjax HTML plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/mathjax) | Pretty prints mathematics found in KDocs |
+| [Kotlin as Java plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/kotlin-as-java) | Renders Kotlin signatures as seen from Java's perspective |
If you are a Dokka plugin author and would like to add your plugin to this list, get in touch with maintainers
via [Slack](dokka-introduction.md#community) or [GitHub](https://github.com/Kotlin/dokka/).
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.
![Screenshot of javadoc output format](javadoc-format-example.png){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
diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md
index a3287293..fd7864e3 100644
--- a/docs/topics/runners/dokka-gradle.md
+++ b/docs/topics/runners/dokka-gradle.md
@@ -90,14 +90,14 @@ and [multi-project](#multi-project-builds) builds.
Use the following tasks to build documentation for simple, single-project applications and libraries:
-| **Task** | **Description** |
-|----------------|-------------------------------------------------------------------------------------|
-| `dokkaHtml` | Generates documentation in [HTML](dokka-html.md) format. |
+| **Task** | **Description** |
+|-------------|----------------------------------------------------------|
+| `dokkaHtml` | Generates documentation in [HTML](dokka-html.md) format. |
#### Experimental formats
-| **Task** | **Description** |
-|----------------|-------------------------------------------------------------------------------------|
+| **Task** | **Description** |
+|----------------|-------------------------------------------------------------------------------------------|
| `dokkaGfm` | Generates documentation in [GitHub Flavored Markdown](dokka-markdown.md#gfm) format. |
| `dokkaJavadoc` | Generates documentation in [Javadoc](dokka-javadoc.md) format. |
| `dokkaJekyll` | Generates documentation in [Jekyll compatible Markdown](dokka-markdown.md#jekyll) format. |
@@ -119,14 +119,14 @@ cross-project references.
Dokka creates the following tasks for **parent** projects automatically:
-| **Task** | **Description** |
-|--------------------------|------------------------------------------------------------------------|
-| `dokkaHtmlMultiModule` | Generates multi-module documentation in [HTML](dokka-html.md) output format. |
+| **Task** | **Description** |
+|------------------------|------------------------------------------------------------------------------|
+| `dokkaHtmlMultiModule` | Generates multi-module documentation in [HTML](dokka-html.md) output format. |
#### Experimental formats (multi-module)
-| **Task** | **Description** |
-|--------------------------|---------------------------------------------------------------------------------------------------------|
+| **Task** | **Description** |
+|--------------------------|---------------------------------------------------------------------------------------------------------------|
| `dokkaGfmMultiModule` | Generates multi-module documentation in [GitHub Flavored Markdown](dokka-markdown.md#gfm) output format. |
| `dokkaJekyllMultiModule` | Generates multi-module documentation in [Jekyll compatible Markdown](dokka-markdown.md#jekyll) output format. |
@@ -155,7 +155,7 @@ These pages are generated after running `dokkaHtmlMultiModule`:
![Screenshot for output of dokkaHtmlMultiModule task](dokkaHtmlMultiModule-example.png){width=600}
-See our [multi-module project example](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-multimodule-example)
+See our [multi-module project example](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/examples/gradle/dokka-multimodule-example)
for more details.
#### Collector tasks
@@ -192,7 +192,7 @@ These pages are generated after running `dokkaHtmlCollector`:
![Screenshot for output of dokkaHtmlCollector task](dokkaHtmlCollector-example.png){width=706}
-See our [multi-module project example](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-multimodule-example)
+See our [multi-module project example](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/examples/gradle/dokka-multimodule-example)
for more details.
#### Partial tasks