From ea5ffe1766c395038e90c3e70158e4ea3fcc5572 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 23 Dec 2024 03:35:53 +0000
Subject: [PATCH] fix(deps): Bump org.jetbrains.dokka from 1.9.20 to 2.0.0
 (#249)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Bumps [org.jetbrains.dokka](https://github.com/Kotlin/dokka) from 1.9.20 to 2.0.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href="https://github.com/Kotlin/dokka/releases">org.jetbrains.dokka's releases</a>.</em></p>
<blockquote>
<h2>2.0.0</h2>
<p>Dokka 2.0.0 focuses on simplifying configuration and preparing for support of future Kotlin language features. Key highlights include:</p>
<ul>
<li><strong>Dokka Gradle Plugin v2</strong>: revamped Gradle plugin based on <a href="https://github.com/adamko-dev/dokkatoo">Dokkatoo</a>.</li>
<li><strong>Experimental K2 Analysis</strong>: support for K2 compiler frontend.</li>
<li><strong>HTML Improvements</strong>: better accessibility and easier customization.</li>
</ul>
<p>More details about each of the changes below. See <a href="https://github.com/Kotlin/dokka/milestone/31?closed=1">Dokka 2.0.0</a> milestone for the list of all changes.</p>
<h2>Dokka's Gradle plugin v2 based on <a href="https://github.com/adamko-dev/dokkatoo">Dokkatoo</a></h2>
<blockquote>
<p>Please check the <a href="https://kotl.in/dokka-gradle-migration">migration guide</a> for the update procedure and give feedback!</p>
</blockquote>
<p>Dokka 2.0.0 introduces significant improvements to Dokka Gradle plugin, aligning more closely with Gradle best practices:</p>
<ul>
<li>Adopts Gradle types, which leads to better performance.</li>
<li>Uses an intuitive top-level DSL configuration instead of a low-level task-based setup, which simplifies the build scripts and their readability.</li>
<li>Takes a more declarative approach to documentation aggregation, which makes multi-project documentation easier to manage.</li>
<li>Uses a type-safe plugin configuration, which improves the reliability and maintainability of your build scripts.</li>
<li>Fully supports Gradle <a href="https://docs.gradle.org/current/userguide/configuration_cache.html">configuration cache</a> and <a href="https://docs.gradle.org/current/userguide/build_cache.html">build cache</a>, which improves performance and simplifies build work.</li>
</ul>
<h3>Changes from Dokka 2.0.0-Beta</h3>
<ul>
<li>Forward Dokka Generator messages to Gradle logger (<a href="https://redirect.github.com/Kotlin/dokka/pull/3833">Kotlin/dokka#3833</a>)</li>
<li>Add deprecated property to help migrate from JSON Dokka plugin configuration (<a href="https://redirect.github.com/Kotlin/dokka/pull/3877">Kotlin/dokka#3877</a>)</li>
<li>Rename <code>dokkaPublicationDirectory</code> to <code>basePublicationsDirectory</code> (<a href="https://redirect.github.com/Kotlin/dokka/pull/3876">Kotlin/dokka#3876</a>)</li>
<li>Rename <code>dokkaModuleDirectory</code>, and mark as internal (<a href="https://redirect.github.com/Kotlin/dokka/pull/3880">Kotlin/dokka#3880</a>)</li>
<li>Update and add KDoc for DGPv2 (<a href="https://redirect.github.com/Kotlin/dokka/pull/3842">Kotlin/dokka#3842</a>)</li>
<li>Remove DokkaPluginParametersBuilder (<a href="https://redirect.github.com/Kotlin/dokka/pull/3872">Kotlin/dokka#3872</a>)</li>
<li>Increase default max heap of Worker to 2G (<a href="https://redirect.github.com/Kotlin/dokka/pull/3913">Kotlin/dokka#3913</a>)</li>
<li>Remove the dependency of <code>dokkaGenerate</code> on <code>dokkaGenerateModule*</code> (<a href="https://redirect.github.com/Kotlin/dokka/pull/3920">Kotlin/dokka#3920</a>)</li>
<li>KT-71784 Fix classpath for KMP shared source sets (<a href="https://redirect.github.com/Kotlin/dokka/pull/3942">Kotlin/dokka#3942</a>)</li>
<li>Fix DGP/KMP integration, so Dokka can 'see' code from shared source sets in target source sets (<a href="https://redirect.github.com/Kotlin/dokka/pull/3814">Kotlin/dokka#3814</a>)</li>
</ul>
<h2>Dokka's K2 analysis</h2>
<p>Dokka 2.0.0 introduces <strong>K2 analysis</strong>, which is currently in an experimental stage. Dokka's K2 analysis leverages Kotlin's K2 compiler frontend for analysing code and uses the same shared Analysis API, which is used in <a href="https://blog.jetbrains.com/idea/2024/11/k2-mode-becomes-stable/">IntelliJ IDEA’s K2 mode</a>. The output with K2 analysis should mostly match that of K1 analysis, but there may be minor differences. We are actively working towards stabilizing K2 analysis and are planning to enable K2 analysis by default in future.</p>
<p>To opt in to Dokka's K2 analysis, add the following flag to your project's <code>gradle.properties</code> file:</p>
<pre lang="properties"><code>org.jetbrains.dokka.experimental.tryK2=true
</code></pre>
<h3>Known limitations:</h3>
<ul>
<li>Intersecting source roots (<a href="https://redirect.github.com/Kotlin/dokka/issues/3701">#3701</a>) and intersecting sample roots (<a href="https://redirect.github.com/Kotlin/dokka/issues/3373">#3373</a>) may cause issues.</li>
<li>Kotlin/JS libraries compiled with the <a href="https://kotlinlang.org/docs/js-ir-compiler.html">legacy Kotlin/JS compiler</a> are not supported (<a href="https://redirect.github.com/Kotlin/dokka/issues/3751">#3751</a>).</li>
</ul>
<p>We would greatly value your feedback if you encounter any of these limitations.</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/Kotlin/dokka/commit/3be1aa663b503a749026704d263906b1d818340a"><code>3be1aa6</code></a> Update Kotlin/Dokka version references to 2.0.0 (<a href="https://redirect.github.com/Kotlin/dokka/issues/3957">#3957</a>)</li>
<li><a href="https://github.com/Kotlin/dokka/commit/47ee7fbcf5f68cbd80c056fcaa8ecdea4186d32a"><code>47ee7fb</code></a> Update the version to the 2.0.0 release</li>
<li><a href="https://github.com/Kotlin/dokka/commit/a2fe93492409054bdc754ef6b935f4e2f00ca4f1"><code>a2fe934</code></a> Avoid configuration resolution error for v2 migration helper task (<a href="https://redirect.github.com/Kotlin/dokka/issues/3950">#3950</a>)</li>
<li><a href="https://github.com/Kotlin/dokka/commit/a6e5b03817aec8971fd13c1c1723b65c05d5bdf1"><code>a6e5b03</code></a> Update DGPv2 examples to use Kotlin 2.1.0 (<a href="https://redirect.github.com/Kotlin/dokka/issues/3949">#3949</a>)</li>
<li><a href="https://github.com/Kotlin/dokka/commit/94eec025d88fddc63906cb1a24749f209e8003c9"><code>94eec02</code></a> Run integration tests with Kotlin 2.1.0 (<a href="https://redirect.github.com/Kotlin/dokka/issues/3865">#3865</a>)</li>
<li><a href="https://github.com/Kotlin/dokka/commit/2b6331438b46b142d524ceebc7054afe7555fb50"><code>2b63314</code></a> KT-71784 Fix classpath for KMP shared source sets (<a href="https://redirect.github.com/Kotlin/dokka/issues/3942">#3942</a>)</li>
<li><a href="https://github.com/Kotlin/dokka/commit/17871a02748760e173ead420ea75960693028c11"><code>17871a0</code></a> Add new tests for KDoc links (<a href="https://redirect.github.com/Kotlin/dokka/issues/3947">#3947</a>)</li>
<li><a href="https://github.com/Kotlin/dokka/commit/f728e3a8675041a2bd416d7fa1c21ad0a995c3ad"><code>f728e3a</code></a> feat: implemented new UI for Navbar and Table of Contents (<a href="https://redirect.github.com/Kotlin/dokka/issues/3917">#3917</a>)</li>
<li><a href="https://github.com/Kotlin/dokka/commit/9577dc75e4fdcc61e3c1f639ee45e8156380a0ef"><code>9577dc7</code></a> Edit some tests to check the stability of the order (<a href="https://redirect.github.com/Kotlin/dokka/issues/3943">#3943</a>)</li>
<li><a href="https://github.com/Kotlin/dokka/commit/ae68eee16bcd84c30329846ee4a00e18b05a1082"><code>ae68eee</code></a> Add a test for <a href="https://redirect.github.com/Kotlin/dokka/issues/3702">#3702</a> (<a href="https://redirect.github.com/Kotlin/dokka/issues/3941">#3941</a>)</li>
<li>Additional commits viewable in <a href="https://github.com/Kotlin/dokka/compare/v1.9.20...v2.0.0">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=org.jetbrains.dokka&package-manager=gradle&previous-version=1.9.20&new-version=2.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>
---
 build.gradle | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/build.gradle b/build.gradle
index dda4baa..8fe5e6f 100644
--- a/build.gradle
+++ b/build.gradle
@@ -12,7 +12,7 @@ buildscript{
 plugins {
   id("org.jetbrains.kotlin.jvm") version "2.0.21"
   id('java-library')
-  id("org.jetbrains.dokka") version "1.9.20"
+  id("org.jetbrains.dokka") version "2.0.0"
   id("org.jlleitschuh.gradle.ktlint") version "11.6.1"
   id('jacoco')
   id('idea')