github Kotlin/dokka v2.0.0-Beta
2.0.0-Beta

pre-release9 hours ago

Dokka's Gradle plugin v2 based on Dokkatoo

Please check the migration guide for the update procedure and give feedback!

DGP v2 introduces significant improvements to DGP, aligning more closely with Gradle best practices:

  • Adopts Gradle types, which leads to better performance.
  • Uses an intuitive top-level DSL configuration instead of a low-level task-based setup, which simplifies the build scripts and their readability.
  • Takes a more declarative approach to documentation aggregation, which makes multi-project documentation easier to manage.
  • Uses a type-safe plugin configuration, which improves the reliability and maintainability of your build scripts.
  • Fully supports Gradle configuration cache and
    build cache, which improves performance and simplifies build work.

Note: org.jetbrains.dokka-javadoc is not yet published to Maven Central and is only available via Gradle Plugin Portal

HTML format

  • Fix overflow of long underscore separated names in HTML (#3240). Thanks to @seelchen!
  • Accessibility: Wrap links and code blocks (#3415). Thanks to @lauzadis!
  • Accessibility: add outline when section-tab is focused (#3416). Thanks to @lauzadis!
  • fix: made tabs work when open via iframe (#3323)
  • Fixed theme switcher on root page of multimodule project (#3616)
  • HTML rendering memory allocations optimisation (#3800)

Bugfixes

  • Fix checking for annotations when rendering constructor keyword (#3523)
  • Fix KDoc and Javadoc link to a package (#3490)
  • Handle exception for recursive type aliases (#3582)
  • Do not show the override modifier for fake overrides (#3696)
  • Display Java's Deprecated message (#3421)

Other changes

  • Fix for broken link, typo, and sample code (#3532). Thanks to @LiYing2010!
  • Remove <a href="TODO"> in enum constant summary (#3548). Thanks to @MattiasBuelens!
  • Remove log4j coming from intellij dependencies (#3592)
  • Replace Path.toRealPath in K1 analysis to improve performance a bit (#3608)
  • Support specifying custom folder name for older versions for versioning plugin (#3693)
  • Fix links in nested class summary not resolved correctly (#3674). Thanks to @MattiasBuelens!
  • Filter out JVM mapped methods (#3694)

Feedback

We would appreciate your feedback!

Full Changelog: v1.9.20...v2.0.0-Beta

Don't miss a new dokka release

NewReleases is sending notifications on new releases.