diff options
| author | Marcin Aman <marcin.aman@gmail.com> | 2021-03-01 11:57:30 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-01 11:57:30 +0100 |
| commit | c01e49eec9558736959d12820361624a3c3e41e5 (patch) | |
| tree | a88ee64c5ba5a8d4c9ff037fdfbea6a3527349fe /docs | |
| parent | 201a9785a04d631fae65a3af3b495962e4f16d14 (diff) | |
| download | dokka-c01e49eec9558736959d12820361624a3c3e41e5.tar.gz dokka-c01e49eec9558736959d12820361624a3c3e41e5.tar.bz2 dokka-c01e49eec9558736959d12820361624a3c3e41e5.zip | |
Suppress tag support (#1742)
* Suppress tag support
* Support Hide tag in javadoc
* Extract hide tag to be in separate plugin
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/doc/docs/user_guide/android-plugin/android-plugin.md | 8 | ||||
| -rw-r--r-- | docs/src/doc/docs/user_guide/introduction.md | 1 | ||||
| -rw-r--r-- | docs/src/doc/mkdocs.yml | 1 |
3 files changed, 10 insertions, 0 deletions
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 |