Changeset 0784869 in mainline for uspace/lib/bithenge/tree.h

Timestamp:

2012-08-20T17:32:00Z (13 years ago)

Author:

Sean Bartell <wingedtachikoma@…>

Branches:

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

Children:

1f136a27

Parents:

1a3b953

Message:

Bithenge: improve Doxygen documentation

File:

• uspace/lib/bithenge/tree.h (modified) (5 diffs)

uspace/lib/bithenge/tree.h

@@ -56 +56 @@
 } bithenge_node_type_t;
 
+/** A tree node. It can have any of the types in @a bithenge_node_type_t. */
 typedef struct bithenge_node_t {
         /** @privatesection */
@@ -61 +62 @@
         unsigned int refs;
         union {
+                /** @privatesection */
                 const struct bithenge_internal_node_ops_t *internal_ops;
                 bool boolean_value;
                 bithenge_int_t integer_value;
                 struct {
+                        /** @privatesection */
                         const char *ptr;
                         bool needs_free;
@@ -111 +114 @@
 }
 
+/** @memberof bithenge_node_t */
 void bithenge_node_dec_ref(bithenge_node_t *node);
 
@@ -126 +130 @@
 }
 
+/** @memberof bithenge_node_t */
 int bithenge_node_get(bithenge_node_t *, bithenge_node_t *,
     bithenge_node_t **);
@@ -159 +164 @@
 }
 
+/** @memberof bithenge_node_t */
 int bithenge_init_internal_node(bithenge_node_t *,
     const bithenge_internal_node_ops_t *);
+/** @memberof bithenge_node_t */
 int bithenge_new_empty_internal_node(bithenge_node_t **);
+/** @memberof bithenge_node_t */
 int bithenge_new_simple_internal_node(bithenge_node_t **, bithenge_node_t **,
     bithenge_int_t, bool needs_free);
+/** @memberof bithenge_node_t */
 int bithenge_new_boolean_node(bithenge_node_t **, bool);
+/** @memberof bithenge_node_t */
 int bithenge_new_integer_node(bithenge_node_t **, bithenge_int_t);
+/** @memberof bithenge_node_t */
 int bithenge_new_string_node(bithenge_node_t **, const char *, bool);
+/** @memberof bithenge_node_t */
 int bithenge_node_equal(bool *, bithenge_node_t *, bithenge_node_t *);