Skip to content

[K2] Stabilize pure Kotlin/JVM and mixed Kotlin/Java projects #3140

@IgnatBeresnev

Description

@IgnatBeresnev

This issue is part of a larger issue: Migrate Dokka's analysis to K2 compiler (#2888).

Goal

Dokka should be able to generate documentation for any pure Kotlin/JVM project, or any project that uses a mix of Kotlin and Java together.

That means, it has to work with:

  • All JVM versions officially supported by Kotlin. Running on Java 8, 11 and 17 should produce the same result.
  • Projects that use pure Java and/or JVM-only Kotlin libraries (KMP libraries fall outside of the scope, they should be addressed in [K2] Support KMP projects #3137). All user-visible types must be resolved correctly, including external documentation links.
  • Projects that only use Kotlin's standard library and/or Java SE API directly (declarations from java.lang, java.util and similar packages).
  • Dokka's JVM-only Javadoc format.

Once done, we should be able to turn on the K2 analysis by default for all JVM-only user projects.

Due date

The K2 analysis should be used by default in all JVM-only user projects in Dokka 2.0.0, with the ability to fall back to K1.

If there are unresolved issues or bugs by that time, at the very least it should be available for early testing (i.e toggleable via a flag).

Sub-tasks

Upstream issues

Metadata

Metadata

Assignees

Labels

epicA large body of work that is broken down into smaller issueslanguage: JavaIssue/PR related to the Java language feature/analysis/docslanguage: KotlinIssue/PR related to the Kotlin language feature/analysis/docstopic: K2Issues / PRs that are related to the K2 migration. See #2888

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions