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

Confusing comment about unknown bug in the multi-module sample #1810

Closed
LouisCAD opened this issue Mar 28, 2021 · 3 comments
Closed

Confusing comment about unknown bug in the multi-module sample #1810

LouisCAD opened this issue Mar 28, 2021 · 3 comments
Assignees
Labels
question A user question, can be resolved if the question is answered/resolved

Comments

@LouisCAD
Copy link

LouisCAD commented Mar 28, 2021

Hello, I'm confused by these comments in the multi-modules example:

Kotlin plugin necessary because of potential Gradle bug!
This is not necessary if the kotlin gradle plugin is added as buildscript
dependency like

https://github.com/Kotlin/kotlin-examples/blob/8fd3982e9cf9ba0244833f3910911666902a9a8b/gradle/dokka/dokka-multimodule-example/parentProject/build.gradle.kts#L3-L5

Can you please elaborate on why exactly declaring the kotlin("jvm") plugin in the root project is necessary and what would happen if we don't?

I'm particularly surprised by that since it's not specified anywhere on the doc website, and there's no link to any issue in the code.

Can you clarify these please?
Thank you!

@LouisCAD LouisCAD added the question A user question, can be resolved if the question is answered/resolved label Mar 28, 2021
@LouisCAD
Copy link
Author

@sellmair, it seems you're the one that wrote this, maybe you can help here?

@twyatt
Copy link

twyatt commented Apr 7, 2021

@LouisCAD perhaps that comment was written for an older version of Dokka?

It seems to be working for multi-module projects without using kotlin("jvm").
See basic sample project: https://github.com/twyatt/dokka-external-documentation-test

@IgnatBeresnev IgnatBeresnev self-assigned this Apr 26, 2022
@IgnatBeresnev
Copy link
Member

My educated guest would be that it's about Dokka using Kotlin Gradle plugin to auto-configure source sets and some other things.

If KGP is not applied, Dokka is unable to function properly out of the box and requires manual configuration. We've stressed it in the updated documentation (#2728).

Other than that, I'm not aware of any peculiarities that would explain it. It might indeed be outdated.

I've removed this comment in #2736 to avoid further confusion, so I'll be closing the issue for now. We'll keep and eye out and re-open the issue / re-introduce the comment if we understand what exactly was meant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question A user question, can be resolved if the question is answered/resolved
Projects
None yet
Development

No branches or pull requests

3 participants