Improved API documentation

Author: bastianeicher

.github/workflows/build.yml

@@ -23,7 +23,7 @@ jobs:
 
       # Build
       - run: gradle build
-      - run: gradle dokkaHtml
+      - run: gradle dokkaHtmlMultiModule
       - run: gradle test
       - name: Report test results
         if: always()
@@ -58,5 +58,5 @@ jobs:
         with:
           github_token: ${{github.token}}
           force_orphan: true
-          publish_dir: build/dokka/html
+          publish_dir: build/dokka/htmlMultiModule
           cname: java.typedrest.net

build.gradle.kts

@@ -1,9 +1,11 @@
-repositories.mavenCentral()
+import org.jetbrains.dokka.gradle.*
+
+repositories.mavenCentral()
 
 plugins {
     kotlin("jvm") version "2.0.0"
     kotlin("plugin.serialization") version "2.0.0" apply false
-    id("org.jetbrains.dokka") version "1.9.20" apply false
+    id("org.jetbrains.dokka") version "1.9.20"
 }
 
 subprojects {
@@ -20,4 +22,10 @@ subprojects {
     kotlin {
         compilerOptions.allWarningsAsErrors = true
     }
+
+    fun NamedDomainObjectContainer<GradleDokkaSourceSetBuilder>.addMarkdown() = configureEach {
+        includes.from(project.files(), fileTree("src/main/kotlin").include("**/_doc.md"))
+    }
+    tasks.withType<DokkaTask>().configureEach { dokkaSourceSets.addMarkdown() }
+    tasks.withType<DokkaTaskPartial>().configureEach { dokkaSourceSets.addMarkdown() }
 }

typedrest-serializers-jackson/src/main/kotlin/net/typedrest/serializers/_doc.md

@@ -0,0 +1,5 @@
+# Module typedrest-serializers-jackson
+
+Adds support for serializing using [Jackson](https://github.com/FasterXML/jackson) instead of [kotlinx.serialization](https://kotlinlang.org/docs/serialization.html).
+
+Pass [JacksonJsonSerializer](net.typedrest.serializers.JacksonJsonSerializer) to the [EntryEndpoint](net.typedrest.endpoints.EntryEndpoint) constructor.

typedrest-serializers-moshi/src/main/kotlin/net/typedrest/serializers/_doc.md

@@ -0,0 +1,5 @@
+# Module typedrest-serializers-moshi
+
+Adds support for serializing using [Moshi](https://github.com/square/moshi) instead of [kotlinx.serialization](https://kotlinlang.org/docs/serialization.html).
+
+Pass [MoshiJsonSerializer](net.typedrest.serializers.MoshiJsonSerializer) to the [EntryEndpoint](net.typedrest.endpoints.EntryEndpoint) constructor.

typedrest/src/main/kotlin/net/typedrest/_doc.md

@@ -0,0 +1,7 @@
+# Module typedrest
+
+The main TypedRest library.
+
+# Package net.typedrest
+
+Common helpers and extensions.