github Kotlin/dokka v1.7.20
1.7.20 Beta

latest releases: v2.0.0-Beta, v1.9.20, v1.9.10...
2 years ago

This release focuses primarily on improving user experience and HTML format in particular.

Improvements

General

  • Display inherited extensions (can be disabled by setting suppressInheritedMembers configuration property) (#2625)
  • Display details for @Deprecated declarations such as deprecation message, level and proposed replacement (#2622)
  • Display and document Enum's synthetic values() and valueOf() functions (#2650)
  • Do not render constructors for annotation classes (#2642)
  • Display values of Java constants (#2609)
  • Trim spaces inside indented code blocks (#2661, #2232, #2233)
  • Replace package name on the cover of package pages with "Package-level declarations" (#2586)

HTML format

  • Add IntelliJ icons to the navigation side menu (#2578)
  • Add auto-scrolling to selected navigation item (#2575)
  • Use OS color scheme to initialize light/dark mode, thanks to @pt2121! (#2611)
  • Update styling of all section tabs (including platform tabs) to match kotlinlang.org (#2589)
  • Format long signatures dynamically based on client width (#2659)
  • Add a horizontal divider between function overloads that are displayed on the same page (#2585)
  • Add Cmd + K / Ctrl + K hotkey for opening search dialog, thanks to @atyrin! (#2633)
  • Make current breadcrumb element not clickable and of default font color (#2588)
  • Update code highlighting colors (#2670)
  • Do not render platform tabs for common-only content (#2613)
  • Apply the same style to all KDoc tag headers, making it more consistent (#2587)
  • Move source links into signature, especially helpful on pages with many overloads (#2476)
  • Add inner/nested declarations to the navigation side menu (#2597)
  • Disable copy button for signatures (#2577)

Javadoc format

Kotlin-as-Java plugin

  • Render annotation blocks for transformed classes, previously ignored (#2549)

Gradle runner

  • Remove kotlin-stdlib dependency, which should fix errors like Module was compiled with an incompatible version of Kotlin, thanks to @martinbonnin! (#2570)

Bugfixes

  • Fixed missing spaces between adjacent Markdown elements, where _try_ *this* would be rendered as trythis (#2640)
  • Fixed dependency resolution errors when building documentation for multiplatform projects with enabled compatibility metadata variant (#2634)
  • Fixed a rare StackOverflowError related to type-aliased native references (#2664)
  • Fixed IllegalStateException that was caused by using JS's dynamic types (#2645)
  • Fixed a bug where certain private declarations were rendered as public (#2639)
  • Fixed incorrect handling of static declarations used within @see tag (#2627)
  • Fixed Java Enum types being rendered as Any (#2647)
  • Fixed incorrect signature generation that was caused by generic types caching (#2619)
  • Fixed incorrect parsing of static imports in Java annotation params (#2593)
  • Fixed sourceRoots configuration param not handling single .java files, thanks to @2017398956! (#2604)
  • Fixed unresponsive HTML anchor button (#2644)
  • Fixed dokka-customFormat-example project to use up-to-date logo styles (#2608)

Developer experience

  • Enable Gradle Enterprise build scans, thanks to @Goooler! (#2641)
  • Use GitHub Actions artifacts to store generated documentation snapshots, thanks to @StefMa! (#2630)

Other

  • Warn users that GFM, Javadoc and Jekyll formats are in early alpha stages by printing a build log message during execution (#2550)
  • Revise developer guides documentation that should help plugin authors and new contributors (#2523)
  • Bump Gradle to 7.5.1, thanks to @Goooler! (#2618)
  • Fix spelling errors, thanks to @FelixDombek! (#2594)

Don't miss a new dokka release

NewReleases is sending notifications on new releases.