Mercurial > irccd

annotate doc/html/api/module/Irccd/index.md @ 0:1158cffe5a5e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 070a1ece2af6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 module: Irccd
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 Contains general irccd variables and functions.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 ## Constants
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 The following properties are defined:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 - **version**: (object)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 - **major**: (int) the major irccd version,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 - **minor**: (int) the minor irccd version,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 - **patch**: (int) the patch irccd version.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 ## Example
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 ````javascript
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 var Logger = Irccd.Logger;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 function onLoad()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 Logger.info("Major: " + Irccd.version.major);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 Logger.info("Minor: " + Irccd.version.minor);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 Logger.info("Patch: " + Irccd.version.patch);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 end
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 ````