Mercurial > irccd
view doc/src/api/module/Irccd/index.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 | |
children | ebdc614db066 |
line wrap: on
line source
--- module: Irccd --- ## Usage Contains general irccd variables and functions. ## Constants The following properties are defined: - **version**: (object) - **major**: (int) the major irccd version, - **minor**: (int) the minor irccd version, - **patch**: (int) the patch irccd version. ## Types - **SystemError**: (function) an exception inheriting `Error` thrown by some functions. ## Example ```javascript var Logger = Irccd.Logger; function onLoad() { Logger.info("Major: " + Irccd.version.major); Logger.info("Minor: " + Irccd.version.minor); Logger.info("Patch: " + Irccd.version.patch); } ```