annotate doc/src/api/module/Irccd.Timer/index.md @ 614:ebdc614db066

Docs: get rid of metadata
author David Demelier <markand@malikania.fr>
date Sun, 17 Dec 2017 09:21:49 +0100
parents bb9771fb5f44
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
614
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
1 # Module Irccd.Timer
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
614
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
3 # Usage
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 Create repetitive or one-shot timers.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
614
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
7 # Constants
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 The following properties are defined:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
11 - **Single**: (int) the timer is single-shot,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
12 - **Repeat**: (int) the timer is looping.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13
614
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
14 # Methods
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
263
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
16 - [(constructor)](Irccd.Timer.prototype.constructor.html)
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
17 - [start](Irccd.Timer.prototype.start.html)
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents: 260
diff changeset
18 - [stop](Irccd.Timer.prototype.stop.html)