Dokka 1.7.20+ ignores sourceLinks block on android library projects #2876
Labels
bug
configuration
An issue/PR related to Dokka's configuration by the user
platform: android-jvm
An issue/PR that has some Android platform specifics
regression
An issue/bug that appeared after recent changes
runner: gradle plugin v2
Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131
runner: Gradle plugin
An issue/PR related to Dokka's Gradle plugin
Milestone
Describe the bug
On dokka v1.7.20 and 1.8.10, the
sourceLinks
block is ignored on ANDROID library projects, but seems to work as expected on JVM libraries.Expected behaviour
The source link for methods should appear on generated docs of android library projects.
Screenshots
This screenshot shows the documentation generated by the
jvm-lib-working
branch of the attached file. Thats the expected behaviour in android-library projects.This is the actual behaviour, it does not show the [sources] link. This screenshot shows the documentation generated by the
android-lib-bug
branch of the attached file.This screenshot was taken while using dokka 1.7.10 on the
android-lib-bug
branch of the attached file. Note that a "sources" tab appears as expected for this version.To Reproduce
See dokka-bug.zip
In it there are two branches,
jvm-lib-working
andandroid-lib-bug
, so you can switch between the functional and the non-functional state.Step 1: Enter the project directory
Step 2: Switch to
android-lib-bug
branchStep 3: Run
./gradlew :lib:dokkaHtml
Step 4: Verify generated docs at
lib/build/dokka/html
Dokka configuration
Configuration of dokka used to reproduce the bug
Copy-pasted from the attached project.
Installation
Additional context
As i said, this bug only happens on dokka 1.7.20 and 1.8.10, from 1.7.10 down the
sourceLinks
block isnt ignored on android library projects.Although I have no proof, I suspect that this bug is related to this PR.
Are you willing to provide a PR?
Unfortunately for the time being I don't have enough knowledge to fix it.
The text was updated successfully, but these errors were encountered: