aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2022-10-12 15:10:34 +0200
committerGitHub <noreply@github.com>2022-10-12 15:10:34 +0200
commit25bc442c783bb94899bb02de0f01af092f82ae81 (patch)
treef1daafe8723caf74fa70d3fe4568c4ebddbccd69
parent83174361becb2af227159834cdf6e14db9300c53 (diff)
downloaddokka-25bc442c783bb94899bb02de0f01af092f82ae81.tar.gz
dokka-25bc442c783bb94899bb02de0f01af092f82ae81.tar.bz2
dokka-25bc442c783bb94899bb02de0f01af092f82ae81.zip
Update documentation and examples for 1.7.20 (#2697)
-rw-r--r--CONTRIBUTING.md4
-rw-r--r--README.md8
-rw-r--r--build.gradle.kts2
-rw-r--r--docs/src/doc/docs/community/plugins-list.md2
-rw-r--r--docs/src/doc/docs/developer_guide/workflow.md4
-rw-r--r--docs/src/doc/docs/user_guide/applying/cli.md12
-rw-r--r--docs/src/doc/docs/user_guide/applying/gradle.md8
-rw-r--r--examples/gradle/dokka-customFormat-example/build.gradle.kts4
-rw-r--r--examples/gradle/dokka-gradle-example/build.gradle.kts2
-rw-r--r--examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts8
-rw-r--r--examples/gradle/dokka-library-publishing-example/build.gradle.kts2
-rw-r--r--examples/gradle/dokka-multimodule-example/settings.gradle.kts2
-rw-r--r--examples/gradle/dokka-multiplatform-example/build.gradle.kts2
-rw-r--r--examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts4
-rw-r--r--examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts4
-rw-r--r--examples/maven/pom.xml2
-rw-r--r--examples/plugin/hide-internal-api/build.gradle.kts2
-rw-r--r--examples/plugin/hide-internal-api/gradle.properties2
18 files changed, 37 insertions, 37 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 55c6c020..92bc9105 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -29,13 +29,13 @@ Here's how to import and configure Dokka in IntelliJ IDEA:
If you want to use/test your locally built Dokka in a project, do the following:
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.10-my-fix-SNAPSHOT`.
+ For instance, you can set it to something like `1.7.20-my-fix-SNAPSHOT`.
2. Publish it to maven local (`./gradlew publishToMavenLocal`)
3. In the project you want to generate documentation for, add maven local as a plugin/dependency
repository (`mavenLocal()`)
4. Update your dokka dependency to the version you've just published:
```kotlin
plugins {
- id("org.jetbrains.dokka") version "1.7.10-my-fix-SNAPSHOT"
+ id("org.jetbrains.dokka") version "1.7.20-my-fix-SNAPSHOT"
}
```
diff --git a/README.md b/README.md
index 45818ffb..9743d2f4 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ and can generate documentation in multiple formats including standard Javadoc, H
## Using Dokka
-**Full documentation is available at [https://kotlin.github.io/dokka/1.7.10/](https://kotlin.github.io/dokka/1.7.10/)**
+**Full documentation is available at [https://kotlin.github.io/dokka/1.7.20/](https://kotlin.github.io/dokka/1.7.20/)**
### Using the Gradle plugin
_Note: If you are upgrading from 0.10.x to a current release of Dokka, please have a look at our
@@ -22,7 +22,7 @@ The preferred way is to use `plugins` block.
build.gradle.kts:
```kotlin
plugins {
- id("org.jetbrains.dokka") version "1.7.10"
+ id("org.jetbrains.dokka") version "1.7.20"
}
repositories {
@@ -37,7 +37,7 @@ Dokka plugin creates Gradle configuration for each output format in the form of
```kotlin
dependencies {
- dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
+ dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
```
@@ -46,7 +46,7 @@ You can also create a custom Dokka task and add plugins directly inside:
```kotlin
val customDokkaTask by creating(DokkaTask::class) {
dependencies {
- plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
+ plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
}
```
diff --git a/build.gradle.kts b/build.gradle.kts
index 33afe078..ecc30dea 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -4,7 +4,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
plugins {
kotlin("jvm") apply false
id("java")
- id("org.jetbrains.dokka") version "1.7.10"
+ id("org.jetbrains.dokka") version "1.7.20"
id("io.github.gradle-nexus.publish-plugin")
}
diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md
index e43dcbf3..6ae8ce4c 100644
--- a/docs/src/doc/docs/community/plugins-list.md
+++ b/docs/src/doc/docs/community/plugins-list.md
@@ -155,6 +155,6 @@ For instance, `fun foo(bar: Bar): Baz` will be rendered as `public final Baz foo
`Kotlin as Java` plugin is published to maven central as a
[separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-as-java-plugin):
-`org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10`.
+`org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20`.
[Plugin source code on GitHub](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java)
diff --git a/docs/src/doc/docs/developer_guide/workflow.md b/docs/src/doc/docs/developer_guide/workflow.md
index d3805cbc..ddf37459 100644
--- a/docs/src/doc/docs/developer_guide/workflow.md
+++ b/docs/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.10-my-fix-SNAPSHOT`. This version will be propagated to plugins
+ For instance, you can set it to something like `1.7.20-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.10-my-fix-SNAPSHOT"
+ id("org.jetbrains.dokka") version "1.7.20-my-fix-SNAPSHOT"
}
```
diff --git a/docs/src/doc/docs/user_guide/applying/cli.md b/docs/src/doc/docs/user_guide/applying/cli.md
index b0bac3fb..3b02add2 100644
--- a/docs/src/doc/docs/user_guide/applying/cli.md
+++ b/docs/src/doc/docs/user_guide/applying/cli.md
@@ -93,8 +93,8 @@ The content of JSON file ```dokkaConfiguration.json```:
"sourceSetName": "main"
},
"classpath": [
- "libs/kotlin-stdlib-1.7.10.jar",
- "libs/kotlin-stdlib-common-1.7.10.jar"
+ "libs/kotlin-stdlib-1.7.20.jar",
+ "libs/kotlin-stdlib-common-1.7.20.jar"
],
"sourceRoots": [
"/home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin"
@@ -135,11 +135,11 @@ The content of JSON file ```dokkaConfiguration.json```:
}
],
"pluginsClasspath": [
- "plugins/dokka-base-1.7.10.jar",
+ "plugins/dokka-base-1.7.20.jar",
"libs/kotlinx-html-jvm-0.7.3.jar",
- "libs/dokka-analysis-1.7.10.jar",
- "libs/kotlin-analysis-intellij-1.7.10.jar",
- "libs/kotlin-analysis-compiler-1.7.10.jar"
+ "libs/dokka-analysis-1.7.20.jar",
+ "libs/kotlin-analysis-intellij-1.7.20.jar",
+ "libs/kotlin-analysis-compiler-1.7.20.jar"
],
"pluginsConfiguration": [
{
diff --git a/docs/src/doc/docs/user_guide/applying/gradle.md b/docs/src/doc/docs/user_guide/applying/gradle.md
index 0ab1ff8a..30d23346 100644
--- a/docs/src/doc/docs/user_guide/applying/gradle.md
+++ b/docs/src/doc/docs/user_guide/applying/gradle.md
@@ -14,7 +14,7 @@ The preferred way is to use `plugins` block.
build.gradle.kts:
```kotlin
plugins {
- id("org.jetbrains.dokka") version "1.7.10"
+ id("org.jetbrains.dokka") version "1.7.20"
}
repositories {
@@ -269,7 +269,7 @@ Dokka plugin creates Gradle configuration for each output format in the form of
```kotlin
dependencies {
- dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
+ dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
```
@@ -278,7 +278,7 @@ You can also create a custom Dokka task and add plugins directly inside:
```kotlin
val customDokkaTask by creating(DokkaTask::class) {
dependencies {
- plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
+ plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
}
```
@@ -311,7 +311,7 @@ For example, you can add `DokkaBase` to gain access to aforementioned configurat
buildscript {
dependencies {
// classpath("<plugin coordinates>:<plugin version>")
- classpath("org.jetbrains.dokka:dokka-base:1.7.10")
+ classpath("org.jetbrains.dokka:dokka-base:1.7.20")
}
}
```
diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts
index bea4161a..8d1d36ce 100644
--- a/examples/gradle/dokka-customFormat-example/build.gradle.kts
+++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts
@@ -2,12 +2,12 @@ import org.jetbrains.dokka.gradle.DokkaTask
plugins {
kotlin("jvm") version "1.7.20"
- id("org.jetbrains.dokka") version ("1.7.10")
+ id("org.jetbrains.dokka") version ("1.7.20")
}
buildscript {
dependencies {
- classpath("org.jetbrains.dokka:dokka-base:1.7.10")
+ classpath("org.jetbrains.dokka:dokka-base:1.7.20")
}
}
diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts
index d15b0331..ac62fccd 100644
--- a/examples/gradle/dokka-gradle-example/build.gradle.kts
+++ b/examples/gradle/dokka-gradle-example/build.gradle.kts
@@ -3,7 +3,7 @@ import java.net.URL
plugins {
kotlin("jvm") version "1.7.20"
- id("org.jetbrains.dokka") version ("1.7.10")
+ id("org.jetbrains.dokka") version ("1.7.20")
}
repositories {
diff --git a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts
index febd2819..8150fdd1 100644
--- a/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts
+++ b/examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts
@@ -1,6 +1,6 @@
plugins {
kotlin("jvm") version "1.7.20"
- id("org.jetbrains.dokka") version ("1.7.10")
+ id("org.jetbrains.dokka") version ("1.7.20")
}
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.10")
+ dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
// Will apply the plugin only to the `:dokkaHtml` task
- //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
+ //dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
// Will apply the plugin only to the `:dokkaGfm` task
- //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
+ //dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
diff --git a/examples/gradle/dokka-library-publishing-example/build.gradle.kts b/examples/gradle/dokka-library-publishing-example/build.gradle.kts
index ab8a8249..153276b6 100644
--- a/examples/gradle/dokka-library-publishing-example/build.gradle.kts
+++ b/examples/gradle/dokka-library-publishing-example/build.gradle.kts
@@ -1,6 +1,6 @@
plugins {
kotlin("jvm") version "1.7.20"
- id("org.jetbrains.dokka") version ("1.7.10")
+ id("org.jetbrains.dokka") version ("1.7.20")
`java-library`
`maven-publish`
}
diff --git a/examples/gradle/dokka-multimodule-example/settings.gradle.kts b/examples/gradle/dokka-multimodule-example/settings.gradle.kts
index 0631e30f..ef724ba5 100644
--- a/examples/gradle/dokka-multimodule-example/settings.gradle.kts
+++ b/examples/gradle/dokka-multimodule-example/settings.gradle.kts
@@ -1,7 +1,7 @@
pluginManagement {
plugins {
kotlin("jvm") version "1.7.20"
- id("org.jetbrains.dokka") version ("1.7.10")
+ id("org.jetbrains.dokka") version ("1.7.20")
}
}
diff --git a/examples/gradle/dokka-multiplatform-example/build.gradle.kts b/examples/gradle/dokka-multiplatform-example/build.gradle.kts
index e2b7c4f3..c444bba0 100644
--- a/examples/gradle/dokka-multiplatform-example/build.gradle.kts
+++ b/examples/gradle/dokka-multiplatform-example/build.gradle.kts
@@ -5,7 +5,7 @@ import org.jetbrains.dokka.Platform
plugins {
kotlin("multiplatform") version "1.7.20"
- id("org.jetbrains.dokka") version "1.7.10"
+ id("org.jetbrains.dokka") version "1.7.20"
}
repositories {
diff --git a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts
index 4b874373..96a7280c 100644
--- a/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts
+++ b/examples/gradle/dokka-versioning-multimodule-example/build.gradle.kts
@@ -1,6 +1,6 @@
plugins {
kotlin("jvm") version "1.7.20"
- id("org.jetbrains.dokka") version ("1.7.10") apply false
+ id("org.jetbrains.dokka") version ("1.7.20") apply false
}
// The versioning plugin should be applied in all submodules
@@ -14,6 +14,6 @@ subprojects {
}
val dokkaPlugin by configurations
dependencies {
- dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.10")
+ dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.20")
}
}
diff --git a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts
index afbc6675..dc909192 100644
--- a/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts
+++ b/examples/gradle/dokka-versioning-multimodule-example/parentProject/build.gradle.kts
@@ -9,8 +9,8 @@ val olderVersionsFolder = "olderVersions"
// The previously documentations should be generated with the versioning plugin
val generatePreviouslyDocTask by tasks.register<DokkaMultiModuleTask>("dokkaPreviouslyDocumentation") {
dependencies {
- dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.7.10")
- dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.10")
+ dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.7.20")
+ dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.20")
}
val configuredVersion = "0.9"
outputDirectory.set(file(projectDir.resolve(olderVersionsFolder).resolve(configuredVersion)))
diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml
index da575d5a..40525fdb 100644
--- a/examples/maven/pom.xml
+++ b/examples/maven/pom.xml
@@ -9,7 +9,7 @@
<version>1.0-SNAPSHOT</version>
<properties>
<kotlin.version>1.7.20</kotlin.version>
- <dokka.version>1.7.10</dokka.version>
+ <dokka.version>1.7.20</dokka.version>
</properties>
<dependencies>
diff --git a/examples/plugin/hide-internal-api/build.gradle.kts b/examples/plugin/hide-internal-api/build.gradle.kts
index bc1ad925..a6dec0e0 100644
--- a/examples/plugin/hide-internal-api/build.gradle.kts
+++ b/examples/plugin/hide-internal-api/build.gradle.kts
@@ -3,7 +3,7 @@ import java.net.URI
plugins {
kotlin("jvm") version "1.7.20"
- id("org.jetbrains.dokka") version "1.7.10"
+ id("org.jetbrains.dokka") version "1.7.20"
`maven-publish`
signing
}
diff --git a/examples/plugin/hide-internal-api/gradle.properties b/examples/plugin/hide-internal-api/gradle.properties
index ec07d5fc..1dce61d6 100644
--- a/examples/plugin/hide-internal-api/gradle.properties
+++ b/examples/plugin/hide-internal-api/gradle.properties
@@ -1 +1 @@
-dokkaVersion=1.7.10
+dokkaVersion=1.7.20