Mercurial > molko

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: goodbye doxygen
author David Demelier <markand@malikania.fr>
date Thu, 03 Dec 2020 09:06:52 +0100
parents 71b3b7036de7
children 08ab73b32832
comparison
equal deleted inserted replaced
252:95c2c4a72410 253:c4da052c0def
17 */ 17 */
18 18
19 #ifndef MOLKO_CORE_CLOCK_H 19 #ifndef MOLKO_CORE_CLOCK_H
20 #define MOLKO_CORE_CLOCK_H 20 #define MOLKO_CORE_CLOCK_H
21 21
22 /**
23 * \file clock.h
24 * \brief Track elapsed time.
25 * \ingroup basics
26 */
27
28 /**
29 * \brief Clock structure.
30 */
31 struct clock { 22 struct clock {
32 unsigned int ticks; /*!< (-) Time point on initialization. */ 23 unsigned int ticks;
33 }; 24 };
34 25
35 /**
36 * Start the clock and track elapsed time.
37 *
38 * \pre clock != NULL
39 * \param clock the clock
40 */
41 void 26 void
42 clock_start(struct clock *clock); 27 clock_start(struct clock *clock);
43 28
44 /**
45 * Tell the measured time.
46 *
47 * \pre clock != NULL
48 * \param clock the clock
49 * \return the elapsed time in milliseconds
50 */
51 unsigned int 29 unsigned int
52 clock_elapsed(const struct clock *clock); 30 clock_elapsed(const struct clock *clock);
53 31
54 #endif /* !MOLKO_CORE_CLOCK_H */ 32 #endif /* !MOLKO_CORE_CLOCK_H */