Mercurial > irccd

view doc/src/api/module/Irccd.Plugin/Irccd.Plugin.info.md @ 607:bb9771fb5f44

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
line wrap: on
line source

---
function: info
js: true
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