Kotlin
Source sets without standard 'Main' suffix has invalid displayName convention (Why is my part of my code missing source links?)
Question
I configured the source link and I think it was configured correctly. But some code have (Source) link and some are not. And, some docs pages look buggly.
Screenshots
Installation
- Operating system: Linux
- Build tool: Gradle v8.13
- Dokka version: 2.0.0
Additional information Project URL: https://github.com/iseki0/Executables
Hey! Thanks for the report! The issue is rather cumbersome, but I was able to decipher what happened.
I opened the project locally and found that the Dokka configuration created by DGP contained two source sets with different sourceSetID but the same displayName (= common). So, our front end was not ready for this.
It happened because, in the project, there was a source set named nativeFileUnsupported (without the Main or Test suffix). So it caused the following branch to be executed, so causing nativeFileUnsupported sourceSet to have display name equals to common.
As for the workaround/fix, it's better to rename nativeFileUnsupported to nativeFileUnsupportedMain to follow convention—in this case, there will be no errors. (Additionally, target hierarchy similar to this one could help).
As for the fix inside DGPv2, we could probably change the fallback to just the name of the sourceSet instead of platform.displayName? cc @adam-enko
May be it would be nice to even add a check for displayName similar to what we already have for sourceSetID. @vmishenev WDYT?
As for the fix inside DGPv2, we could probably change the fallback to just the name of the sourceSet instead of
platform.displayName? cc @adam-enko
Yeah, that makes sense to me.
In case it helps with figuring out if changing the default name is okay, I believe the logic is the same as in DGPv1 here.
