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.

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

[K2] Support generating documentation for stdlib #3354

Open
vmishenev opened this issue Nov 16, 2023 · 3 comments
Open

[K2] Support generating documentation for stdlib #3354

vmishenev opened this issue Nov 16, 2023 · 3 comments
Labels
bug topic: K2 Issues / PRs that are related to the K2 migration. See #2888
Milestone

Comments

@vmishenev
Copy link
Contributor

vmishenev commented Nov 16, 2023

Currently, it is blocked by #3137 and (possible) https://youtrack.jetbrains.com/issue/KT-56076/K2-build-Kotlin-standard-library

StdLib is a specific Kotlin library that can require supporting extra flags to analyse and build the documentation. For example, in Dokka K1 the flag ignoreCommonBuiltIns should be enabled to analyse stdlib.

Dokka K2 should have the possibility to generate correct documentation for stdlib.
The result documentation should have no difference from the output generated by Dokka K1.

Technical details

It can require enabling AnalysisFlags.allowKotlinPackage in the Analysis API. Also, extra analysis flags can be needed.

@vmishenev vmishenev added bug topic: K2 Issues / PRs that are related to the K2 migration. See #2888 labels Nov 16, 2023
@vmishenev vmishenev changed the title [K2] Support stdlib [K2] Support generating documentation for stdlib Nov 16, 2023
@whyoleg
Copy link
Contributor

whyoleg commented Nov 17, 2023

First tests which are specific to stdlib and are failing now for K2 are added in #3349 to ObviousAndInheritedFunctionsDocumentableFilterTest (in the end of file). They are now muted with OnlyDescriptors until this issue is resolved

@Kotlin Kotlin deleted a comment from ANGIL21 Nov 20, 2023
@Kotlin Kotlin deleted a comment from ANGIL21 Nov 20, 2023
@IgnatBeresnev
Copy link
Member

Need to keep an eye on the issue and how it's resolved for compiling K2, and go from there.

@vmishenev
Copy link
Contributor Author

Requires #3939

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug topic: K2 Issues / PRs that are related to the K2 migration. See #2888
Projects
None yet
Development

No branches or pull requests

3 participants