Mercurial > molko

annotate man/mlk_action_update.3 @ 469:0d6206cee6b9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: state -> mlk_state
author David Demelier <markand@malikania.fr>
date Mon, 27 Feb 2023 11:11:23 +0100
parents 31c1bbc33813
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .Dd $Mdocdate$
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .Dt MLK_ACTION_UPDATE 3
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .Os
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .Sh NAME
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .Nm mlk_action_update
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .Nd update an action
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .Sh LIBRARY
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 libmlk-core (-lmlk-core)
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .Sh SYNOPSIS
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .In mlk/core/action.h
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .Ft void
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .Fn mlk_action_update "struct mlk_action *self, unsigned int ticks"
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .Sh DESCRIPTION
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 Invoke the update callback on the action
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .Fa self
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 if it is not null.
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Sh RETURN VALUES
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 The functions return the same value as the
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .Va update
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 callback from the action and it should be non-zero if the action is considered
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 complete.
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Sh SEE ALSO
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .Xr mlk-action 3
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh AUTHORS
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 The
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Nm mlk-core
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 library was written by
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .An David Demelier Aq Mt markand@malikania.fr .