Changeset 8375d0eb in mainline for uspace/app/bithenge/tree.c

Timestamp:

2012-06-08T07:02:55Z (13 years ago)

Author:

Sean Bartell <wingedtachikoma@…>

Branches:

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

Children:

8b36bf2

Parents:

5c925ce

Message:

Bithenge: add Doxygen comments

File:

• uspace/app/bithenge/tree.c (modified) (8 diffs)

uspace/app/bithenge/tree.c

@@ -47 +47 @@
 }
 
+/** Destroy a node.
+ * @memberof bithenge_node_t
+ * @param node The node to destroy.
+ * @return EOK on success or an error code from errno.h. */
 int bithenge_node_destroy(bithenge_node_t *node)
 {
@@ -61 +65 @@
                 return EOK; // the boolean nodes are allocated statically below
         case BITHENGE_NODE_INTEGER: /* pass-through */
-        case BITHENGE_NODE_NONE:
                 break;
         }
@@ -81 +84 @@
 }
 
-static int simple_internal_node_for_each(bithenge_node_t *base, bithenge_for_each_func_t func, void *data)
+static int simple_internal_node_for_each(bithenge_node_t *base,
+    bithenge_for_each_func_t func, void *data)
 {
         int rc;
@@ -121 +125 @@
 }
 
-int bithenge_new_simple_internal_node(bithenge_node_t **out, bithenge_node_t **nodes, bithenge_int_t len, bool needs_free)
+/** Create an internal node from a set of keys and values. The node must be
+ * freed with @a bithenge_node_t::bithenge_node_destroy after it is used, which
+ * will also destroy all the key and value nodes.
+ * @memberof bithenge_node_t
+ * @param[out] out Stores the created internal node.
+ * @param nodes The array of key-value pairs. Keys are stored at even indices
+ * and values are stored at odd indices.
+ * @param len The number of key-value pairs in the node array.
+ * @param needs_free If true, when the internal node is destroyed it will free
+ * the nodes array as well as destroying each node inside it.
+ * @return EOK on success or an error code from errno.h. */
+int bithenge_new_simple_internal_node(bithenge_node_t **out,
+    bithenge_node_t **nodes, bithenge_int_t len, bool needs_free)
 {
         assert(out);
@@ -139 +155 @@
 static bithenge_node_t true_node = { BITHENGE_NODE_BOOLEAN, .boolean_value = true };
 
+/** Create a boolean node. The node must be freed with @a
+ * bithenge_node_t::bithenge_node_destroy after it is used.
+ * @memberof bithenge_node_t
+ * @param[out] out Stores the created boolean node.
+ * @param value The value for the node to hold.
+ * @return EOK on success or an error code from errno.h. */
 int bithenge_new_boolean_node(bithenge_node_t **out, bool value)
 {
@@ -146 +168 @@
 }
 
+/** Create an integer node. The node must be freed with @a
+ * bithenge_node_t::bithenge_node_destroy after it is used.
+ * @memberof bithenge_node_t
+ * @param[out] out Stores the created integer node.
+ * @param value The value for the node to hold.
+ * @return EOK on success or an error code from errno.h. */
 int bithenge_new_integer_node(bithenge_node_t **out, bithenge_int_t value)
 {
@@ -158 +186 @@
 }
 
+/** Create a string node. The node must be freed with @a
+ * bithenge_node_t::bithenge_node_destroy after it is used.
+ * @memberof bithenge_node_t
+ * @param[out] out Stores the created string node.
+ * @param value The value for the node to hold.
+ * @param needs_free Whether the string should be freed when the node is
+ * destroyed.
+ * @return EOK on success or an error code from errno.h. */
 int bithenge_new_string_node(bithenge_node_t **out, const char *value, bool needs_free)
 {
@@ -170 +206 @@
         return EOK;
 }
+
+/** @}
+ */