Changeset 9179d0a in mainline for generic/src/adt

Timestamp:

2006-04-27T17:13:49Z (19 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

040e4e9

Parents:

eaa202a

Message:

Add some @file doxygen comments and improve already existing comments.

Location:

generic/src/adt

Files:

• bitmap.c (modified) (1 diff)
• btree.c (modified) (1 diff)
• hash_table.c (modified) (2 diffs)
• list.c (modified) (1 diff)

generic/src/adt/bitmap.c

@@ -25 +25 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file        bitmap.c
+ * @brief       Implementation of bitmap ADT.
+ *
+ * This file implements bitmap ADT and provides functions for
+ * setting and clearing ranges of bits.
  */
 

generic/src/adt/btree.c

@@ -27 +27 @@
  */
 
-/*
- * This B-tree has the following properties:
- * - it is a ballanced 3-4-5 tree (i.e. BTREE_M = 5)
- * - values (i.e. pointers to values) are stored only in leaves
- * - leaves are linked in a list
- * - technically, it is a B+tree (because of the previous properties)
+/**
+ * @file        btree.c
+ * @brief       B+tree implementation.
+ *
+ * This file implements B+tree type and operations.
+ *
+ * The B+tree has the following properties:
+ * @li it is a ballanced 3-4-5 tree (i.e. BTREE_M = 5)
+ * @li values (i.e. pointers to values) are stored only in leaves
+ * @li leaves are linked in a list
  *
  * Be carefull when using these trees. They need to allocate

generic/src/adt/hash_table.c

@@ -27 +27 @@
  */
 
-/*
- * This is an implementation of generic chained hash table.
+/**
+ * @file        hash_table.c
+ * @brief       Implementation of generic chained hash table.
+ *
+ * This file contains implementation of generic chained hash table.
  */
 
@@ -126 +129 @@
  * @param h Hash table.
  * @param key Array of keys that will be compared against items of the hash table.
- * @param keys Number of keys in the 'key' array.
+ * @param keys Number of keys in the key array.
  */
 void hash_table_remove(hash_table_t *h, __native key[], count_t keys)

generic/src/adt/list.c

@@ -27 +27 @@
  */
 
+/**
+ * @file        list.c
+ * @brief       Functions completing doubly linked circular list implementaion.
+ *
+ * This file contains some of the functions implementing doubly linked circular lists.
+ * However, this ADT is mostly implemented in @ref list.h.
+ */
+
 #include <adt/list.h>
-
 
 /** Check for membership