aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2024-03-05 10:26:22 +0100
committerGitHub <noreply@github.com>2024-03-05 10:26:22 +0100
commit471b7c0b1039ca55c34caed35d29ce630616fd63 (patch)
treedeb82b19b1c0ce5479cf105b4dfcb0a0316c42c8
parent7ccc48eda17ecd82e2974002faf7e5da188ae2c5 (diff)
downloaddokka-471b7c0b1039ca55c34caed35d29ce630616fd63.tar.gz
Update kotlinlang docs version to 1.9.20 (#3512)
-rw-r--r--docs/topics/dokka-plugins.md16
-rw-r--r--docs/topics/formats/dokka-html.md16
-rw-r--r--docs/topics/formats/dokka-javadoc.md4
-rw-r--r--docs/topics/formats/dokka-markdown.md4
-rw-r--r--docs/v.list4
5 files changed, 22 insertions, 22 deletions
diff --git a/docs/topics/dokka-plugins.md b/docs/topics/dokka-plugins.md
index 172b6ad55..45ecb1ddd 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/%dokkaVersion%/plugins/mathjax)
+Let's have a look at how you can apply the [mathjax plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-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/%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 |
+| **Name** | **Description** |
+|------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
+| [Android documentation plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-android-documentation) | Improves the documentation experience on Android |
+| [Versioning plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-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%/dokka-subprojects/plugin-mathjax) | Pretty prints mathematics found in KDocs |
+| [Kotlin as Java plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/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 009ec2e1a..1d9a887fe 100644
--- a/docs/topics/formats/dokka-html.md
+++ b/docs/topics/formats/dokka-html.md
@@ -197,7 +197,7 @@ It's also possible to override Dokka's default stylesheets by providing files wi
| `prism.css` | Styles for [PrismJS](https://prismjs.com/) syntax highlighter |
The source code for all of Dokka's stylesheets is
-[available on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/base/src/main/resources/dokka/styles).
+[available on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-base/src/main/resources/dokka/styles).
### Customize assets
@@ -210,7 +210,7 @@ It's possible to override Dokka's images and icons by providing files with the s
useful and relevant one being `logo-icon.svg`, which is the image that's used in the header. The rest is mostly icons.
You can find all images used by Dokka on
-[GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/base/src/main/resources/dokka/images).
+[GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-base/src/main/resources/dokka/images).
### Change the logo
@@ -244,7 +244,7 @@ Dokka uses the following templates:
| `includes/source_set_selector.ftl` | [The source set](https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets) selector in the header. |
The base template is `base.ftl` and it includes all of the remaining listed templates. You can find the source code for all of Dokka's templates
-[on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/base/src/main/resources/dokka/templates).
+[on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-base/src/main/resources/dokka/templates).
You can override any template by using the `templatesDir` [configuration option](#configuration). Dokka searches
for the exact template names within the given directory. If it fails to find user-defined templates, it uses the
@@ -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/%dokkaVersion%/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%/dokka-subprojects/plugin-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 abcfc540c..80321c330 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/%dokkaVersion%/plugins/kotlin-as-java), which comes bundled and
+[Kotlin as Java Dokka plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-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/%dokkaVersion%/plugins/javadoc).
+It is open source and you can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-javadoc).
## Generate Javadoc documentation
diff --git a/docs/topics/formats/dokka-markdown.md b/docs/topics/formats/dokka-markdown.md
index a8e22129e..4d0ba61a9 100644
--- a/docs/topics/formats/dokka-markdown.md
+++ b/docs/topics/formats/dokka-markdown.md
@@ -90,7 +90,7 @@ For more information, see the CLI runner's documentation for [Other output forma
</tab>
</tabs>
-You can find the source code [on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/gfm).
+You can find the source code [on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-gfm).
## Jekyll
@@ -170,4 +170,4 @@ For more information, see the CLI runner's documentation for [Other output forma
</tab>
</tabs>
-You can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/jekyll).
+You can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-jekyll).
diff --git a/docs/v.list b/docs/v.list
index 34141810d..9d7232fe0 100644
--- a/docs/v.list
+++ b/docs/v.list
@@ -4,9 +4,9 @@
<vars>
<var name="dokkaVersion"
- value="1.9.10"
+ value="1.9.20"
type="string"/>
<var name="kotlinVersion"
- value="1.9.10"
+ value="1.9.22"
type="string"/>
</vars>