From c9c52bdb76c9cdcc9ac018e50d667e1c2d0b2c6e Mon Sep 17 00:00:00 2001 From: Quattro8 <142494073+Quattro8@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:22:57 +0200 Subject: [PATCH] update: kotlinlang Writerside migration Related: https://github.com/JetBrains/kotlin-web-site/pull/4458 --- docs/cfg/buildprofiles.xml | 4 +-- docs/dokka.tree | 45 ++++++++++++--------------- docs/project.ihp | 13 -------- docs/topics/dokka-plugins.md | 6 ++-- docs/topics/formats/dokka-html.md | 2 +- docs/topics/formats/dokka-javadoc.md | 4 +-- docs/topics/formats/dokka-markdown.md | 2 +- docs/topics/runners/dokka-cli.md | 11 ++----- docs/topics/runners/dokka-gradle.md | 20 ++++++------ docs/topics/runners/dokka-maven.md | 10 +++--- docs/writerside.cfg | 13 ++++++++ 11 files changed, 58 insertions(+), 72 deletions(-) delete mode 100644 docs/project.ihp create mode 100644 docs/writerside.cfg diff --git a/docs/cfg/buildprofiles.xml b/docs/cfg/buildprofiles.xml index fafe80b9b6..4f4c7e35c0 100644 --- a/docs/cfg/buildprofiles.xml +++ b/docs/cfg/buildprofiles.xml @@ -4,11 +4,11 @@ ~ Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. --> - + true https://github.com/Kotlin/dokka/edit/master/docs/ true - + diff --git a/docs/dokka.tree b/docs/dokka.tree index 4cc096ac63..ba1b5bfabd 100644 --- a/docs/dokka.tree +++ b/docs/dokka.tree @@ -1,25 +1,20 @@ - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + diff --git a/docs/project.ihp b/docs/project.ihp deleted file mode 100644 index b6f35f7508..0000000000 --- a/docs/project.ihp +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - - - - - diff --git a/docs/topics/dokka-plugins.md b/docs/topics/dokka-plugins.md index 67dc1fdaa4..17bc0e58ff 100644 --- a/docs/topics/dokka-plugins.md +++ b/docs/topics/dokka-plugins.md @@ -22,7 +22,7 @@ From there, the plugin extends Dokka by itself - no further action is needed. > > If you notice problems like this, it's a good idea to check which plugins are applied and what they do. > -{type="note"} +{style="note"} 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: @@ -49,7 +49,7 @@ dependencies { > When documenting [multi-project](dokka-gradle.md#multi-project-builds) builds, you need to apply Dokka plugins within > subprojects as well as in their parent project. > -{type="note"} +{style="note"} @@ -73,7 +73,7 @@ dependencies { > When documenting [multi-project](dokka-gradle.md#multi-project-builds) builds, you need to apply Dokka plugins within > subprojects as well as in their parent project. > -{type="note"} +{style="note"} diff --git a/docs/topics/formats/dokka-html.md b/docs/topics/formats/dokka-html.md index 1d9a887fe8..98e5aeb967 100644 --- a/docs/topics/formats/dokka-html.md +++ b/docs/topics/formats/dokka-html.md @@ -21,7 +21,7 @@ your build tool or runner: > > Locally, you can use the [built-in IntelliJ web server](https://www.jetbrains.com/help/idea/php-built-in-web-server.html). > -{type="note"} +{style="note"} ## Configuration diff --git a/docs/topics/formats/dokka-javadoc.md b/docs/topics/formats/dokka-javadoc.md index 80321c3302..82e636a881 100644 --- a/docs/topics/formats/dokka-javadoc.md +++ b/docs/topics/formats/dokka-javadoc.md @@ -4,7 +4,7 @@ > Successful integration with tools that accept Java's Javadoc HTML as input is not guaranteed. > **You use it at your own risk.** > -{type="warning"} +{style="warning"} Dokka's Javadoc output format is a lookalike of Java's [Javadoc HTML format](https://docs.oracle.com/en/java/javase/19/docs/api/index.html). @@ -25,7 +25,7 @@ It is open source and you can find the source code on [GitHub](https://github.co > The Javadoc format does not support multiplatform projects. > -{type="warning"} +{style="warning"} diff --git a/docs/topics/formats/dokka-markdown.md b/docs/topics/formats/dokka-markdown.md index 33b155438d..f4b1b2f448 100644 --- a/docs/topics/formats/dokka-markdown.md +++ b/docs/topics/formats/dokka-markdown.md @@ -3,7 +3,7 @@ > The Markdown output formats are still in Alpha, so you may find bugs and experience migration issues when using them. > **You use them at your own risk.** > -{type="warning"} +{style="warning"} Dokka is able to generate documentation in [GitHub Flavored](#gfm) and [Jekyll](#jekyll) compatible Markdown. diff --git a/docs/topics/runners/dokka-cli.md b/docs/topics/runners/dokka-cli.md index a5a1832e90..9607dcf1d1 100644 --- a/docs/topics/runners/dokka-cli.md +++ b/docs/topics/runners/dokka-cli.md @@ -270,7 +270,6 @@ with [all configuration options](#complete-configuration) applied at the bottom

Whether to suppress obvious functions.

-

