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.

Sign up for GitHub

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

Jump to bottom

Update dokka to v1.8.10 #555

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update dokka to v1.8.10 #555

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 8, 2022 •
edited
Loading

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.jetbrains.dokka 1.6.10 -> 1.8.10 age adoption passing confidence
org.jetbrains.dokka:dokka-gradle-plugin 1.6.10 -> 1.8.10 age adoption passing confidence
org.jetbrains.dokka:dokka-core 1.6.10 -> 1.8.10 age adoption passing confidence

⚠ Dependency Lookup Warnings ⚠

Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information.

Release Notes

Kotlin/dokka

v1.8.10: 1.8.10 Beta

Dokka's documentation has been entirely rewritten and can now be found on kotlinlang.org:

  • More examples, including Groovy DSL for Gradle project configuration
  • More guidelines to help beginners
  • More details for complex projects

Note: Version 1.8.0 was skipped due to a Metaspace memory leak in Kotlin's reflection (KT-56093). Dokka 1.8.10 should be fully compatible with Kotlin 1.8.0.

Improvements

  • Revise project documentation and examples (#​2728, #​2737, #​2736). Thanks to @​sarahhaggarty for helping!
  • Support generating documentation for Kotlin/Wasm projects (#​2814). Thanks to @​igoriakovlev!
  • Move the contents of Inheritors, Parameters, See also and Samples tabs into the main declaration description (#​2688).
  • Add Members and Members & Extensions tabs to class-like declaration pages (#​2764).
  • Display source set / platform indicators at all times, which should help identify the supported platform of single-platform libraries and modules. (#​2847).
  • Generate the default no-arg constructor for Java declarations (#​2765).

Bugfixes

  • Fixed analysis environment not being properly disposed (#​2755).
  • Fixed nondeterministic sorting of function/property overloads (#​2784).
  • Fixed inconsistent alphabetical order of element groups in index and navigation (#​2861).
  • Fixed constructors being rendered as functions (#​2689).
  • Fixed default values for var properties being displayed (#​2717).
  • Fixed source links leading to the KDoc instead of the declaration (#​2724).
  • Fixed thread-safety issues in DokkaLogger (#​2827).
  • Fixed documentation not being inherited in case of diamond inheritance (#​2686).
Gradle Plugin
  • Fixed NoSuchMethodError when running under Gradle 8 (#​2796).
  • Fixed possible metaspace leaks due to external thread locals not being disposed (#​2678).
  • Fixed premature initialization of outputDirectory input property (#​556).
  • Fixed premature initialization of moduleVersion input property (#​2799). Thanks to @​JavierSegoviaCordoba!
  • Fixed unnecessary snapshotting of source link directory input which led to performance problems (#​2807).
  • Fixed missing group and description for MultiModule tasks (#​2806). Thanks to @​TWiStErRob!
Javadoc
  • Fixed truncation of module and package description after the first sentence (#​2055). Thanks to @​BlackAnubis7!
  • Fixed rendering of empty/useless Kotlin companion objects (#​200, #​2086)
  • Fixed leaking configuration/environment details in generated links (#​2803).
  • Fixed incorrect links when javadoc.jar produced by Dokka is imported into IntelliJ IDEA / Android Studio (#​2734). Thanks to @​bomberaya!

Plugin API

  • Mark Plugin API as experimental (#​2716).

Infrastructure

  • Enable Gradle build cache, and add caching of Maven dependencies for GitHub Actions (#​2711, #​2722). Thanks to @​aSemy!
  • Add concurrency cancellation for build/test GitHub Actions (#​2710). Thanks to @​aSemy!

Other

v1.7.20: 1.7.20 Beta

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
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)

v1.7.10: 1.7.10 Beta

Bugfix release that addresses several blockers and regressions.

General
  • Support Kotlin 1.7.10
Gradle plugin
  • Do not expose Kotlin stdlib in plugin dependencies, this should fix errors like Module was compiled with an incompatible version of Kotlin when using Dokka. Thanks to @​martinbonnin (#​2543)
Java sources
  • Fixed build failure caused by having configured source links for Java code (#​2544)
  • Fixed several exotic problems that led to build failures, all related to using annotation in Java sources (#​2509, #​2551, #​2350)
  • Fixed IntelliJ platform WARN: Attempt to load key messages that appeared when analyzing Java sources (#​2559)

v1.7.0: 1.7.0 Beta

Improvements

General
HTML format
Javadoc format
GFM format
Kotlin-as-Java plugin
Gradle runner

Fixes

General bugfixes
Security

Plugin API

Other

Thanks to all the contributors!

v1.6.21: 1.6.21 Beta

This is a bugfix release that mostly enables building documentation for multiplatform projects that utilize .klib libraries.

Changes
Bugfixes
  • Support KLIB libraries for common platform, previously led to ERROR CLASS instead of references in documentation (#​2441)
  • Fixed a maven plugin build problem related to coroutines which only occurred in multi-module builds (#​2461)

v1.6.20: 1.6.20 Beta

Features
HTML format changes
Bugfixes
Plugin API Changes
General Improvements
Known issues
  • Kotlin Multiplatform projects that use .klib libraries may experience problems. There will be a separate 1.6.21 release that will address this issue shortly.

Configuration

📅 Schedule: 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 these updates again.

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

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from RBusarow as a code owner September 8, 2022 07:52
@renovate renovate bot changed the title Update dokka to v1.7.10 Update dokka to v1.7.20 Oct 11, 2022
@renovate renovate bot changed the title Update dokka to v1.7.20 Update dokka to v1.8.10 Mar 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RBusarow RBusarow Awaiting requested review from RBusarow RBusarow is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
automerge dependencies
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants