From 42e6a4a6b38d2d9a8febd56d99f062f1a8c78bf3 Mon Sep 17 00:00:00 2001 From: "ying.li" Date: Thu, 14 Mar 2024 00:22:33 +0900 Subject: [PATCH 1/3] fix for broken link --- docs/topics/dokka-plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/dokka-plugins.md b/docs/topics/dokka-plugins.md index 45ecb1ddd2..67dc1fdaa4 100644 --- a/docs/topics/dokka-plugins.md +++ b/docs/topics/dokka-plugins.md @@ -272,7 +272,7 @@ Here are some notable Dokka plugins that you might find useful: | [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 | +| [Kotlin as Java plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-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/). From 7ceb9f447a6f835bf5379ed196666e0ffde4be76 Mon Sep 17 00:00:00 2001 From: "ying.li" Date: Thu, 14 Mar 2024 00:32:33 +0900 Subject: [PATCH 2/3] fix for sample code --- docs/topics/runners/dokka-maven.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/runners/dokka-maven.md b/docs/topics/runners/dokka-maven.md index 5f52dab2c2..e7e502e557 100644 --- a/docs/topics/runners/dokka-maven.md +++ b/docs/topics/runners/dokka-maven.md @@ -586,7 +586,7 @@ Below you can see all the possible configuration options applied at the same tim false false - src + ${project.basedir}/src PUBLIC @@ -617,7 +617,7 @@ Below you can see all the possible configuration options applied at the same tim - ${project.basedir}/src + src https://github.com/kotlin/dokka/tree/master/src #L From 6c9daf13317286a9b7c697bb324fa872c63c7d5f Mon Sep 17 00:00:00 2001 From: "ying.li" Date: Thu, 14 Mar 2024 00:35:43 +0900 Subject: [PATCH 3/3] fix for typo and broken link --- docs/topics/formats/dokka-markdown.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/formats/dokka-markdown.md b/docs/topics/formats/dokka-markdown.md index 4d0ba61a93..c4055c7a74 100644 --- a/docs/topics/formats/dokka-markdown.md +++ b/docs/topics/formats/dokka-markdown.md @@ -54,13 +54,13 @@ dependency: After configuring this, running the `dokka:dokka` goal produces documentation in GFM format. -For more information, see the Mavin plugin documentation for [Other output formats](dokka-maven.md#other-output-formats). +For more information, see the Maven plugin documentation for [Other output formats](dokka-maven.md#other-output-formats). Since GFM format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to -[download the JAR file]((https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar)) +[download the JAR file](https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar) and pass it to `pluginsClasspath`. Via [command line options](dokka-cli.md#run-with-command-line-options):