From fd88f63f7f2874df7a4a58a5c7126d8a5a15225b Mon Sep 17 00:00:00 2001 From: Marcin Aman Date: Wed, 7 Oct 2020 16:30:59 +0200 Subject: Include information about required META-INF/services file --- docs/src/doc/docs/developer_guide/introduction.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 { ## 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)` function,that returns a delegate `ExtensionProvider` with supplied definition. -- cgit