Mercurial > molko

comparison src/core/error.h @ 77:837ef1d387b4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: improve documentation
author David Demelier <markand@malikania.fr>
date Fri, 31 Jan 2020 13:48:27 +0100
parents 6203e1ac9b18
children e82eca4f8606
comparison
equal deleted inserted replaced
76:25a52025c8f5 77:837ef1d387b4
36 */ 36 */
37 const char * 37 const char *
38 error(void); 38 error(void);
39 39
40 /** 40 /**
41 * Convenient handler that sets last error from global C errno and then return 41 * Convenient helper that sets last error from global C errno and then return
42 * false. 42 * false.
43 * 43 *
44 * \return false 44 * \return false
45 */ 45 */
46 bool 46 bool
54 */ 54 */
55 bool 55 bool
56 error_printf(const char *fmt, ...); 56 error_printf(const char *fmt, ...);
57 57
58 /** 58 /**
59 * Similar to \a error_printf. 59 * Similar to \ref error_printf.
60 * 60 *
61 * \param fmt the format stinrg 61 * \param fmt the format stinrg
62 * \param ap the variadic arguments pointer 62 * \param ap the variadic arguments pointer
63 * \return false 63 * \return false
64 */ 64 */
70 */ 70 */
71 noreturn void 71 noreturn void
72 error_fatal(void); 72 error_fatal(void);
73 73
74 /** 74 /**
75 * Prints an error to stderr and exit. 75 * Prints an error to stderr and exit with code 1.
76 * 76 *
77 * \param fmt the format string 77 * \param fmt the format string
78 */ 78 */
79 noreturn void 79 noreturn void
80 error_fatalf(const char *fmt, ...); 80 error_fatalf(const char *fmt, ...);
81 81
82 /** 82 /**
83 * Similar to \a error_fatalf 83 * Similar to \ref error_fatalf.
84 * 84 *
85 * \param fmt the format string 85 * \param fmt the format string
86 * \param ap the variadic arguments pointer 86 * \param ap the variadic arguments pointer
87 */ 87 */
88 noreturn void 88 noreturn void