Skip to content

Commit cfa433f

Browse files
Update references and documentation to Dokka 1.7.10 (#2567)
1 parent 5633f27 commit cfa433f

File tree

18 files changed

+39
-39
lines changed

18 files changed

+39
-39
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ Here's how to import and configure Dokka in IntelliJ IDEA:
2929

3030
If you want to use/test your locally built Dokka in a project, do the following:
3131
1. Change `dokka_version` in `gradle.properties` to something that you will use later on as the dependency version.
32-
For instance, you can set it to something like `1.7.0-my-fix-SNAPSHOT`.
32+
For instance, you can set it to something like `1.7.10-my-fix-SNAPSHOT`.
3333
2. Publish it to maven local (`./gradlew publishToMavenLocal`)
3434
3. In the project you want to generate documentation for, add maven local as a plugin/dependency
3535
repository (`mavenLocal()`)
3636
4. Update your dokka dependency to the version you've just published:
3737
```kotlin
3838
plugins {
39-
id("org.jetbrains.dokka") version "1.7.0-my-fix-SNAPSHOT"
39+
id("org.jetbrains.dokka") version "1.7.10-my-fix-SNAPSHOT"
4040
}
4141
```

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ and can generate documentation in multiple formats including standard Javadoc, H
1111

1212
## Using Dokka
1313

14-
**Full documentation is available at [https://kotlin.github.io/dokka/1.7.0/](https://kotlin.github.io/dokka/1.7.0/)**
14+
**Full documentation is available at [https://kotlin.github.io/dokka/1.7.10/](https://kotlin.github.io/dokka/1.7.10/)**
1515

1616
### Using the Gradle plugin
1717
_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.
2222
build.gradle.kts:
2323
```kotlin
2424
plugins {
25-
id("org.jetbrains.dokka") version "1.7.0"
25+
id("org.jetbrains.dokka") version "1.7.10"
2626
}
2727

2828
repositories {
@@ -37,7 +37,7 @@ Dokka plugin creates Gradle configuration for each output format in the form of
3737

3838
```kotlin
3939
dependencies {
40-
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0")
40+
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
4141
}
4242
```
4343

@@ -46,7 +46,7 @@ You can also create a custom Dokka task and add plugins directly inside:
4646
```kotlin
4747
val customDokkaTask by creating(DokkaTask::class) {
4848
dependencies {
49-
plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0")
49+
plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
5050
}
5151
}
5252
```

docs/src/doc/docs/community/plugins-list.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ In order to add your plugin to this list it needs to be:
99

1010
| Plugin name | Description | Source |
1111
| :--------- | :--------- | :------------ |
12-
| [Kotlin as Java](https://kotlin.github.io/dokka/1.7.0/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java)
13-
| [GFM](https://kotlin.github.io/dokka/1.7.0/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm)
14-
| [Javadoc](https://kotlin.github.io/dokka/1.7.0/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc)
15-
| [Jekyll](https://kotlin.github.io/dokka/1.7.0/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll)
12+
| [Kotlin as Java](https://kotlin.github.io/dokka/1.7.10/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java)
13+
| [GFM](https://kotlin.github.io/dokka/1.7.10/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm)
14+
| [Javadoc](https://kotlin.github.io/dokka/1.7.10/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc)
15+
| [Jekyll](https://kotlin.github.io/dokka/1.7.10/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll)
1616
| [Mermaid-HTML](https://mermaid-js.github.io/mermaid/#/) | Renders Mermaid graphs for HTML renderer. | [Github](https://github.com/glureau/dokka-mermaid)
1717

1818

docs/src/doc/docs/user_guide/base-specific/frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Variables given below are available to the template:
9999
Also, Dokka-defined [directives](https://freemarker.apache.org/docs/ref_directive_userDefined.html) can be used:
100100
* `<@content/>` - main content
101101
* `<@resources/>` - scripts, stylesheets
102-
* `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.7.0/user_guide/versioning/versioning/) will replace this with a version navigator)
102+
* `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.7.10/user_guide/versioning/versioning/) will replace this with a version navigator)
103103
* `<@template_cmd name="...""> ...</@template_cmd>` - is used for variables that depend on the root project (such `pathToRoot`, `projectName`). They are available only inside the directive. This is processed by a multi-module task that assembles partial outputs from modules.
104104
Example:
105105
```

docs/src/doc/docs/user_guide/cli/usage.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ The content of JSON file ```dokkaConfiguration.json```:
9393
"sourceSetName": "main"
9494
},
9595
"classpath": [
96-
"libs/kotlin-stdlib-1.7.0.jar",
97-
"libs/kotlin-stdlib-common-1.7.0.jar"
96+
"libs/kotlin-stdlib-1.7.10.jar",
97+
"libs/kotlin-stdlib-common-1.7.10.jar"
9898
],
9999
"sourceRoots": [
100100
"/home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin"
@@ -135,11 +135,11 @@ The content of JSON file ```dokkaConfiguration.json```:
135135
}
136136
],
137137
"pluginsClasspath": [
138-
"plugins/dokka-base-1.7.0.jar",
138+
"plugins/dokka-base-1.7.10.jar",
139139
"libs/kotlinx-html-jvm-0.7.3.jar",
140-
"libs/dokka-analysis-1.7.0.jar",
141-
"libs/kotlin-analysis-intellij-1.7.0.jar",
142-
"libs/kotlin-analysis-compiler-1.7.0.jar"
140+
"libs/dokka-analysis-1.7.10.jar",
141+
"libs/kotlin-analysis-intellij-1.7.10.jar",
142+
"libs/kotlin-analysis-compiler-1.7.10.jar"
143143
],
144144
"pluginsConfiguration": [
145145
{

docs/src/doc/docs/user_guide/gradle/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The preferred way is to use `plugins` block.
1414
build.gradle.kts:
1515
```kotlin
1616
plugins {
17-
id("org.jetbrains.dokka") version "1.7.0"
17+
id("org.jetbrains.dokka") version "1.7.10"
1818
}
1919

2020
repositories {
@@ -269,7 +269,7 @@ Dokka plugin creates Gradle configuration for each output format in the form of
269269

270270
```kotlin
271271
dependencies {
272-
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0")
272+
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
273273
}
274274
```
275275

@@ -278,7 +278,7 @@ You can also create a custom Dokka task and add plugins directly inside:
278278
```kotlin
279279
val customDokkaTask by creating(DokkaTask::class) {
280280
dependencies {
281-
plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0")
281+
plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
282282
}
283283
}
284284
```
@@ -311,7 +311,7 @@ For example, you can add `DokkaBase` to gain access to aforementioned configurat
311311
buildscript {
312312
dependencies {
313313
// classpath("<plugin coordinates>:<plugin version>")
314-
classpath("org.jetbrains.dokka:dokka-base:1.7.0")
314+
classpath("org.jetbrains.dokka:dokka-base:1.7.10")
315315
}
316316
}
317317
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ import org.jetbrains.dokka.gradle.DokkaTask
22

33
plugins {
44
kotlin("jvm") version "1.7.10"
5-
id("org.jetbrains.dokka") version ("1.7.0")
5+
id("org.jetbrains.dokka") version ("1.7.10")
66
}
77

88
buildscript {
99
dependencies {
10-
classpath("org.jetbrains.dokka:dokka-base:1.7.0")
10+
classpath("org.jetbrains.dokka:dokka-base:1.7.10")
1111
}
1212
}
1313

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import java.net.URL
33

44
plugins {
55
kotlin("jvm") version "1.7.10"
6-
id("org.jetbrains.dokka") version ("1.7.0")
6+
id("org.jetbrains.dokka") version ("1.7.10")
77
}
88

99
repositories {
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
22
kotlin("jvm") version "1.7.10"
3-
id("org.jetbrains.dokka") version ("1.7.0")
3+
id("org.jetbrains.dokka") version ("1.7.10")
44
}
55

66
repositories {
@@ -12,11 +12,11 @@ dependencies {
1212
testImplementation(kotlin("test-junit"))
1313

1414
// Will apply the plugin to all dokka tasks
15-
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0")
15+
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
1616

1717
// Will apply the plugin only to the `:dokkaHtml` task
18-
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0")
18+
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
1919

2020
// Will apply the plugin only to the `:dokkaGfm` task
21-
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0")
21+
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
2222
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
22
kotlin("jvm") version "1.7.10"
3-
id("org.jetbrains.dokka") version ("1.7.0")
3+
id("org.jetbrains.dokka") version ("1.7.10")
44
`java-library`
55
`maven-publish`
66
}

0 commit comments

Comments
 (0)