diff options
| author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-07-16 02:51:56 +0000 |
|---|---|---|
| committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-07-16 02:51:56 +0000 |
| commit | 2bf80313d6f8f29e2c9aa74c562e1d1e6c37e6a1 (patch) | |
| tree | f0062ea7e0d09f192e6cb5de75bb1491fb5809b7 /include/asterisk/linkedlists.h | |
| parent | 040609f7b5461bdd67e800aa18ad43bd590ac2e5 (diff) | |
Merge a bunch of doxygen updates to header files. This includes changes to
use the \retval tag for documenting return values, fixing various warnings
when generating the documentation, and various other things.
(closes issue #10203, snuffy)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@75164 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/linkedlists.h')
| -rw-r--r-- | include/asterisk/linkedlists.h | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/include/asterisk/linkedlists.h b/include/asterisk/linkedlists.h index 1bf933a14..fdf31c019 100644 --- a/include/asterisk/linkedlists.h +++ b/include/asterisk/linkedlists.h @@ -33,7 +33,8 @@ This macro attempts to place an exclusive lock in the list head structure pointed to by head. - Returns 0 on success, non-zero on failure + \retval 0 on success + \retval non-zero on failure */ #define AST_LIST_LOCK(head) \ ast_mutex_lock(&(head)->lock) @@ -44,7 +45,8 @@ This macro attempts to place an exclusive write lock in the list head structure pointed to by head. - Returns 0 on success, non-zero on failure + \retval 0 on success + \retval non-zero on failure */ #define AST_RWLIST_WRLOCK(head) \ ast_rwlock_wrlock(&(head)->lock) @@ -55,7 +57,8 @@ This macro attempts to place a read lock in the list head structure pointed to by head. - Returns 0 on success, non-zero on failure + \retval 0 on success + \retval non-zero on failure */ #define AST_RWLIST_RDLOCK(head) \ ast_rwlock_rdlock(&(head)->lock) @@ -66,7 +69,8 @@ This macro attempts to place an exclusive lock in the list head structure pointed to by head. - Returns 0 on success, non-zero on failure + \retval 0 on success + \retval non-zero on failure */ #define AST_LIST_TRYLOCK(head) \ ast_mutex_trylock(&(head)->lock) @@ -77,7 +81,8 @@ This macro attempts to place an exclusive write lock in the list head structure pointed to by head. - Returns 0 on success, non-zero on failure + \retval 0 on success + \retval non-zero on failure */ #define AST_RWLIST_TRYWRLOCK(head) \ ast_rwlock_trywrlock(&(head)->lock) @@ -88,7 +93,8 @@ This macro attempts to place a read lock in the list head structure pointed to by head. - Returns 0 on success, non-zero on failure + \retval 0 on success + \retval non-zero on failure */ #define AST_RWLIST_TRYRDLOCK(head) \ ast_rwlock_tryrdlock(&(head)->lock) @@ -408,7 +414,8 @@ struct { \ \brief Checks whether the specified list contains any entries. \param head This is a pointer to the list head structure - Returns non-zero if the list has entries, zero if not. + \return non-zero if the list has entries + \return zero if not. */ #define AST_LIST_EMPTY(head) (AST_LIST_FIRST(head) == NULL) |