diff options
Diffstat (limited to 'src/sanity.h')
-rw-r--r-- | src/sanity.h | 25 |
1 files changed, 8 insertions, 17 deletions
diff --git a/src/sanity.h b/src/sanity.h index 7480c403..6eedb08f 100644 --- a/src/sanity.h +++ b/src/sanity.h @@ -1,27 +1,18 @@ -/** \file sanity.h - Prototypes for functions for performing sanity checks on the program state -*/ - +// Prototypes for functions for performing sanity checks on the program state. #ifndef FISH_SANITY_H #define FISH_SANITY_H -/** - Call this function to tell the program it is not in a sane state. -*/ +/// Call this function to tell the program it is not in a sane state. void sanity_lose(); -/** - Perform sanity checks, return 1 if program is in a sane state 0 otherwise. -*/ +/// Perform sanity checks, return 1 if program is in a sane state 0 otherwise. int sanity_check(); -/** - Try and determine if ptr is a valid pointer. If not, loose sanity. - - \param ptr The pointer to validate - \param err A description of what the pointer refers to, for use in error messages - \param null_ok Wheter the pointer is allowed to point to 0 -*/ +/// Try and determine if ptr is a valid pointer. If not, loose sanity. +/// +/// \param ptr The pointer to validate +/// \param err A description of what the pointer refers to, for use in error messages +/// \param null_ok Wheter the pointer is allowed to point to 0 void validate_pointer(const void *ptr, const wchar_t *err, int null_ok); #endif |