Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update references and documentation to Dokka 1.7.10 #2567

Merged
merged 1 commit into from
Jul 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0-my-fix-SNAPSHOT`.
For instance, you can set it to something like `1.7.10-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.0-my-fix-SNAPSHOT"
id("org.jetbrains.dokka") version "1.7.10-my-fix-SNAPSHOT"
}
```
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0/](https://kotlin.github.io/dokka/1.7.0/)**
**Full documentation is available at [https://kotlin.github.io/dokka/1.7.10/](https://kotlin.github.io/dokka/1.7.10/)**

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

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

Expand All @@ -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.0")
plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
}
}
```
Expand Down
8 changes: 4 additions & 4 deletions docs/src/doc/docs/community/plugins-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 9,10 @@ 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.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)
| [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)
| [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)
| [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)
| [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)
| [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)
| [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)
| [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)
| [Mermaid-HTML](https://mermaid-js.github.io/mermaid/#/) | Renders Mermaid graphs for HTML renderer. | [Github](https://github.com/glureau/dokka-mermaid)


2 changes: 1 addition & 1 deletion docs/src/doc/docs/user_guide/base-specific/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 99,7 @@ Variables given below are available to the template:
Also, Dokka-defined [directives](https://freemarker.apache.org/docs/ref_directive_userDefined.html) can be used:
* `<@content/>` - main content
* `<@resources/>` - scripts, stylesheets
* `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.7.0/user_guide/versioning/versioning/) will replace this with a version navigator)
* `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.7.10/user_guide/versioning/versioning/) will replace this with a version navigator)
* `<@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.
Example:
```
Expand Down
12 changes: 6 additions & 6 deletions docs/src/doc/docs/user_guide/cli/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 93,8 @@ The content of JSON file ```dokkaConfiguration.json```:
"sourceSetName": "main"
},
"classpath": [
"libs/kotlin-stdlib-1.7.0.jar",
"libs/kotlin-stdlib-common-1.7.0.jar"
"libs/kotlin-stdlib-1.7.10.jar",
"libs/kotlin-stdlib-common-1.7.10.jar"
],
"sourceRoots": [
"/home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin"
Expand Down Expand Up @@ -135,11 135,11 @@ The content of JSON file ```dokkaConfiguration.json```:
}
],
"pluginsClasspath": [
"plugins/dokka-base-1.7.0.jar",
"plugins/dokka-base-1.7.10.jar",
"libs/kotlinx-html-jvm-0.7.3.jar",
"libs/dokka-analysis-1.7.0.jar",
"libs/kotlin-analysis-intellij-1.7.0.jar",
"libs/kotlin-analysis-compiler-1.7.0.jar"
"libs/dokka-analysis-1.7.10.jar",
"libs/kotlin-analysis-intellij-1.7.10.jar",
"libs/kotlin-analysis-compiler-1.7.10.jar"
],
"pluginsConfiguration": [
{
Expand Down
8 changes: 4 additions & 4 deletions docs/src/doc/docs/user_guide/gradle/usage.md
Original file line number Diff line number Diff line change
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.7.0"
id("org.jetbrains.dokka") version "1.7.10"
}

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

Expand All @@ -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.0")
plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
}
}
```
Expand Down Expand Up @@ -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.0")
classpath("org.jetbrains.dokka:dokka-base:1.7.10")
}
}
```
Expand Down
4 changes: 2 additions & 2 deletions examples/gradle/dokka-customFormat-example/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 2,12 @@ import org.jetbrains.dokka.gradle.DokkaTask

plugins {
kotlin("jvm") version "1.7.10"
id("org.jetbrains.dokka") version ("1.7.0")
id("org.jetbrains.dokka") version ("1.7.10")
}

buildscript {
dependencies {
classpath("org.jetbrains.dokka:dokka-base:1.7.0")
classpath("org.jetbrains.dokka:dokka-base:1.7.10")
}
}

Expand Down
2 changes: 1 addition & 1 deletion examples/gradle/dokka-gradle-example/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 3,7 @@ import java.net.URL

plugins {
kotlin("jvm") version "1.7.10"
id("org.jetbrains.dokka") version ("1.7.0")
id("org.jetbrains.dokka") version ("1.7.10")
}

repositories {
Expand Down
8 changes: 4 additions & 4 deletions examples/gradle/dokka-kotlinAsJava-example/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
plugins {
kotlin("jvm") version "1.7.10"
id("org.jetbrains.dokka") version ("1.7.0")
id("org.jetbrains.dokka") version ("1.7.10")
}

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.7.0")
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")

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

// Will apply the plugin only to the `:dokkaGfm` task
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.0")
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.10")
}
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
plugins {
kotlin("jvm") version "1.7.10"
id("org.jetbrains.dokka") version ("1.7.0")
id("org.jetbrains.dokka") version ("1.7.10")
`java-library`
`maven-publish`
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 1,7 @@
pluginManagement {
plugins {
kotlin("jvm") version "1.7.10"
id("org.jetbrains.dokka") version ("1.7.0")
id("org.jetbrains.dokka") version ("1.7.10")
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 5,7 @@ import org.jetbrains.dokka.Platform

plugins {
kotlin("multiplatform") version "1.7.10"
id("org.jetbrains.dokka") version "1.7.0"
id("org.jetbrains.dokka") version "1.7.10"
}

repositories {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
plugins {
kotlin("jvm") version "1.7.10"
id("org.jetbrains.dokka") version ("1.7.0") apply false
id("org.jetbrains.dokka") version ("1.7.10") apply false
}

// The versioning plugin should be applied in all submodules
Expand All @@ -14,6 14,6 @@ subprojects {
}
val dokkaPlugin by configurations
dependencies {
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.0")
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.10")
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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.0")
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.0")
dokkaPlugin("org.jetbrains.dokka:all-modules-page-plugin:1.7.10")
dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.10")
}
val configuredVersion = "0.9"
outputDirectory.set(file(projectDir.toPath().resolve(olderVersionsFolder).resolve(configuredVersion)))
Expand Down
2 changes: 1 addition & 1 deletion examples/maven/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 9,7 @@
<version>1.0-SNAPSHOT</version>
<properties>
<kotlin.version>1.7.10</kotlin.version>
<dokka.version>1.7.0</dokka.version>
<dokka.version>1.7.10</dokka.version>
</properties>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,5 1,5 @@
# Project Settings
dokka_version=1.7.10-SNAPSHOT
dokka_version=1.7.10
dokka_integration_test_parallelism=2
# Versions
kotlin_version=1.7.10
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 16,7 @@ buildscript {
}
}

version = "1.7.0-SNAPSHOT"
version = "1.7.10-SNAPSHOT"

apply(from = "../template.root.gradle.kts")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.0-SNAPSHOT API </title>""" in indexFile.readText(),
"""<title>Basic Project 1.7.10-SNAPSHOT API </title>""" in indexFile.readText(),
"Header with version number not present in index.html"
)

Expand Down