mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-04-20 22:23:37 +00:00
chore(docs): Refine Dokka source set configuration (#4562)
Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
This commit is contained in:
parent
5b61e059e8
commit
50203dc7f5
1 changed files with 14 additions and 6 deletions
|
|
@ -37,11 +37,18 @@ fun Project.configureDokka() {
|
|||
suppress.set(true)
|
||||
}
|
||||
|
||||
// Ensure source sets containing core logic are not suppressed
|
||||
val isCoreSourceSet = name in listOf("main", "commonMain", "androidMain", "fdroid", "google")
|
||||
if (isCoreSourceSet) {
|
||||
suppress.set(false)
|
||||
}
|
||||
// Dokka 2.x requires each source file to belong to exactly one source set.
|
||||
val baseSourceSets = listOf(
|
||||
"main",
|
||||
"commonMain",
|
||||
"androidMain",
|
||||
"fdroid",
|
||||
"google",
|
||||
"release"
|
||||
)
|
||||
|
||||
val isCoreSourceSet = name in baseSourceSets
|
||||
suppress.set(!isCoreSourceSet)
|
||||
|
||||
sourceLink {
|
||||
enableJdkDocumentationLink.set(true)
|
||||
|
|
@ -50,7 +57,8 @@ fun Project.configureDokka() {
|
|||
|
||||
// Standardized repo-root based source links
|
||||
localDirectory.set(project.projectDir)
|
||||
val relativePath = project.projectDir.relativeTo(rootProject.projectDir).path.replace("\\", "/")
|
||||
val relativePath =
|
||||
project.projectDir.relativeTo(rootProject.projectDir).path.replace("\\", "/")
|
||||
remoteUrl.set(URI("https://github.com/meshtastic/Meshtastic-Android/blob/main/$relativePath"))
|
||||
remoteLineSuffix.set("#L")
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue