Skip to content

Commit ee89700

Browse files
committed
Split module and package documentation
1 parent 9f9d567 commit ee89700

7 files changed

Lines changed: 19 additions & 14 deletions

File tree

build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ subprojects {
2828
dokka {
2929
dokkaSourceSets.configureEach {
3030
// Package-level documentation
31-
val mdFiles = fileTree("src/main/kotlin") {
31+
val mdFiles = fileTree("src/main") {
3232
include("**/_doc.md")
3333
}
3434
mdFiles.files.forEach { mdFile ->
3535
// Avoid duplicate file name conflicts
36-
val relativePath = mdFile.relativeTo(project.file("src/main/kotlin")).path.replace("/", "-").replace("\\", "-")
36+
val relativePath = mdFile.relativeTo(project.file("src/main")).path.replace("/", "-").replace("\\", "-")
3737
val uniqueFile = project.layout.buildDirectory.file("tmp/dokka-includes/$relativePath").get().asFile
3838
uniqueFile.parentFile.mkdirs()
3939
mdFile.copyTo(uniqueFile, overwrite = true)
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Module typedrest-serializers-jackson
2+
3+
Adds support for serializing using [Jackson](https://github.com/FasterXML/jackson) instead of [kotlinx.serialization](https://kotlinlang.org/docs/serialization.html).
4+
5+
Pass [JacksonJsonSerializer](net.typedrest.serializers.JacksonJsonSerializer) to the [EntryEndpoint](net.typedrest.endpoints.EntryEndpoint) constructor.
Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Module typedrest-serializers-jackson
1+
# Package net.typedrest.serializers
22

3-
Adds support for serializing using [Jackson](https://github.com/FasterXML/jackson) instead of [kotlinx.serialization](https://kotlinlang.org/docs/serialization.html).
4-
5-
Pass [JacksonJsonSerializer](net.typedrest.serializers.JacksonJsonSerializer) to the [EntryEndpoint](net.typedrest.endpoints.EntryEndpoint) constructor.
3+
Serialization of entities sent to and received from the server.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Module typedrest-serializers-moshi
2+
3+
Adds support for serializing using [Moshi](https://github.com/square/moshi) instead of [kotlinx.serialization](https://kotlinlang.org/docs/serialization.html).
4+
5+
Pass [MoshiJsonSerializer](net.typedrest.serializers.MoshiJsonSerializer) to the [EntryEndpoint](net.typedrest.endpoints.EntryEndpoint) constructor.
Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Module typedrest-serializers-moshi
1+
# Package net.typedrest.serializers
22

3-
Adds support for serializing using [Moshi](https://github.com/square/moshi) instead of [kotlinx.serialization](https://kotlinlang.org/docs/serialization.html).
4-
5-
Pass [MoshiJsonSerializer](net.typedrest.serializers.MoshiJsonSerializer) to the [EntryEndpoint](net.typedrest.endpoints.EntryEndpoint) constructor.
3+
Serialization of entities sent to and received from the server.

typedrest/src/main/_doc.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Module typedrest
2+
3+
The main TypedRest library.
Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Module typedrest
2-
3-
The main TypedRest library.
4-
51
# Package net.typedrest
62

73
Common helpers and extensions.

0 commit comments

Comments
 (0)