Mercurial > irccd
changeset 40:909eb532ca9a
Docs: add missing Irccd.Plugin constants, #426
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Wed, 24 Feb 2016 21:48:00 +0100 |
| parents | b3e0050463bf |
| children | a5f2d5d41994 |
| files | doc/html/api/module/Irccd.Plugin/index.md |
| diffstat | 1 files changed, 33 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/api/module/Irccd.Plugin/index.md Tue Feb 23 15:38:00 2016 +0100 +++ b/doc/html/api/module/Irccd.Plugin/index.md Wed Feb 24 21:48:00 2016 +0100 @@ -7,6 +7,39 @@ This module let you manage plugins. +## Constants + +The following properties are defined: + + - **cachePath**: (string) the path to the cache directory, + - **configPath**: (string) the path to the configuration directory, + - **dataPath**: (string) the path to the data directory. + +## Configuration + +An additional property `config` is defined with all options set in the appropriate `[plugin.<name>]` from the user +configuration file. + +### Example + +If the configuration file configures the plugin **xyz**: + +<div class="panel panel-info"> + <div class="panel-heading">~/.config/irccd/irccd.conf</div> + <div class="panel-body"> +````ini +[plugin.xyz] +foo = true +baz = "hello" +```` + </div> +</div> + +Then `Irccd.Plugin.config` will have the following properties: + + - **foo**: (string) set to "true", + - **baz**: (string) set to "hello". + ## Functions - [info](function/info.html)