Mercurial > molko
diff src/core/error.h @ 77:837ef1d387b4
doc: improve documentation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 31 Jan 2020 13:48:27 +0100 |
parents | 6203e1ac9b18 |
children | e82eca4f8606 |
line wrap: on
line diff
--- a/src/core/error.h Fri Jan 31 13:48:16 2020 +0100 +++ b/src/core/error.h Fri Jan 31 13:48:27 2020 +0100 @@ -38,7 +38,7 @@ error(void); /** - * Convenient handler that sets last error from global C errno and then return + * Convenient helper that sets last error from global C errno and then return * false. * * \return false @@ -56,7 +56,7 @@ error_printf(const char *fmt, ...); /** - * Similar to \a error_printf. + * Similar to \ref error_printf. * * \param fmt the format stinrg * \param ap the variadic arguments pointer @@ -72,7 +72,7 @@ error_fatal(void); /** - * Prints an error to stderr and exit. + * Prints an error to stderr and exit with code 1. * * \param fmt the format string */ @@ -80,7 +80,7 @@ error_fatalf(const char *fmt, ...); /** - * Similar to \a error_fatalf + * Similar to \ref error_fatalf. * * \param fmt the format string * \param ap the variadic arguments pointer