[asterisk-commits] dlee: trunk r387825 - /trunk/include/asterisk/lock.h

[SVN commits to the Asterisk project]

Author: dlee
Date: Tue May  7 13:32:34 2013
New Revision: 387825

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=387825
Log:
Fixed up \example marker in lock.h Doxygen comment.

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

Modified:
    trunk/include/asterisk/lock.h

Modified: trunk/include/asterisk/lock.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/lock.h?view=diff&rev=387825&r1=387824&r2=387825
==============================================================================
--- trunk/include/asterisk/lock.h (original)
+++ trunk/include/asterisk/lock.h Tue May  7 13:32:34 2013
@@ -569,7 +569,7 @@
  * 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 @@
  *
  *     return -1;
  * }
+ * \endcode
  *
  * In the above example, neither return path requires explicit unlocking
  * of the channel.