[vlc-commits] threads: improve Doxygen

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sat Feb  8 17:41:04 2020 +0200| [ee81f68131185700309f6646134445f18d7875fc] | committer: Rémi Denis-Courmont

threads: improve Doxygen

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

 include/vlc_threads.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/include/vlc_threads.h b/include/vlc_threads.h
index 8a39c61087..2e85d63d6b 100644
--- a/include/vlc_threads.h
+++ b/include/vlc_threads.h
@@ -686,10 +686,10 @@ VLC_API void *vlc_threadvar_get(vlc_threadvar_t);
 /**
  * Waits on an address.
  *
- * Puts the calling thread to sleep if a specific value is stored at a
- * specified address. The thread will sleep until it is woken up by a call to
- * vlc_atomic_notify_one() or vlc_atomic_notify_all() in another thread, or
- * spuriously.
+ * Puts the calling thread to sleep if a specific unsigned 32-bits value is
+ * stored at a specified address. The thread will sleep until it is woken up by
+ * a call to vlc_atomic_notify_one() or vlc_atomic_notify_all() in another
+ * thread, or spuriously.
  *
  * If the value does not match, do nothing and return immediately.
  *
@@ -709,8 +709,8 @@ void vlc_atomic_wait(void *addr, unsigned val);
  * \param val value to match at the address
  * \param delay time-out duration
  *
- * \return true if the function was woken up before the time-out,
- * false if the time-out elapsed.
+ * \retval true the function was woken up before the time-out
+ * \retval false the time-out elapsed
  */
 bool vlc_atomic_timedwait(void *addr, unsigned val, vlc_tick_t delay);