summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorDavid M. Lee <dlee@digium.com>2013-05-07 18:32:34 +0000
committerDavid M. Lee <dlee@digium.com>2013-05-07 18:32:34 +0000
commita61060cf41ba4eced0120122ca447f114f791359 (patch)
tree072b559a97f554bb061d440c9a18f2e6c5ea24a9 /include
parentdd87bea808a04e7a42f72515c32b29d6c9f2b7ea (diff)
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
Diffstat (limited to 'include')
-rw-r--r--include/asterisk/lock.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/asterisk/lock.h b/include/asterisk/lock.h
index cffd1a9ac..d7e895c77 100644
--- a/include/asterisk/lock.h
+++ b/include/asterisk/lock.h
@@ -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.