Improve g_cond_wait docs
authorMatthias Clasen <mclasen@redhat.com>
Fri, 4 Jan 2013 13:27:00 +0000 (08:27 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Fri, 4 Jan 2013 13:28:13 +0000 (08:28 -0500)
Document that the mutex is locked upon return.
https://bugzilla.gnome.org/show_bug.cgi?id=691110

glib/gthread-posix.c

index 68c633c..e65e437 100644 (file)
@@ -727,6 +727,8 @@ g_cond_clear (GCond *cond)
  * @mutex: a #GMutex that is currently locked
  *
  * Atomically releases @mutex and waits until @cond is signalled.
+ * When this function returns, @mutex is locked again and owned by the
+ * calling thread.
  *
  * When using condition variables, it is possible that a spurious wakeup
  * may occur (ie: g_cond_wait() returns even though g_cond_signal() was