Mercurial > irccd
comparison doc/src/api/module/Irccd.Plugin/Irccd.Plugin.info.md @ 607:bb9771fb5f44
Docs: rework documentation
- Change directories,
- Remove handwritten manual pages.
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Fri, 08 Dec 2017 20:11:22 +0100 |
| parents | doc/html/api/module/Irccd.Plugin/Irccd.Plugin.info.md@48676ca7071c |
| children | ebdc614db066 |
comparison
equal
deleted
inserted
replaced
| 606:4f5f306d13ac | 607:bb9771fb5f44 |
|---|---|
| 1 --- | |
| 2 function: info | |
| 3 js: true | |
| 4 summary: "Get information about a plugin." | |
| 5 synopsis: "Irccd.Plugin.info(name)" | |
| 6 arguments: | |
| 7 - "**name**: the plugin identifier, if not specified the current plugin is selected." | |
| 8 returns: "The plugin information or undefined if the plugin was not found." | |
| 9 --- | |
| 10 | |
| 11 The returned object as the following properties: | |
| 12 | |
| 13 - **name**: (string) the plugin identifier, | |
| 14 - **author**: (string) the author, | |
| 15 - **license**: (string) the license, | |
| 16 - **summary**: (string) a short description, | |
| 17 - **version**: (string) the version |