Add Dokka developer API docs for MatrixStorage

Author: 54895y

build.gradle.kts

@@ -2,12 +2,14 @@ import io.izzel.taboolib.gradle.*
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import org.gradle.api.file.DuplicatesStrategy
 import org.gradle.jvm.tasks.Jar
+import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
 plugins {
     java
     id("com.gradleup.shadow") version "9.3.1"
     id("io.izzel.taboolib") version "2.0.36"
+    id("org.jetbrains.dokka") version "1.9.20"
     kotlin("jvm") version "2.3.0"
 }
 
@@ -60,6 +62,16 @@ tasks.withType<JavaCompile> {
     options.encoding = "UTF-8"
 }
 
+tasks.withType<DokkaTask>().configureEach {
+    moduleName.set("MatrixStorage API")
+    dokkaSourceSets.configureEach {
+        includes.from("docs/api/overview.md")
+        jdkVersion.set(8)
+        reportUndocumented.set(false)
+        skipDeprecated.set(false)
+    }
+}
+
 kotlin {
     compilerOptions {
         jvmTarget = JvmTarget.fromTarget("1.8")
@@ -71,6 +83,12 @@ configure<JavaPluginExtension> {
     targetCompatibility = JavaVersion.VERSION_1_8
 }
 
+val dokkaJavadocJar by tasks.registering(Jar::class) {
+    dependsOn(tasks.named("dokkaJavadoc"))
+    archiveClassifier.set("javadoc")
+    from(tasks.named("dokkaJavadoc"))
+}
+
 tasks.named<ShadowJar>("shadowJar") {
     val runtimeJar = tasks.named<Jar>("jar").get()
     dependsOn(runtimeJar)
@@ -88,3 +106,13 @@ tasks.named<ShadowJar>("shadowJar") {
 tasks.named("build") {
     dependsOn(tasks.named("shadowJar"))
 }
+
+tasks.named("assemble") {
+    dependsOn(dokkaJavadocJar)
+}
+
+tasks.register("generateJavadoc") {
+    group = "documentation"
+    description = "Generate Javadoc-style API docs with Dokka."
+    dependsOn("dokkaJavadoc")
+}

docs/api/overview.md

@@ -0,0 +1,31 @@
+Module MatrixStorage API
+
+MatrixStorage 当前没有单独拆分稳定 `api/` 包，开发者文档应优先参考平台入口、模型、服务和 UI 分层。
+
+Recommended reference areas:
+
+- `MatrixStorage`
+- `MatrixStoragePlatform`
+- `bridge/`
+- `integration/`
+- `model/`
+- `service/`
+- `storage/`
+- `ui/`
+
+Code tree:
+
+```text
+src/main/kotlin/com/y54895/matrixstorage/
+├─ MatrixStorage.kt
+├─ MatrixStoragePlatform.kt
+├─ bridge/
+├─ command/
+├─ integration/
+├─ listener/
+├─ metrics/
+├─ model/
+├─ service/
+├─ storage/
+└─ ui/
+```