diff options
| author | Marcin Aman <marcin.aman@gmail.com> | 2020-10-07 16:30:59 +0200 |
|---|---|---|
| committer | Kamil Doległo <9080183+kamildoleglo@users.noreply.github.com> | 2020-10-08 16:12:10 +0200 |
| commit | fd88f63f7f2874df7a4a58a5c7126d8a5a15225b (patch) | |
| tree | 57de1203ba96626bb882dd8edf5bbeb4bc0e26be /docs | |
| parent | 2d1dc01ca208bfba33265238a01c5239f1dbebd2 (diff) | |
| download | dokka-fd88f63f7f2874df7a4a58a5c7126d8a5a15225b.tar.gz dokka-fd88f63f7f2874df7a4a58a5c7126d8a5a15225b.tar.bz2 dokka-fd88f63f7f2874df7a4a58a5c7126d8a5a15225b.zip | |
Include information about required META-INF/services file
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/doc/docs/developer_guide/introduction.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/src/doc/docs/developer_guide/introduction.md b/docs/src/doc/docs/developer_guide/introduction.md index ba5f8bdc..11ef82ff 100644 --- a/docs/src/doc/docs/developer_guide/introduction.md +++ b/docs/src/doc/docs/developer_guide/introduction.md @@ -42,7 +42,8 @@ tasks.withType<KotlinCompile> { ## Building sample plugin -In order to load a plugin into Dokka, your class must extend `DokkaPlugin` class. All instances are automatically loaded during Dokka setup using `java.util.ServiceLoader`. +In order to load a plugin into Dokka, your class must extend `DokkaPlugin` class. A fully qualified name of that class must be placed in a file named `org.jetbrains.dokka.plugability.DokkaPlugin` under `resources/META-INF/services`. +All instances are automatically loaded during Dokka setup using `java.util.ServiceLoader`. Dokka provides a set of entry points, for which user can create their own implementations. They must be delegated using `DokkaPlugin.extending(definition: ExtendingDSL.() -> Extension<T, *, *>)` function,that returns a delegate `ExtensionProvider` with supplied definition. |