aboutsummaryrefslogtreecommitdiff
path: root/dokka-subprojects/plugin-android-documentation/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dokka-subprojects/plugin-android-documentation/README.md')
-rw-r--r--dokka-subprojects/plugin-android-documentation/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/dokka-subprojects/plugin-android-documentation/README.md b/dokka-subprojects/plugin-android-documentation/README.md
new file mode 100644
index 00000000..2928f180
--- /dev/null
+++ b/dokka-subprojects/plugin-android-documentation/README.md
@@ -0,0 +1,10 @@
+# Android documentation plugin
+
+The Android documentation plugin aim to improve documentation experience on the Android platform.
+
+Features:
+
+* Support for the `@hide` KDoc tag. It hides marked declaration from being displayed in documentation.
+
+You can find the Android documentation plugin on
+[Maven Central](https://mvnrepository.com/artifact/org.jetbrains.dokka/android-documentation-plugin).