annotate libmlk-core/core/clock.h @ 253:c4da052c0def

core: goodbye doxygen
author David Demelier <markand@malikania.fr>
date Thu, 03 Dec 2020 09:06:52 +0100
parents 71b3b7036de7
children 08ab73b32832
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * clock.h -- track elapsed time
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
19 #ifndef MOLKO_CORE_CLOCK_H
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
20 #define MOLKO_CORE_CLOCK_H
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 struct clock {
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
23 unsigned int ticks;
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 };
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 void
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 clock_start(struct clock *clock);
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
29 unsigned int
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 clock_elapsed(const struct clock *clock);
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
32 #endif /* !MOLKO_CORE_CLOCK_H */