aboutsummaryrefslogtreecommitdiff
path: root/plugins/android-documentation/README.md
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-01-19 04:10:57 +0100
committerGitHub <noreply@github.com>2023-01-19 04:10:57 +0100
commit5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch)
treebb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /plugins/android-documentation/README.md
parent1fa8552994fb292729eca8c0de6a1561380b008c (diff)
downloaddokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz
dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2
dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'plugins/android-documentation/README.md')
-rw-r--r--plugins/android-documentation/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/plugins/android-documentation/README.md b/plugins/android-documentation/README.md
new file mode 100644
index 00000000..2928f180
--- /dev/null
+++ b/plugins/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).