You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Expected behaviour
The generated Dokka documentation should include Android Jetpack's Compose libraries by default. (i.e. link to the respective Jetpack Compose classes where possible)
Are you willing to provide a PR?
I suppose so. Looking around in the source code for "AndroidX" points me to defaultExternalLinks.kt, which is used for the default externalDocumentationLinks.
Describe the bug
The generated Dokka documentation does not include API links to Android Jetpack's Compose libraries by default.
Expected behaviour
The generated Dokka documentation should include Android Jetpack's Compose libraries by default. (i.e. link to the respective Jetpack Compose classes where possible)
Screenshots
The
Modifier
class should link to theModifier
class in the Android docs, but in this screenshot it doesn't.To Reproduce
feat/dokka
branch./gradlew dokkaHtmlMultiModule
to generate the Dokka docsbuild/dokka/htmlMultiModule
) (for e.g. withnpx http-server
)EphemerisCalendarView
Dokka configuration
Configuration of dokka used to reproduce the bug
Installation
Additional context
N/A
Are you willing to provide a PR?
I suppose so. Looking around in the source code for "AndroidX" points me to
defaultExternalLinks.kt
, which is used for the defaultexternalDocumentationLink
s.I believe the line to fix should be as follows:
dokka/core/src/main/kotlin/defaultExternalLinks.kt
Line 28 in 14710ab
It should be modified from https://developer.android.com/reference/androidx/package-list to https://developer.android.com/reference/kotlin/androidx/package-list, which should then include the Kotlin-only libraries like Jetpack Compose
Edit: I've just opened a PR #2456
The text was updated successfully, but these errors were encountered: