Update plugin org.jetbrains.dokka to v2.2.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
org.jetbrains.dokka	2.0.0 → 2.2.0

---

Release Notes

Kotlin/dokka (org.jetbrains.dokka)

v2.2.0: 2.2.0

Dokka Gradle Plugin

Starting from Dokka 2.1.0, the new Dokka Gradle Plugin is enabled by default. The documentation on kotlinlang.org has been updated accordingly:

• See Get started with Dokka for instructions on adding Dokka to a project
• See Migrate to Dokka Gradle plugin v2 for migrating from the old plugin

Dokka 2.2.0 introduces multiple improvements and fixes:

Note: most of the following changes affect only the new Dokka Gradle Plugin, enabled by default since Dokka 2.1.0

• Compatibility with Android Gradle Plugin 9.0.0, including Built-in Kotlin. (#​4231, #​4295, #​4412)
  • See #​4472 on documenting Android projects with flavors / multiple variants
• Android Gradle Library Plugin for KMP is now properly supported. (#​4359, #​4366)
• Support the new Kotlin Gradle Plugin API to work with generated sources (#​4402, #​4410)
• Fix suppressGeneratedFiles flag was unused (#​4348)
• Improve classpath resolution and platform detection logic (#​4296, #​4263, #​4258)
• Add olderVersionsDirName to DokkaVersioningPluginParameters (#​4301). Thanks to @​osipxd!
• Rework the Gradle attributes to make them integrate better with the ecosystem (#​4334). Thanks to @​martinbonnin!
• Drop usages of APIs deprecated in KGP (#​4271)
  • this change makes deprecated DGPv1 be compatible with KGP 1.9.0+, aligning it with DGPv2

Analysis improvements

Starting from Dokka 2.1.0, the K2 analysis is enabled by default. K2 analysis is now stable, enabled by default, and fully migrated to the new shared Analysis API. This includes the migration to the new KDoc resolution API within the Analysis API.

Dokka 2.2.0 introduces multiple improvements and fixes:

Note: most of the following changes affect only Dokka's K2 analysis, enabled by default since Dokka 2.1.0

• Allow actual declarations to automatically inherit their documentation from expect counterparts in multiplatform projects (#​2493, #​4245, #​4351)
• Link resolution improvements:
  • Support references to declarations with quoted names (#​3356)
  • Support resolution of links to extensions with type parameters according to KEEP#385 (#​3555)
  • Improve handling of ambiguous KDoc links according to KEEP#389 (#​3451, #​3179, #​3632, #​4327, #​3604)
    • Note: those changes are currently available only under experimental org.jetbrains.dokka.analysis.enableExperimentalKDocResolution system property
• K2/K1 compatibility improvements:
  • Fix Multiple pages associated with key (#​4300)
  • Fix inconsistent constructor rendering for expect/actual annotation (#​4055)
  • Fix missing abstract modifier for abstract interface method with redundant open modifier (#​4144)
  • Fix working with intersected and overridden fake functions/properties (#​3857)
  • Fix rendering of links in @see block (#​3680)
  • Fix redundant ? on properties with a type of typealias to nullable type (#​4337)
  • Fix the missing default parameter value for inherited (not overridden) members (#​4320)
  • Fix duplicate source links for function overloads and properties (#​4049, #​4338)
  • Fix resolution of links in the second line of KDoc tags (#​4332, KT-75215, KT-79783)
• Improve DRI handling for varargs and properties (#​3558, #​4347)
• Context parameters improvements:
  • Fix KDoc links to context parameters (#​4389)
  • Support context parameters documentation via @param tag (#​4065)
• Java/Javadoc related improvements:
  • Use language-java class for <pre> and <code> tags generated from Java sources (#​4346)
  • Add new Mark DocTag, TextStyle.Highlight and support for <mark> javadoc HTML tag (#​4376)
  • Fix source links to accessors in the KotlinAsJava plugin (#​4396)
  • Fix incorrect links to Javadoc's functions with type parameters (#​3502)
  • Fix links to Java fields (#​4360)
  • Fix documentation on extension properties is not propagated to the generated extension getters (#​3752)
  • Fix generated getter for property in kotlin-as-java doesn't inherit KDoc description (#​3369)

Kotlin playground runnable samples extracted into a separate plugin

Starting with Dokka 2.2.0, Kotlin Playground–based rendering of @sample KDoc references is disabled by default. Samples are now rendered as non-runnable code blocks.

Support for interactive, runnable samples has been extracted into a separate plugin with configurable options, including custom Playground scripts and server URLs. See the plugin README.md for setup instructions.

Other changes and bugfixes

• Fix unnecessary logging for unresolved links in module documentation (#​4413)
• Fix CLI runner to force use of the latest stdlib (#​4324)
• Use the shadowed stdlib in the Dokka Maven Plugin (#​4229)

Changes from 2.2.0-Beta

• Fix DGP reads all Gradle properties, which causes unnecessary CC invalidation (#​4467)
• Detect and handle intersected source roots in Android multi-variant projects (#​4473)

Feedback

We would appreciate your feedback!

• Please report any feedback or problems https://kotl.in/dokka-issues
• Chat with the community visit #dokka in https://kotlinlang.slack.com/ (To sign up visit https://kotl.in/slack)

v2.1.0: 2.1.0

Dokka 2.1.0 focuses on stabilizing experimental features, supporting new Kotlin language features, and improving the user experience. Key highlights include:

• Dokka Gradle Plugin v2 is enabled by default!
• K2 Analysis is enabled by default!
• Support for Context parameters and Nested typealiases
• HTML format refinement: better accessibility and consistency across all components
• Multiple performance and compatibility improvements

More details about each of the changes below. See Dokka 2.1.0 milestone for the list of all changes.

Dokka's Gradle plugin v2 is enabled by default!

Please check the migration guide for the update procedure

Dokka 2.0.0 introduced a significantly improved Gradle plugin v2, and with Dokka 2.1.0 it is now enabled by default!
As a result, all types and Gradle tasks related to Dokka Gradle plugin v1 are deprecated and will be removed in future releases.
Running Gradle tasks related to Dokka Gradle plugin v1 will result in an error during execution.

Starting from this release, the minimum supported Gradle version is 7.6.3.

Other fixes and improvements

• Update Gradle Properties types to be non-nullable (#​4136)
• Update displayName convention for DokkaSourceSets (#​4142)
• Update olderVersionsDir to be an optional input. (#​4155)
• Add lifecycle tasks for generating formats (#​4141)
• Use project name as default modulePath for root project to avoid clashing outputs during aggregation (#​4158)
• Remove Dokka debug config file from task outputs (#​3961)
• Remove V2EnabledWithHelpers warning & info message (#​4206)

Dokka's K2 analysis is enabled by default!

Dokka 2.1.0fixes the most problematic issues with K2 analysis and makes it enabled by default!
In addition to this, Dokka 2.1.0with K2 analysis introduces support for context parameters and nested typealiases!

Dokka's K2 analysis leverages Kotlin's K2 compiler frontend for analysing code and uses the same shared Analysis API, which is used in IntelliJ IDEA’s K2 mode.
The output with K2 analysis should mostly match that of K1 analysis, but there may be minor differences.

If you previously opted in to Dokka's K2 analysis, remove org.jetbrains.dokka.experimental.tryK2 from your project's gradle.properties file.
Dokka's K1 analysis is still available, but it is deprecated and will be removed in future releases.
We would greatly appreciate your feedback, if there is something that is blocking you from migrating to K2 analysis!

Other fixes and improvements

• Fix merging of implicit expect/actual with a single declaration (#​4016)
• Support Wasm platform fully (#​4123)
• Fix override modifier for generic functions (#​4126)
• Add a receiver to accessor DRI (#​4122)
• Fix param tag for type parameter on implicit primary constructor (#​4154)
• Fix the primary constructor parameter incorrectly marked as a property (#​4125)
• Fix Javadoc links with generic parameters (#​4159)
• Show the correct return type when narrowed by inheritance (#​4183)

HTML format refinement

Dokka 2.1.0 introduces a number of design improvements to the HTML output.
Many UI elements (listed below) now feature more consistent spacing, better contrast, and improved overall accessibility.

Highlights:

• Improved accessibility of the Search popup and Table of Contents and Tabs
• Resizable Table of Contents
• Customizable spacing in the Table of Contents via a new set of CSS variables (See #​4184 for details)

In addition, the structure of the templates has been slightly modified. If you're using custom templates, the easiest way to migrate is to update your templates based on the latest default templates.
For example, to enable the resizable Table of Contents, you need to add a <div id="resizer"> element and add [data-item-type] attributes to container elements. For implementation details, see the template reference.

Updated UI Elements:

• Main layout
• Table of Contents
• Footer
• Search popup
• Code areas and code blocks
• Links
• Tooltips
• Tables
• Markdown tables

Notable improvements

• Performance:
  • Cache packages field, which is used by DefaultExternalLocationProvider.resolve (#​4009)
  • Cache DisplaySourceSet as it's stored a lot inside of ContentPages (#​4008)
  • Significantly improves the performance when working with PackageList (#​4198)
• Support a newline inside link text (#​3661)
• Resolve references to quoted names (#​3356)
• Update jackson to 2.15.3, which doesn't have known vulnerabilities (#​4189)
• Make Dokka safe for Jackson updates in user projects (#​4193)

Other changes and bugfixes

• Update java supertype processing (#​3997). Thanks to @​juliamcclellan!
• Filter non-directory and hidden files from version directories (#​3973). Thanks to @​jeffdgr8!
• Drop the last additional newline character added when rewriting parsed HTML (#​3974). Thanks to @​jeffdgr8!
• Fix constructor details to show description instead of brief in Javadoc (#​4105). Thanks to @​dmitrysulman!
• Remove trove4j from dependencies (#​3178)
• Make Dokka compatible with JDK 25 (#​4202)
• Fix parsing of > in code blocks (#​4210)

Changes from 2.1.0-Beta

• Follow symbolic links when building KaModule for AA standalone session (#​4264)
• Handle InvocationTargetException exception explicitly in DokkaBootstrap (#​4257)
• Support for nested typealiases (#​4261)
• Fix spacing in HTML (#​4239, #​4207)

Feedback

We would appreciate your feedback!

• Please report any feedback or problems https://kotl.in/dokka-issues
• Chat with the community visit #dokka in https://kotlinlang.slack.com/ (To sign up visit https://kotl.in/slack)

---

Configuration

📅 Schedule: (UTC)

• Branch creation
  • At any time (no schedule defined)
• Automerge
  • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.