aboutsummaryrefslogtreecommitdiff
path: root/src/list.h
diff options
context:
space:
mode:
authorRodrigo Arias Mallo <rodarima@gmail.com>2024-03-09 17:35:19 +0100
committerrodarima <rodarima@gmail.com>2024-03-09 18:43:51 +0100
commit4c56214b8c2e130d3709bdca2513aef20b7b0fab (patch)
treeb8cd0c6dafb5850ba116221f6f39a62e84983aa5 /src/list.h
parentbde09c45adf0daf252fafbaf87683d3ed7eaab07 (diff)
Use Doxygen comments for C files
Diffstat (limited to 'src/list.h')
-rw-r--r--src/list.h19
1 files changed, 7 insertions, 12 deletions
diff --git a/src/list.h b/src/list.h
index f98661d1..819ac1ce 100644
--- a/src/list.h
+++ b/src/list.h
@@ -1,5 +1,6 @@
-/*
- * Fast list methods
+/**
+ * @file
+ * Fast list methods.
* Feb 2000 --Jcid
*
*/
@@ -7,10 +8,8 @@
#ifndef __LIST_H__
#define __LIST_H__
-/*
- * a_List_resize()
- *
- * Make sure there's space for 'num_items' items within the list
+/**
+ * Make sure there's space for 'num_items' items within the list.
* (First, allocate an 'alloc_step' sized chunk, after that, double the
* list size --to make it faster)
*/
@@ -25,18 +24,14 @@
}
-/*
- * a_List_add()
- *
+/**
* Make sure there's space for one more item within the list.
*/
#define a_List_add(list,num_items,alloc_step) \
a_List_resize(list,num_items,alloc_step)
-/*
- * a_List_remove()
- *
+/**
* Quickly remove an item from the list
* ==> We preserve relative position, but not the element index <==
*/