Changeset df364582 in mainline

Timestamp:

2005-10-02T18:07:35Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

1e2aecca

Parents:

63975c6

Message:

Doxygen-style comments for condvar.c.

File:

• src/synch/condvar.c (modified) (4 diffs)

src/synch/condvar.c

@@ -27 +27 @@
  */
 
-#include <synch/synch.h>
 #include <synch/condvar.h>
 #include <synch/mutex.h>
 #include <synch/waitq.h>
+#include <synch/synch.h>
 
+/** Initialize condition variable
+ *
+ * Initialize condition variable.
+ *
+ * @param cv Condition variable.
+ */
 void condvar_initialize(condvar_t *cv)
 {
@@ -37 +43 @@
 }
 
+/** Signal the condition has become true
+ *
+ * Signal the condition has become true
+ * to the first waiting thread by waking it up.
+ *
+ * @param Condition variable.
+ */
 void condvar_signal(condvar_t *cv)
 {
@@ -42 +55 @@
 }
 
+/** Signal the condition has become true
+ *
+ * Signal the condition has become true
+ * to all waiting threads by waking them up.
+ *
+ * @param Condition variable.
+ */
 void condvar_broadcast(condvar_t *cv)
 {
@@ -47 +67 @@
 }
 
+/** Wait for the condition becoming true
+ *
+ * Wait for the condition becoming true.
+ *
+ * @param Condition variable.
+ */
 int _condvar_wait_timeout(condvar_t *cv, mutex_t *mtx, __u32 usec, int trywait)
 {