Skip to content

Commit

Permalink
Update README, docs and examples to 1.6 (#2237)
Browse files Browse the repository at this point in the history
  • Loading branch information
@vmishenev
vmishenev committed Nov 23, 2021
1 parent af81f9d commit 8d151d1
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 28 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Expand Up @@ -7,7 +7,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.5.30/](https://kotlin.github.io/dokka/1.5.30/)**
**Full documentation is available at [https://kotlin.github.io/dokka/1.6.0/](https://kotlin.github.io/dokka/1.6.0/)**

### 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
Expand All @@ -18,7 +18,7 @@ The preferred way is to use `plugins` block.
build.gradle.kts:
```kotlin
plugins {
id("org.jetbrains.dokka") version "1.5.30"
id("org.jetbrains.dokka") version "1.6.0"
}

repositories {
Expand All @@ -33,7 +33,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.5.30")
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")
}
```

Expand All @@ -42,7 +42,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.5.30")
plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")
}
}
```
Expand Down
8 changes: 4 additions & 4 deletions docs/src/doc/docs/community/plugins-list.md
View file
Expand Up @@ -9,7 +9,7 @@ In order to add your plugin to this list it needs to be:

| Plugin name | Description | Source |
| :--------- | :--------- | :------------ |
| [Kotlin as Java](https://kotlin.github.io/dokka/1.5.30/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java)
| [GFM](https://kotlin.github.io/dokka/1.5.30/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm)
| [Javadoc](https://kotlin.github.io/dokka/1.5.30/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc)
| [Jekyll](https://kotlin.github.io/dokka/1.5.30/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll)
| [Kotlin as Java](https://kotlin.github.io/dokka/1.6.0/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java)
| [GFM](https://kotlin.github.io/dokka/1.6.0/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm)
| [Javadoc](https://kotlin.github.io/dokka/1.6.0/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc)
| [Jekyll](https://kotlin.github.io/dokka/1.6.0/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll)
8 changes: 4 additions & 4 deletions docs/src/doc/docs/user_guide/gradle/usage.md
View file
Expand Up @@ -14,7 +14,7 @@ The preferred way is to use `plugins` block.
build.gradle.kts:
```kotlin
plugins {
id("org.jetbrains.dokka") version "1.5.30"
id("org.jetbrains.dokka") version "1.6.0"
}

repositories {
Expand Down Expand Up @@ -237,7 +237,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.5.30")
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")
}
```

Expand All @@ -246,7 +246,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.5.30")
plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")
}
}
```
Expand Down Expand Up @@ -279,7 +279,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.5.30")
classpath("org.jetbrains.dokka:dokka-base:1.6.0")
}
}
```
Expand Down
6 changes: 3 additions & 3 deletions examples/gradle/dokka-customFormat-example/build.gradle.kts
View file
@@ -1,13 +1,13 @@
import org.jetbrains.dokka.gradle.DokkaTask

plugins {
kotlin("jvm") version "1.5.30"
id("org.jetbrains.dokka") version ("1.5.30")
kotlin("jvm") version "1.6.0"
id("org.jetbrains.dokka") version ("1.6.0")
}

buildscript {
dependencies {
classpath("org.jetbrains.dokka:dokka-base:1.5.30")
classpath("org.jetbrains.dokka:dokka-base:1.6.0")
}
}

Expand Down
4 changes: 2 additions & 2 deletions examples/gradle/dokka-gradle-example/build.gradle.kts
View file
Expand Up @@ -2,8 +2,8 @@ import org.jetbrains.dokka.gradle.DokkaTask
import java.net.URL

plugins {
kotlin("jvm") version "1.5.30"
id("org.jetbrains.dokka") version ("1.5.30")
kotlin("jvm") version "1.6.0"
id("org.jetbrains.dokka") version ("1.6.0")
}

repositories {
Expand Down
10 changes: 5 additions & 5 deletions examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts
View file
@@ -1,6 +1,6 @@
plugins {
kotlin("jvm") version "1.5.30"
id("org.jetbrains.dokka") version ("1.5.30")
kotlin("jvm") version "1.6.0"
id("org.jetbrains.dokka") version ("1.6.0")
}

repositories {
Expand All @@ -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.5.30")
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")

// Will apply the plugin only to the `:dokkaHtml` task
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.5.30")
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")

// Will apply the plugin only to the `:dokkaGfm` task
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.5.30")
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")
}
4 changes: 2 additions & 2 deletions examples/gradle/dokka-library-publishing-example/build.gradle.kts
View file
@@ -1,6 +1,6 @@
plugins {
kotlin("jvm") version "1.5.30"
id("org.jetbrains.dokka") version ("1.5.30")
kotlin("jvm") version "1.6.0"
id("org.jetbrains.dokka") version ("1.6.0")
`java-library`
`maven-publish`
}
Expand Down
4 changes: 2 additions & 2 deletions examples/gradle/dokka-multiplatform-example/build.gradle.kts
View file
Expand Up @@ -4,8 +4,8 @@ import org.jetbrains.dokka.gradle.DokkaTask
import org.jetbrains.dokka.Platform

plugins {
kotlin("multiplatform") version "1.5.30"
id("org.jetbrains.dokka") version "1.5.30"
kotlin("multiplatform") version "1.6.0"
id("org.jetbrains.dokka") version "1.6.0"
}

repositories {
Expand Down
4 changes: 2 additions & 2 deletions examples/maven/pom.xml
View file
Expand Up @@ -8,8 +8,8 @@
<artifactId>kotlin-maven-example</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<kotlin.version>1.4.32</kotlin.version>
<dokka.version>1.4.32</dokka.version>
<kotlin.version>1.6.0</kotlin.version>
<dokka.version>1.6.0</dokka.version>
</properties>

<dependencies>
Expand Down

0 comments on commit 8d151d1

Please sign in to comment.