Merge branch 'master' into feat/buildsrc_convention_plugins

# Conflicts:
#	build.gradle.kts
Merge pull request Kotlin#3582 from isaialvarado/patch-1

Fix example code
Converted Serialization formats list to table

PR Kotlin#2010
Updating docs after 7.0.0 release

CONTRIBUTING.md

@@ -23,9 +23,9 @@ Bug reports, feature requests and questions are welcome. Submit issues [here](ht
 
 ## Submitting PRs
 
-Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.7.20/developer_guide/introduction/) documentation
-which goes over the development [Workflow](https://kotlin.github.io/dokka/1.7.20/developer_guide/workflow/) and 
-[Dokka's architecture](https://kotlin.github.io/dokka/1.7.20/developer_guide/architecture/architecture_overview/),
+Dokka has extensive [Developer Guides](https://kotlin.github.io/dokka/1.8.10/developer_guide/introduction/) documentation
+which goes over the development [Workflow](https://kotlin.github.io/dokka/1.8.10/developer_guide/workflow/) and 
+[Dokka's architecture](https://kotlin.github.io/dokka/1.8.10/developer_guide/architecture/architecture_overview/),
 which can help you understand how to achieve what you want and where to look.
 
 All development (both new features and bugfixes) takes place in the `master` branch, it contains sources for the next
@@ -59,18 +59,18 @@ Unit tests which are run as part of `build` should not take much time, but you c
 ### Using/testing locally built Dokka
 
 Below you will find a bare-bones instruction on how to use and test locally built Dokka. For more details and examples, 
-visit [Workflow](https://kotlin.github.io/dokka/1.7.20/developer_guide/workflow/) topic.
+visit [Workflow](https://kotlin.github.io/dokka/1.8.10/developer_guide/workflow/) topic.
 
 1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version.
-   For instance, you can set it to something like `1.7.20-my-fix-SNAPSHOT`.
+   For instance, you can set it to something like `1.8.10-my-fix-SNAPSHOT`.
 2. Publish it to Maven Local (`./gradlew publishToMavenLocal`)
 3. In the project for which you want to generate documentation add Maven Local as a buildscript/dependency
    repository (`mavenLocal()`)
 4. Update your Dokka dependency to the version you've just published:
 
 ```kotlin
 plugins {
-    id("org.jetbrains.dokka") version "1.7.20-my-fix-SNAPSHOT"
+    id("org.jetbrains.dokka") version "1.8.10-my-fix-SNAPSHOT"
 }
 ```
 

README.md

@@ -39,7 +39,7 @@ Apply the Gradle plugin for Dokka in the root build script of your project:
 
 ```kotlin
 plugins {
-    id("org.jetbrains.dokka") version "1.7.20"
+    id("org.jetbrains.dokka") version "1.8.10"
 }
 ```
 
@@ -61,7 +61,7 @@ Apply Gradle plugin for Dokka in the root project:
 
 ```groovy
 plugins {
-    id 'org.jetbrains.dokka' version '1.7.20'
+    id 'org.jetbrains.dokka' version '1.8.10'
 }
 ```
 
@@ -95,7 +95,7 @@ Add the Dokka Maven plugin to the `plugins` section of your POM file:
         <plugin>
             <groupId>org.jetbrains.dokka</groupId>
             <artifactId>dokka-maven-plugin</artifactId>
-            <version>1.7.20</version>
+            <version>1.8.10</version>
             <executions>
                 <execution>
                     <phase>pre-site</phase>
@@ -134,7 +134,7 @@ Android platform:
 
 ```kotlin
 dependencies {
-    dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.7.20")
+    dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.8.10")
 }
 ```
 
@@ -145,7 +145,7 @@ dependencies {
 
 ```groovy
 dependencies {
-    dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.7.20'
+    dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.8.10'
 }
 ```
 
@@ -164,7 +164,7 @@ dependencies {
             <plugin>
                 <groupId>org.jetbrains.dokka</groupId>
                 <artifactId>android-documentation-plugin</artifactId>
-                <version>1.7.20</version>
+                <version>1.8.10</version>
             </plugin>
         </dokkaPlugins>
     </configuration>
@@ -211,7 +211,7 @@ implement plugins for missing or very specific features that are not provided ou
 Learn more about Dokka plugins and their configuration in [Dokka plugins](https://kotlinlang.org/docs/dokka-plugins.html).
 
 If you want to learn how to develop Dokka plugins, see
-[Developer guides](https://kotlin.github.io/dokka/1.7.20/developer_guide/introduction/).
+[Developer guides](https://kotlin.github.io/dokka/1.8.10/developer_guide/introduction/).
 
 ## Community
 

buildSrc/build.gradle.kts

@@ -27,6 +27,6 @@ dependencies {
     implementation("gradle.plugin.com.github.johnrengelman:shadow:7.1.2")
     implementation("org.jetbrains.kotlinx:binary-compatibility-validator:0.12.1")
     implementation("io.github.gradle-nexus:publish-plugin:1.1.0")
-    implementation("org.jetbrains.dokka:dokka-gradle-plugin:1.7.20")
+    implementation("org.jetbrains.dokka:dokka-gradle-plugin:1.8.10")
     implementation("com.gradle.publish:plugin-publish-plugin:0.20.0")
 }

core/src/main/kotlin/plugability/DokkaPlugin.kt

@@ -36,7 +36,7 @@ abstract class DokkaPlugin {
     /**
      * @see PluginApiPreviewAcknowledgement
      */
-    @DokkaPluginApiPreview
+    @OptIn(DokkaPluginApiPreview::class)
     protected abstract fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement
     protected inline fun <reified T : DokkaPlugin> plugin(): T = context?.plugin(T::class) ?: throwIllegalQuery()
 

docs/v.list

@@ -4,9 +4,9 @@
 
 <vars>
     <var name="dokkaVersion"
-         value="1.7.20"
+         value="1.8.10"
          type="string"/>
     <var name="kotlinVersion"
-         value="1.7.20"
+         value="1.8.10"
          type="string"/>
 </vars>

examples/gradle/dokka-customFormat-example/build.gradle.kts

@@ -4,12 +4,12 @@ import org.jetbrains.dokka.base.DokkaBaseConfiguration
 
 plugins {
     kotlin("jvm") version "1.8.10"
-    id("org.jetbrains.dokka") version ("1.7.20")
+    id("org.jetbrains.dokka") version ("1.8.10")
 }
 
 buildscript {
     dependencies {
-        classpath("org.jetbrains.dokka:dokka-base:1.7.20")
+        classpath("org.jetbrains.dokka:dokka-base:1.8.10")
     }
 }
 

examples/gradle/dokka-gradle-example/build.gradle.kts

@@ -3,7 +3,7 @@ import java.net.URL
 
 plugins {
     kotlin("jvm") version "1.8.10"
-    id("org.jetbrains.dokka") version ("1.7.20")
+    id("org.jetbrains.dokka") version ("1.8.10")
 }
 
 repositories {

examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
     kotlin("jvm") version "1.8.10"
-    id("org.jetbrains.dokka") version ("1.7.20")
+    id("org.jetbrains.dokka") version ("1.8.10")
 }
 
 repositories {
@@ -12,11 +12,11 @@ dependencies {
     testImplementation(kotlin("test-junit"))
 
     // Will apply the plugin to all Dokka tasks
-    dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
+    dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10")
 
     // Will apply the plugin only to the `:dokkaHtml` task
-    //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
+    //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10")
 
     // Will apply the plugin only to the `:dokkaGfm` task
-    //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
+    //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.8.10")
 }

examples/gradle/dokka-library-publishing-example/build.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
     kotlin("jvm") version "1.8.10"
-    id("org.jetbrains.dokka") version ("1.7.20")
+    id("org.jetbrains.dokka") version ("1.8.10")
     `java-library`
     `maven-publish`
 }

examples/gradle/dokka-multimodule-example/gradle.properties

@@ -1,2 +1,2 @@
 kotlinVersion=1.8.10
-dokkaVersion=1.7.20
+dokkaVersion=1.8.10

examples/gradle/dokka-multiplatform-example/build.gradle.kts

@@ -5,7 +5,7 @@ import org.jetbrains.dokka.Platform
 
 plugins {
     kotlin("multiplatform") version "1.8.10"
-    id("org.jetbrains.dokka") version "1.7.20"
+    id("org.jetbrains.dokka") version "1.8.10"
 }
 
 repositories {

examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
     kotlin("jvm") version "1.8.10"
-    id("org.jetbrains.dokka") version ("1.7.20") apply false
+    id("org.jetbrains.dokka") version ("1.8.10") apply false
 }
 
 // The versioning plugin must be applied in all submodules
@@ -14,6 +14,6 @@ subprojects {
     }
     val dokkaPlugin by configurations
     dependencies {
-        dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.20")
+        dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.8.10")
     }
 }

examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts

@@ -4,7 +4,7 @@ import org.jetbrains.dokka.versioning.VersioningConfiguration
 
 buildscript {
     dependencies {
-        classpath("org.jetbrains.dokka:versioning-plugin:1.7.20")
+        classpath("org.jetbrains.dokka:versioning-plugin:1.8.10")
     }
 
     repositories {

examples/maven/pom.xml

@@ -9,7 +9,7 @@
     <version>1.0-SNAPSHOT</version>
     <properties>
         <kotlin.version>1.8.10</kotlin.version>
-        <dokka.version>1.7.20</dokka.version>
+        <dokka.version>1.8.10</dokka.version>
     </properties>
 
     <dependencies>

examples/plugin/hide-internal-api/README.md

@@ -1,15 +1,15 @@
 # Hide Internal API plugin example
 
 This project represents a simple Dokka Plugin that was developed step-by-step in the
-[Sample plugin](https://kotlin.github.io/dokka/1.7.20/developer_guide/plugin-development/sample-plugin-tutorial/)
+[Sample plugin](https://kotlin.github.io/dokka/1.8.10/developer_guide/plugin-development/sample-plugin-tutorial/)
 tutorial. This is a frequent request with varying requirements.
 
 The plugin excludes any declaration that is marked with `org.jetbrains.dokka.internal.test.Internal` annotation.
 The annotation itself is not provided in this project and is instead matched by the fully qualified name only.
 You can change it to your own internal annotation or to some other marker that suits you.
 
 To learn how to install and debug it locally,
-[see documentation](https://kotlin.github.io/dokka/1.7.20/developer_guide/plugin-development/sample-plugin-tutorial/#debugging).
+[see documentation](https://kotlin.github.io/dokka/1.8.10/developer_guide/plugin-development/sample-plugin-tutorial/#debugging).
 
 ___
 

examples/plugin/hide-internal-api/build.gradle.kts

@@ -3,7 +3,7 @@ import java.net.URI
 
 plugins {
     kotlin("jvm") version "1.8.10"
-    id("org.jetbrains.dokka") version "1.7.20"
+    id("org.jetbrains.dokka") version "1.8.10"
     `maven-publish`
     signing
 }

examples/plugin/hide-internal-api/gradle.properties

@@ -1 +1 @@
-dokkaVersion=1.7.20
+dokkaVersion=1.8.10

integration-tests/gradle/projects/it-basic/build.gradle.kts

@@ -16,7 +16,7 @@ buildscript {
     }
 }
 
-version = "1.7.20-SNAPSHOT"
+version = "1.8.10-SNAPSHOT"
 
 apply(from = "../template.root.gradle.kts")
 

integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt

@@ -156,7 +156,7 @@ class BasicGradleIntegrationTest(override val versions: BuildVersions) : Abstrac
         val indexFile = File(this, "index.html")
         assertTrue(indexFile.isFile, "Missing index.html")
         assertTrue(
-            """<title>Basic Project 1.7.20-SNAPSHOT API </title>""" in indexFile.readText(),
+            """<title>Basic Project 1.8.10-SNAPSHOT API </title>""" in indexFile.readText(),
             "Header with version number not present in index.html"
         )
 

mkdocs/src/doc/docs/developer_guide/workflow.md

@@ -42,7 +42,7 @@ Having built Dokka locally, you can publish it to `mavenLocal()`. This will allo
 project as well as debug code remotely.
 
 1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version.
-   For instance, you can set it to something like `1.7.20-my-fix-SNAPSHOT`. This version will be propagated to plugins
+   For instance, you can set it to something like `1.8.10-my-fix-SNAPSHOT`. This version will be propagated to plugins
    that reside inside Dokka's project (such as `mathjax`, `kotlin-as-java`, etc).
 2. Publish it to maven local (`./gradlew publishToMavenLocal`). Corresponding artifacts should appear in `~/.m2`
 3. In the project you want to generate documentation for or debug on, add maven local as a plugin/dependency
@@ -55,7 +55,7 @@ repositories {
 4. Update your dokka dependency to the version you've just published:
 ```kotlin
 plugins {
-    id("org.jetbrains.dokka") version "1.7.20-my-fix-SNAPSHOT"
+    id("org.jetbrains.dokka") version "1.8.10-my-fix-SNAPSHOT"
 }
 ```