From c01e49eec9558736959d12820361624a3c3e41e5 Mon Sep 17 00:00:00 2001 From: Marcin Aman Date: Mon, 1 Mar 2021 11:57:30 +0100 Subject: Suppress tag support (#1742) * Suppress tag support * Support Hide tag in javadoc * Extract hide tag to be in separate plugin --- docs/src/doc/docs/user_guide/android-plugin/android-plugin.md | 8 ++++++++ docs/src/doc/docs/user_guide/introduction.md | 1 + docs/src/doc/mkdocs.yml | 1 + 3 files changed, 10 insertions(+) create mode 100644 docs/src/doc/docs/user_guide/android-plugin/android-plugin.md (limited to 'docs/src/doc') diff --git a/docs/src/doc/docs/user_guide/android-plugin/android-plugin.md b/docs/src/doc/docs/user_guide/android-plugin/android-plugin.md new file mode 100644 index 00000000..75e3d927 --- /dev/null +++ b/docs/src/doc/docs/user_guide/android-plugin/android-plugin.md @@ -0,0 +1,8 @@ +# Android documentationn plugin + +Android documentation plugin aims to improve the documentation on android platform. + +### Features: + +* `@hide` support - `@hide` javadoc tag is an equivalent of `@suppress` tag in kdoc. It hides certain entry from being + displayed in the documentation. \ No newline at end of file diff --git a/docs/src/doc/docs/user_guide/introduction.md b/docs/src/doc/docs/user_guide/introduction.md index 0de6a5ef..cb263ebe 100644 --- a/docs/src/doc/docs/user_guide/introduction.md +++ b/docs/src/doc/docs/user_guide/introduction.md @@ -10,6 +10,7 @@ Currently maintained plugins are: * `jekyll-plugin` - configures `Jekyll` output format * `javadoc-plugin` - configures `Javadoc` output format, automatically applies `kotlin-as-java-plugin` * `kotlin-as-java-plugin` - translates Kotlin definitions to Java +* `android-documentation-plugin` - provides android specific enhancements like `@hide` support Please see the usage instructions for each build system on how to add plugins to Dokka. diff --git a/docs/src/doc/mkdocs.yml b/docs/src/doc/mkdocs.yml index c58376e3..ac962baa 100644 --- a/docs/src/doc/mkdocs.yml +++ b/docs/src/doc/mkdocs.yml @@ -50,6 +50,7 @@ nav: - Maven: user_guide/maven/usage.md - Command line: user_guide/cli/usage.md - Html frontend: user_guide/base-specific/frontend.md + - Android plugin: user_guide/android-plugin/android-plugin.md - Plugin development: - Introduction: developer_guide/introduction.md - Data model: developer_guide/data_model.md -- cgit