Changeset 70527f1 in mainline for src/time/timeout.c

Timestamp:

2005-06-03T14:51:05Z (20 years ago)

Author:

Martin Decky <martin@…>

Branches:

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

Children:

673104e

Parents:

ac5d02b

Message:

doxygen-style comments
cleanups

File:

• src/time/timeout.c (modified) (5 diffs)

src/time/timeout.c

@@ -39 +39 @@
 #include <arch.h>
 
+
+/** Initialize timeouts
+ *
+ * Initialize kernel timeouts.
+ *
+ */
 void timeout_init(void)
 {
@@ -46 +52 @@
 
 
+/** Initialize empty timeout list
+ *
+ * Initialize the timeout list to be empty.
+ *
+ * @param t Timeout list to be initialized.
+ *
+ */
 void timeout_reinitialize(timeout_t *t)
 {
@@ -55 +68 @@
 }
 
+
+/** Initialize timeout list
+ *
+ * Initialize the timeout list and its spinlock.
+ *
+ * @param t Timeout list to be initialized.
+ *
+ */
 void timeout_initialize(timeout_t *t)
 {
@@ -61 +82 @@
 }
 
-/*
- * This function registers f for execution in about time microseconds.
+
+/** Register timeout callback
+ *
+ * Insert the timeout handler f (with argument arg)
+ * to the timeout list and make it execute in
+ * time microseconds (or slightly more).
+ *
+ * @param t    Timeout list.
+ * @patam time Number of usec in the future to execute
+ *             the handler.
+ * @param f    Timeout handler function.
+ * @param arg  Timeout handler argument.
+ *
  */
 void timeout_register(timeout_t *t, __u64 time, timeout_handler f, void *arg)
@@ -122 +154 @@
 }
 
+
+/** Unregister timeout callback
+ *
+ * Remove timeout from timeout list.
+ *
+ * @param t Timeout to unregister.
+ *
+ */
 int timeout_unregister(timeout_t *t)
 {