Mercurial > irccd

annotate doc/src/api/module/Irccd.Timer/index.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.Timer/index.md@48676ca7071c
children ebdc614db066
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.Timer
260
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
3 js: true
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 Create repetitive or one-shot timers.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 ## Constants
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 The following properties are defined:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
14 - **Single**: (int) the timer is single-shot,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
15 - **Repeat**: (int) the timer is looping.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 ## Methods
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
263
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
19 - [(constructor)](Irccd.Timer.prototype.constructor.html)
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
20 - [start](Irccd.Timer.prototype.start.html)
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
21 - [stop](Irccd.Timer.prototype.stop.html)