A function is considered to be obvious if it is:

  • @@ -282,7 +281,6 @@ with [all configuration options](#complete-configuration) applied at the bottom dataClass.componentN or dataClass.copy.
    • -

    Default: true

     @@ -425,7 +423,7 @@ How to configure Kotlin

    This can be configured on per-package basis.

    - Possible values: + Possible values:

  • PUBLIC
  • PRIVATE
    • @@ -433,7 +431,6 @@ How to configure Kotlin
  • INTERNAL
  • PACKAGE
    •  -

    Default: PUBLIC

     @@ -510,14 +507,13 @@ How to configure Kotlin @sample environment.

    - Possible values: + Possible values:

  • jvm
  • common
  • js
  • native
    •  -

    @@ -601,13 +597,12 @@ You can configure source links for all source sets together at the same time, or is #L10.

    - Suffixes used by popular services: + Suffixes used by popular services:

  • GitHub: #L
  • GitLab: #L
  • Bitbucket: #lines-
    •  -

    Default: empty (no suffix)

     diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md index 1b5472e089..4b279e46ff 100644 --- a/docs/topics/runners/dokka-gradle.md +++ b/docs/topics/runners/dokka-gradle.md @@ -67,14 +67,14 @@ See [Configuration examples](#configuration-examples) if you are not sure where > for which documentation is to be generated. Make sure to apply the Kotlin Gradle Plugin or > [configure source sets](#source-set-configuration) manually. > -{type="note"} +{style="note"} > If you are using Dokka in a > [precompiled script plugin](https://docs.gradle.org/current/userguide/custom_plugins.html#sec:precompiled_plugins), > you need to add the [Kotlin Gradle plugin](https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin) > as a dependency for it to work properly. > -{type="note"} +{style="note"} If you cannot use the plugins DSL for some reason, you can use [the legacy method](https://docs.gradle.org/current/userguide/plugins.html#sec:old_plugin_application) of applying @@ -133,7 +133,7 @@ Dokka creates the following tasks for **parent** projects automatically: > The [Javadoc](dokka-javadoc.md) output format does not have a `MultiModule` task, but a [`Collector`](#collector-tasks) task can > be used instead. > -{type="note"} +{style="note"} By default, you can find ready-to-use documentation under `{parentProject}/build/dokka/{format}MultiModule` directory. @@ -173,7 +173,7 @@ build that contains all declarations from the subprojects. > Use the `dokkaJavadocCollector` task if you need to create Javadoc documentation for your multi-project build. > -{type="tip"} +{style="tip"} #### Collector results @@ -210,12 +210,12 @@ However, you can [configure](#subproject-configuration) `Partial` tasks to custo > Output generated by `Partial` tasks contains unresolved HTML templates and references, so it cannot be used > on its own without post-processing done by the parent's [`MultiModule`](#multimodule-tasks) task. > -{type="warning"} +{style="warning"} > If you want to generate documentation for a single subproject only, use > [single-project tasks](#single-project-builds). For example, `:subprojectName:dokkaHtml`. > -{type="note"} +{style="note"} ## Build javadoc.jar @@ -271,7 +271,7 @@ tasks.register('dokkaJavadocJar', Jar.class) { > from the `javadoc.jar`. It works well with the HTML format as demonstrated in > [this example](https://javadoc.io/doc/com.trib3/server/latest/index.html). > -{type="tip"} +{style="tip"} ## Configuration examples @@ -763,7 +763,7 @@ tasks.withType(DokkaTask.class) {

    Whether to suppress obvious functions.

    - A function is considered to be obvious if it is: + A function is considered to be obvious if it is:

  • Inherited from kotlin.Any, Kotlin.Enum, java.lang.Object or @@ -774,7 +774,6 @@ tasks.withType(DokkaTask.class) { dataClass.componentN or dataClass.copy.
    • -

    Default: true

     @@ -1168,13 +1167,12 @@ tasks.withType(DokkaTask.class) { is #L10.

    - Suffixes used by popular services: + Suffixes used by popular services:

  • GitHub: #L
  • GitLab: #L
  • Bitbucket: #lines-
    •  -

    Default: #L

     diff --git a/docs/topics/runners/dokka-maven.md b/docs/topics/runners/dokka-maven.md index e7e502e557..3e8947e265 100644 --- a/docs/topics/runners/dokka-maven.md +++ b/docs/topics/runners/dokka-maven.md @@ -5,7 +5,7 @@ To generate documentation for a Maven-based project, you can use the Maven plugi > Compared to the [Gradle plugin for Dokka](dokka-gradle.md), the Maven plugin has only basic features and > does not provide support for multi-module builds. > -{type="note"} +{style="note"} You can play around with Dokka and see how it can be configured for a Maven project by visiting our [Maven example](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/examples/maven) project. @@ -133,7 +133,7 @@ mvn dokka:dokka jar:jar@dokka-jar > from the `javadoc.jar`. It works well with the HTML format as demonstrated in > [this example](https://javadoc.io/doc/com.trib3/server/latest/index.html). > -{type="tip"} +{style="tip"} ## Configuration example @@ -238,7 +238,7 @@ with [all configuration options](#complete-configuration) applied at the bottom

    Whether to suppress obvious functions.

    - A function is considered to be obvious if it is: + A function is considered to be obvious if it is:

  • Inherited from kotlin.Any, Kotlin.Enum, java.lang.Object or @@ -249,7 +249,6 @@ with [all configuration options](#complete-configuration) applied at the bottom dataClass.componentN or dataClass.copy.
    • -

    Default: true

     @@ -443,13 +442,12 @@ function in `kotlinx.coroutines`. to #L and the line number is 10, the resulting URL suffix is #L10.

    - Suffixes used by popular services: + Suffixes used by popular services:

  • GitHub: #L
  • GitLab: #L
  • Bitbucket: #lines-
    •  -

    diff --git a/docs/writerside.cfg b/docs/writerside.cfg new file mode 100644 index 0000000000..870d063eb3 --- /dev/null +++ b/docs/writerside.cfg @@ -0,0 +1,13 @@ + + + + + + + + + + + + +