Changeset 7f0837c in mainline for generic/src/synch/futex.c

Timestamp:

2006-04-24T12:59:11Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

fd8af4b

Parents:

24f3874

Message:

Remove the outdated TODO file.
Improve doxygen comments here and there.

File:

• generic/src/synch/futex.c (modified) (2 diffs)

generic/src/synch/futex.c

@@ -94 +94 @@
  * @param uaddr Userspace address of the futex counter.
  * @param usec If non-zero, number of microseconds this thread is willing to sleep.
- * @param trydown If usec is zero and trydown is non-zero, conditional operation will be attempted.
+ * @param trydown If @usec is zero and trydown is non-zero, conditional operation will be attempted.
  *
  * @return One of ESYNCH_TIMEOUT, ESYNCH_OK_ATOMIC and ESYNCH_OK_BLOCKED. See synch.h.
@@ -219 +219 @@
 /** Compute hash index into futex hash table.
  *
+ * @param key Address where the @key (i.e. physical address of futex counter) is stored.
+ *
+ * @return Index into futex hash table.
+ */
+index_t futex_ht_hash(__native *key)
+{
+        return *key & (FUTEX_HT_SIZE-1);
+}
+
+/** Compare futex hash table item with a key.
+ *
  * @param key Address where the key (i.e. physical address of futex counter) is stored.
  *
- * @return Index into futex hash table.
- */
-index_t futex_ht_hash(__native *key)
-{
-        return *key & (FUTEX_HT_SIZE-1);
-}
-
-/** Compare futex hash table item with a key.
- *
- * @param key Address where the key (i.e. physical address of futex counter) is stored.
- *
- * @return True if the item matches the key. False otherwise.
+ * @return True if the item matches the @key. False otherwise.
  */
 bool futex_ht_compare(__native *key, count_t keys, link_t *item)