aboutsummaryrefslogtreecommitdiff
path: root/examples/plugin/hide-internal-api/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 /examples/plugin/hide-internal-api/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 'examples/plugin/hide-internal-api/README.md')
-rw-r--r--examples/plugin/hide-internal-api/README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/examples/plugin/hide-internal-api/README.md b/examples/plugin/hide-internal-api/README.md
index 59d27c79..fe02e025 100644
--- a/examples/plugin/hide-internal-api/README.md
+++ b/examples/plugin/hide-internal-api/README.md
@@ -1 +1,18 @@
-This plugin uses [Dokka plugin template](https://github.com/Kotlin/dokka-plugin-template).
+# Hide Internal API plugin example
+
+This project represents a simple Dokka Plugin that was developed step-by-step in the
+[Sample plugin](https://kotlin.github.io/dokka/1.7.20/developer_guide/plugin-development/sample-plugin-tutorial/)
+tutorial. This is a frequent request with varying requirements.
+
+The plugin excludes any declaration that is marked with `org.jetbrains.dokka.internal.test.Internal` annotation.
+The annotation itself is not provided in this project and is instead matched by the fully qualified name only.
+You can change it to your own internal annotation or to some other marker that suits you.
+
+To learn how to install and debug it locally,
+[see documentation](https://kotlin.github.io/dokka/1.7.20/developer_guide/plugin-development/sample-plugin-tutorial/#debugging).
+
+___
+
+Generally, you can use this project to get an idea of how to create Dokka plugins as it covers the basics of getting started.
+
+This project was created from the [Dokka plugin template](https://github.com/Kotlin/dokka-plugin-template).