kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-16 23:08:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge a bunch of doxygen updates to header files. This includes changes to

Browse Source 
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: https://origsvn.digium.com/svn/asterisk/trunk@75164 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2007-07-16 02:51:56 +00:00
parent 5a32541671
commit 8d1e53958c
26 changed files with 566 additions and 410 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
include/asterisk/linkedlists.h
View File

@@ -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)