Add files to document module and packages

This commit is contained in:
Benoit Marty 2022-04-27 16:52:45 +02:00
parent 250baf225c
commit b319ef40ba
3 changed files with 9 additions and 0 deletions

View File

@ -28,6 +28,9 @@ dokkaHtml {
matchingRegex.set("org.matrix.androidsdk.crypto.data") matchingRegex.set("org.matrix.androidsdk.crypto.data")
suppress.set(true) suppress.set(true)
} }
// List of files with module and package documentation
// https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation
includes.from("./docs/modules.md", "./docs/packages.md")
} }
} }
} }

View File

@ -0,0 +1,3 @@
# Module matrix-sdk-android
Doc for the module!

View File

@ -0,0 +1,3 @@
# Package org.matrix.android.sdk.api
Doc for the package!