Mercurial > irccd
diff doc/html/api/module/Irccd.Plugin/function/info.md @ 0:1158cffe5a5e
Initial import
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 08 Feb 2016 16:43:14 +0100 |
parents | |
children | 392778b6d3c9 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/api/module/Irccd.Plugin/function/info.md Mon Feb 08 16:43:14 2016 +0100 @@ -0,0 +1,16 @@ +--- +function: info +summary: "Get information about a plugin." +synopsis: "Irccd.Plugin.info(name)" +arguments: + - "name, the plugin identifier, if not specified the current plugin is selected." +returns: "The plugin information or undefined if the plugin was not found." +--- + +The returned object as the following properties: + + - **name**: (string) the plugin identifier, + - **author**: (string) the author, + - **license**: (string) the license, + - **summary**: (string) a short description, + - **version**: (string) the version