diff options
author | Russell Bryant <russell@russellbryant.com> | 2005-10-24 20:12:06 +0000 |
---|---|---|
committer | Russell Bryant <russell@russellbryant.com> | 2005-10-24 20:12:06 +0000 |
commit | 3453e3efa54bd013beb4c5bfcaf05df1f10d6798 (patch) | |
tree | b3ba750361c8145e6c629b37179fb9f1750094b4 /include/asterisk/utils.h | |
parent | c3226a226a57e71f608b1990bff4ee48c836bde0 (diff) |
Doxygen documentation update from oej (issue #5505)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6847 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/utils.h')
-rwxr-xr-x | include/asterisk/utils.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/include/asterisk/utils.h b/include/asterisk/utils.h index cd2098d94..e0c32597d 100755 --- a/include/asterisk/utils.h +++ b/include/asterisk/utils.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Utility functions +/*! \file + * \brief Utility functions */ #ifndef _ASTERISK_UTILS_H @@ -34,7 +34,9 @@ #include "asterisk/time.h" #include "asterisk/strings.h" -/* Note: +/*! \note + \verbatim + Note: It is very important to use only unsigned variables to hold bit flags, as otherwise you can fall prey to the compiler's sign-extension antics if you try to use the top two bits in @@ -46,13 +48,13 @@ type of variable, a warning message similar to this: warning: comparison of distinct pointer types lacks cast - will be generated. The "dummy" variable below is used to make these comparisons. Also note that at -O2 or above, this type-safety checking does _not_ produce any additional object code at all. + \endverbatim */ extern unsigned int __unsigned_int_flags_dummy; |