[vlc-commits] vlc_addr_wait: clarify documentation

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Fri Aug  5 23:44:46 2016 +0300| [526705c394fb4f7e158d5adde83a411b3189809d] | committer: Rémi Denis-Courmont

vlc_addr_wait: clarify documentation

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

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

diff --git a/include/vlc_threads.h b/include/vlc_threads.h
index 4581c24..9ef4e3e 100644
--- a/include/vlc_threads.h
+++ b/include/vlc_threads.h
@@ -624,8 +624,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. If the value does not match, do nothing and return
- * immediately.
+ * specified address. The thread will sleep until it is woken up by a call to
+ * vlc_addr_signal() or vlc_addr_broadcast() in another thread, or spuriously.
+ *
+ * If the value does not match, do nothing and return immediately.
  *
  * \param addr address to check for
  * \param val value to match at the address