comparison libmlk-core/core/error.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
comparison
equal deleted inserted replaced
252:95c2c4a72410 253:c4da052c0def
17 */ 17 */
18 18
19 #ifndef MOLKO_CORE_ERROR_H 19 #ifndef MOLKO_CORE_ERROR_H
20 #define MOLKO_CORE_ERROR_H 20 #define MOLKO_CORE_ERROR_H
21 21
22 /**
23 * \file error.h
24 * \brief Error routines.
25 * \ingroup basics
26 */
27
28 #include <stdarg.h> 22 #include <stdarg.h>
29 #include <stdbool.h> 23 #include <stdbool.h>
30 24
31 /**
32 * Get the last error returned.
33 *
34 * \return The error string.
35 */
36 const char * 25 const char *
37 error(void); 26 error(void);
38 27
39 /**
40 * Set the game error with a printf-like format.
41 *
42 * \pre fmt != NULL
43 * \param fmt the format string
44 * \return Always false.
45 */
46 bool 28 bool
47 errorf(const char *fmt, ...); 29 errorf(const char *fmt, ...);
48 30
49 /**
50 * Similar to \ref errorf.
51 *
52 * \pre fmt != NULL
53 * \param fmt the format stinrg
54 * \param ap the variadic arguments pointer
55 * \return Always false.
56 */
57 bool 31 bool
58 verrorf(const char *fmt, va_list ap); 32 errorva(const char *fmt, va_list ap);
59 33
60 #endif /* !MOLKO_CORE_ERROR_H */ 34 #endif /* !MOLKO_CORE_ERROR_H */