src/cx/linked_list.h

changeset 855
35bcb3216c0d
parent 807
c8d692131b1e
     1.1 --- a/src/cx/linked_list.h	Thu May 23 20:29:28 2024 +0200
     1.2 +++ b/src/cx/linked_list.h	Thu May 23 20:31:37 2024 +0200
     1.3 @@ -50,9 +50,9 @@
     1.4  extern unsigned cx_linked_list_swap_sbo_size;
     1.5  
     1.6  /**
     1.7 - * Allocates a linked list for storing elements with \p item_size bytes each.
     1.8 + * Allocates a linked list for storing elements with \p elem_size bytes each.
     1.9   *
    1.10 - * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
    1.11 + * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
    1.12   * cxListStorePointers() was called immediately after creation and the compare
    1.13   * function will be automatically set to cx_cmp_ptr(), if none is given.
    1.14   *
    1.15 @@ -61,31 +61,31 @@
    1.16   * @param comparator the comparator for the elements
    1.17   * (if \c NULL, and the list is not storing pointers, sort and find
    1.18   * functions will not work)
    1.19 - * @param item_size the size of each element in bytes
    1.20 + * @param elem_size the size of each element in bytes
    1.21   * @return the created list
    1.22   */
    1.23  CxList *cxLinkedListCreate(
    1.24          CxAllocator const *allocator,
    1.25          cx_compare_func comparator,
    1.26 -        size_t item_size
    1.27 +        size_t elem_size
    1.28  );
    1.29  
    1.30  /**
    1.31 - * Allocates a linked list for storing elements with \p item_size bytes each.
    1.32 + * Allocates a linked list for storing elements with \p elem_size bytes each.
    1.33   *
    1.34   * The list will use cxDefaultAllocator and no comparator function. If you want
    1.35   * to call functions that need a comparator, you must either set one immediately
    1.36   * after list creation or use cxLinkedListCreate().
    1.37   *
    1.38 - * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
    1.39 + * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
    1.40   * cxListStorePointers() was called immediately after creation and the compare
    1.41   * function will be automatically set to cx_cmp_ptr().
    1.42   *
    1.43 - * @param item_size the size of each element in bytes
    1.44 + * @param elem_size the size of each element in bytes
    1.45   * @return the created list
    1.46   */
    1.47 -#define cxLinkedListCreateSimple(item_size) \
    1.48 -    cxLinkedListCreate(NULL, NULL, item_size)
    1.49 +#define cxLinkedListCreateSimple(elem_size) \
    1.50 +    cxLinkedListCreate(NULL, NULL, elem_size)
    1.51  
    1.52  /**
    1.53   * Finds the node at a certain index.

mercurial