Fixed up \example marker in lock.h Doxygen comment.
authorDavid M. Lee <dlee@digium.com>
Tue, 7 May 2013 18:32:34 +0000 (18:32 +0000)
committerDavid M. Lee <dlee@digium.com>
Tue, 7 May 2013 18:32:34 +0000 (18:32 +0000)
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

include/asterisk/lock.h

index cffd1a9..d7e895c 100644 (file)
@@ -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.