diff --git a/matrix-sdk-android/build.gradle b/matrix-sdk-android/build.gradle index 4165b60c56..2aab8510ce 100644 --- a/matrix-sdk-android/build.gradle +++ b/matrix-sdk-android/build.gradle @@ -28,6 +28,9 @@ dokkaHtml { matchingRegex.set("org.matrix.androidsdk.crypto.data") 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") } } } diff --git a/matrix-sdk-android/docs/modules.md b/matrix-sdk-android/docs/modules.md new file mode 100644 index 0000000000..c6ae55b4e5 --- /dev/null +++ b/matrix-sdk-android/docs/modules.md @@ -0,0 +1,3 @@ +# Module matrix-sdk-android + +Doc for the module! diff --git a/matrix-sdk-android/docs/packages.md b/matrix-sdk-android/docs/packages.md new file mode 100644 index 0000000000..a229223f3f --- /dev/null +++ b/matrix-sdk-android/docs/packages.md @@ -0,0 +1,3 @@ +# Package org.matrix.android.sdk.api + +Doc for the package!