From 885b79dfad4d15befbd1cb5dd99e6ca727a52895 Mon Sep 17 00:00:00 2001
From: Rowan McAlpin <87948250+rowan-mcalpin@users.noreply.github.com>
Date: Sun, 1 Dec 2024 16:27:22 -0800
Subject: [PATCH] Dokka configuration for multi-module project

---
 build.gradle.kts      | 13 +++++++++++++
 core/MODULE.md        | 11 +++++++++++
 core/build.gradle.kts | 10 ++++++++++
 ftc/MODULE.md         | 15 +++++++++++++++
 ftc/build.gradle.kts  |  8 ++++++++
 5 files changed, 57 insertions(+)
 create mode 100644 core/MODULE.md
 create mode 100644 ftc/MODULE.md

diff --git a/build.gradle.kts b/build.gradle.kts
index 017a9c4..622b56a 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -1,3 +1,5 @@
+import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
+
 plugins {
     kotlin("jvm") version "2.0.20"
 
@@ -7,6 +9,17 @@ plugins {
     id("org.jetbrains.kotlin.android") version "2.0.20" apply false
 }
 
+tasks.withType<DokkaMultiModuleTask>().configureEach {
+    val dokkaDir = layout.buildDirectory.dir("dokka")
+    outputDirectory.set(dokkaDir)
+    pluginsMapConfiguration.set(
+        mapOf(Pair("org.jetbrains.dokka.base.DokkaBase", """
+            {
+                "footerMessage": "Copyright © 2024 Expressway contributors, BSD-3-Clause"
+            }"""))
+    )
+}
+
 repositories {
     mavenCentral()
     gradlePluginPortal()
diff --git a/core/MODULE.md b/core/MODULE.md
new file mode 100644
index 0000000..daa02e4
--- /dev/null
+++ b/core/MODULE.md
@@ -0,0 +1,11 @@
+# Module core
+
+Base functionality that is not dependent on the FIRST Tech Challenge SDK
+
+# Package page.j5155.expressway.core.actions
+
+RoadRunner Action expanded functionality
+
+# Package page.j5155.expressway.core.geometry
+
+Geometrical functionality
diff --git a/core/build.gradle.kts b/core/build.gradle.kts
index 3f7886f..9ce4935 100644
--- a/core/build.gradle.kts
+++ b/core/build.gradle.kts
@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
 import java.io.ByteArrayOutputStream
 
 /* Gets the version name from the latest Git tag */
@@ -37,6 +38,15 @@ dependencies {
 tasks.test {
     useJUnitPlatform()
 }
+
+tasks.withType<DokkaTaskPartial>().configureEach {
+    dokkaSourceSets {
+        configureEach {
+            includes.from("MODULE.md")
+        }
+    }
+}
+
 kotlin {
     jvmToolchain(18)
 }
diff --git a/ftc/MODULE.md b/ftc/MODULE.md
new file mode 100644
index 0000000..88724f5
--- /dev/null
+++ b/ftc/MODULE.md
@@ -0,0 +1,15 @@
+# Module ftc
+
+Expressway functionality dependent on the FIRST Tech Challenge SDK
+
+# Package page.j5155.expressway.ftc.actions
+
+Additional functionality for RoadRunner Actions
+
+# Package page.j5155.expressway.ftc.geometry
+
+Expanded Geometry functionality
+
+# Package page.j5155.expressway.ftc.motion
+
+Motion control systems
\ No newline at end of file
diff --git a/ftc/build.gradle.kts b/ftc/build.gradle.kts
index ea01024..7c76c1f 100644
--- a/ftc/build.gradle.kts
+++ b/ftc/build.gradle.kts
@@ -1,3 +1,4 @@
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
 import java.io.ByteArrayOutputStream
 
 /* Gets the version name from the latest Git tag */
@@ -39,6 +40,13 @@ dependencies {
     implementation("com.acmerobotics.roadrunner:actions:1.0.0")
 }
 
+tasks.withType<DokkaTaskPartial>().configureEach {
+    dokkaSourceSets {
+        configureEach {
+            includes.from("MODULE.md")
+        }
+    }
+}
 
 android {
     namespace = "page.j5155.roadrunner.expressway.ftc"