Changeset 1ebc1a62 in mainline for uspace/app/sbi/src/intmap.c

Timestamp:

2010-03-29T20:30:29Z (15 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

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

Children:

a95310e

Parents:

5da468e

Message:

Update SBI to rev. 157.

File:

• uspace/app/sbi/src/intmap.c (modified) (4 diffs)

uspace/app/sbi/src/intmap.c

@@ -29 +29 @@
 /** @file Integer map.
  *
- * Maps integers to pointers (void *).
+ * Maps integers to pointers (void *). Current implementation is trivial
+ * (linked list of key-value pairs).
  */
 
@@ -40 +41 @@
 #include "intmap.h"
 
-/** Initialize map. */
+/** Initialize map.
+ *
+ * @param intmap        Map to initialize.
+ */
 void intmap_init(intmap_t *intmap)
 {
@@ -46 +50 @@
 }
 
-/** Set value corresponding to a key. */
+/** Set value corresponding to a key.
+ *
+ * If there already exists a mapping for @a key in the map, it is
+ * silently replaced. If @a value is @c NULL, the mapping for @a key
+ * is removed from the map.
+ *
+ * @param intmap        Map.
+ * @param key           Key (integer).
+ * @param value         Value (must be a pointer) or @c NULL.
+ */
 void intmap_set(intmap_t *intmap, int key, void *value)
 {
@@ -83 +96 @@
 }
 
-/** Get value corresponding to a key. */
+/** Get value corresponding to a key.
+ *
+ * @param intmap        Map.
+ * @param key           Key for which to retrieve mapping.
+ *
+ * @return              Value correspoding to @a key or @c NULL if no mapping
+ *                      exists.
+ */
 void *intmap_get(intmap_t *intmap, int key)
 {