Fixed up \example marker in lock.h Doxygen comment.

The \example tags marks an entire file as an example, not a code snippet.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@387825 65c4cc65-6c06-0410-ace0-fbb531ad65f3
changes/78/78/1
David M. Lee 12 years ago
parent dd87bea808
commit a61060cf41

@ -569,7 +569,7 @@ static void __attribute__((destructor)) fini_##rwlock(void) \
* the lock. When the lock goes out of scope, it will automatically
* be unlocked.
*
* \example
* \code
* int some_function(struct ast_channel *chan)
* {
* SCOPED_LOCK(lock, chan, ast_channel_lock, ast_channel_unlock);
@ -580,6 +580,7 @@ static void __attribute__((destructor)) fini_##rwlock(void) \
*
* return -1;
* }
* \endcode
*
* In the above example, neither return path requires explicit unlocking
* of the channel.

Loading…
Cancel
Save