diff -r 5dbef9e07376 -r 11dffb40cd91 ucx/list.h --- a/ucx/list.h Fri Aug 16 12:41:30 2013 +0200 +++ b/ucx/list.h Sat Aug 17 12:04:04 2013 +0200 @@ -64,6 +64,7 @@ * @see UcxList */ typedef struct UcxList UcxList; + /** * UCX list structure. */ @@ -99,6 +100,7 @@ * @return a pointer to the copy */ UcxList *ucx_list_clone(UcxList *list, copy_func cpyfnc, void* data); + /** * Creates an element-wise copy of a list using an UcxAllocator. * @@ -152,6 +154,7 @@ * @param list the list to free */ void ucx_list_free(UcxList *list); + /** * Destroys the entire list using an UcxAllocator. * @@ -162,6 +165,7 @@ * @see ucx_list_free() */ void ucx_list_free_a(UcxAllocator *allocator, UcxList *list); + /** * Inserts an element at the end of the list. * @@ -175,6 +179,7 @@ * the newly created list otherwise */ UcxList *ucx_list_append(UcxList *list, void *data); + /** * Inserts an element at the end of the list using an UcxAllocator. * @@ -189,6 +194,7 @@ * @see ucx_list_append() */ UcxList *ucx_list_append_a(UcxAllocator *allocator, UcxList *list, void *data); + /** * Inserts an element at the beginning of the list. * @@ -204,6 +210,7 @@ * @return a pointer to the new list head */ UcxList *ucx_list_prepend(UcxList *list, void *data); + /** * Inserts an element at the beginning of the list using an UcxAllocator. * @@ -217,6 +224,7 @@ * @see ucx_list_prepend() */ UcxList *ucx_list_prepend_a(UcxAllocator *allocator, UcxList *list, void *data); + /** * Concatenates two lists. * @@ -232,6 +240,7 @@ * returned, otherwise list1 is returned */ UcxList *ucx_list_concat(UcxList *list1, UcxList *list2); + /** * Returns the first element of a list. * @@ -243,6 +252,7 @@ * @return the first element of the list, the specified element is a member of */ UcxList *ucx_list_first(const UcxList *elem); + /** * Returns the last element of a list. * @@ -254,6 +264,7 @@ * @return the last element of the list, the specified element is a member of */ UcxList *ucx_list_last(const UcxList *elem); + /** * Returns the list element at the specified index. * @@ -263,6 +274,7 @@ * index is greater than the list size */ UcxList *ucx_list_get(const UcxList *list, int index); + /** * Returns the index of an element. * @@ -272,6 +284,7 @@ * element */ ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem); + /** * Returns the element count of the list. * @@ -279,6 +292,7 @@ * @return the element count */ size_t ucx_list_size(const UcxList *list); + /** * Returns the index of an element containing the specified data. * @@ -297,6 +311,7 @@ * data is not found in this list */ ssize_t ucx_list_find(UcxList *list, void *elem, cmp_func cmpfnc, void *data); + /** * Checks, if a list contains a specific element. * @@ -340,6 +355,7 @@ * is now empty */ UcxList *ucx_list_remove(UcxList *list, UcxList *element); + /** * Removes an element from the list using an UcxAllocator. *