Mercurial > irccd

comparison man/irccd-api-chrono.3 @ 996:2a6d753f79f6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man: add back
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2021 22:13:01 +0100
parents 0e11221c9bcc
children ec5461750efd
comparison
equal deleted inserted replaced
995:0d71bfa6c97a 996:2a6d753f79f6
21 .Nm Irccd.Chrono 21 .Nm Irccd.Chrono
22 .Nd irccd chrono API 22 .Nd irccd chrono API
23 .\" SYNOPSIS 23 .\" SYNOPSIS
24 .Sh SYNOPSIS 24 .Sh SYNOPSIS
25 .Fn Irccd.Chrono 25 .Fn Irccd.Chrono
26 .Fn Irccd.Chrono.prototype.elapsed 26 .Fn Irccd.Chrono.prototype.reset
27 .Fn Irccd.Chrono.prototype.pause
28 .Fn Irccd.Chrono.prototype.resume
29 .Fn Irccd.Chrono.prototype.start
30 .\" DESCRIPTION 27 .\" DESCRIPTION
31 .Sh DESCRIPTION 28 .Sh DESCRIPTION
32 This module keeps track of elapsed time. 29 This module keeps track of elapsed time.
33 .\" METHODS 30 .\" METHODS
34 .Sh METHODS 31 .Sh METHODS
35 .\" Irccd.Chrono 32 .\" Irccd.Chrono
36 The 33 The
37 .Fn Irccd.Chrono 34 .Fn Irccd.Chrono
38 constructor function creates a chrono object at the current time. 35 constructor function creates a chrono object at the current time.
39 .Pp 36 .Pp
40 .\" Irccd.Chrono.prototype.elapsed 37 When constructed successfully, the object has the following properties:
38 .Pp
39 .Bl -tag -width 18n -offset indent -compact
40 .It Va elapsed No (int)
41 Return the number of milliseconds since creation or last call to
42 .El
43 .Pp
44 .\" Irccd.Chrono.prototype.reset
41 The 45 The
42 .Fn Irccd.Chrono.prototype.elapsed 46 .Fn Irccd.Chrono.prototype.reset
43 method returns the number of milliseconds elapsed since last the object was
44 started or constructed.
45 .Pp
46 .\" Irccd.Chrono.prototype.pause
47 The
48 .Fn Irccd.Chrono.prototype.pause
49 method pauses the timer, without resetting the current elapsed time stored.
50 .Pp
51 .\" Irccd.Chrono.prototype.resume
52 The
53 .Fn Irccd.Chrono.prototype.resume
54 method resume accumulating additional time. Has no effect if the timer is
55 already running.
56 .Pp
57 .\" Irccd.Chrono.prototype.start
58 The
59 .Fn Irccd.Chrono.prototype.start
60 method starts or restarts accumulating time. 47 method starts or restarts accumulating time.
61 .\" SEE ALSO 48 .\" SEE ALSO
62 .Sh SEE ALSO 49 .Sh SEE ALSO
63 .Xr irccd-api 3 50 .Xr irccd-api 3