[vlc-commits] Fix/doxify documentation

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Mon Sep 10 16:31:11 2012 +0300| [9b2ae59f9054bf2edd3d879f992d64f3551841be] | committer: Rémi Denis-Courmont

Fix/doxify documentation

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=9b2ae59f9054bf2edd3d879f992d64f3551841be
---

 src/posix/thread.c |   24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/src/posix/thread.c b/src/posix/thread.c
index 1bd519b..d5e3263 100644
--- a/src/posix/thread.c
+++ b/src/posix/thread.c
@@ -154,11 +154,9 @@ static inline unsigned long vlc_threadid (void)
 }
 
 #ifndef NDEBUG
-/*****************************************************************************
- * vlc_thread_fatal: Report an error from the threading layer
- *****************************************************************************
- * This is mostly meant for debugging.
- *****************************************************************************/
+/**
+ * Reports a fatal error from the threading layer, for debugging purposes.
+ */
 static void
 vlc_thread_fatal (const char *action, int error,
                   const char *function, const char *file, unsigned line)
@@ -210,9 +208,9 @@ vlc_thread_fatal (const char *action, int error,
 int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
 #endif
 
-/*****************************************************************************
- * vlc_mutex_init: initialize a mutex
- *****************************************************************************/
+/**
+ * Initializes a fast mutex.
+ */
 void vlc_mutex_init( vlc_mutex_t *p_mutex )
 {
     pthread_mutexattr_t attr;
@@ -234,9 +232,10 @@ void vlc_mutex_init( vlc_mutex_t *p_mutex )
     pthread_mutexattr_destroy( &attr );
 }
 
-/*****************************************************************************
- * vlc_mutex_init: initialize a recursive mutex (Do not use)
- *****************************************************************************/
+/**
+ * Initializes a recursive mutex.
+ * \warning This is strongly discouraged. Please use normal mutexes.
+ */
 void vlc_mutex_init_recursive( vlc_mutex_t *p_mutex )
 {
     pthread_mutexattr_t attr;
@@ -273,6 +272,9 @@ void vlc_mutex_destroy (vlc_mutex_t *p_mutex)
 #  define RUNNING_ON_VALGRIND (0)
 # endif
 
+/**
+ * Asserts that a mutex is locked by the calling thread.
+ */
 void vlc_assert_locked (vlc_mutex_t *p_mutex)
 {
     if (RUNNING_ON_VALGRIND > 0)