summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-27 03:59:44 -0400
committerChris Michael <cp.michael@samsung.com>2018-07-27 03:59:44 -0400
commit49554b2b6c993aa2067e86a0eb158f47fc15c3f0 (patch)
treeb34fd675d81a68f76083637bddbfd6d2531e00e4 /src/lib/eina
parentbe33c835ac30fcf45d33bd65e932b05b43aab00d (diff)
eina: Add doxygen in/out tags for lalloc and list
Reviewers: devilhorns Reviewed By: devilhorns Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6688
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_lalloc.h18
-rw-r--r--src/lib/eina/eina_list.h206
2 files changed, 112 insertions, 112 deletions
diff --git a/src/lib/eina/eina_lalloc.h b/src/lib/eina/eina_lalloc.h
index 087cdaeffe..114d0a9eae 100644
--- a/src/lib/eina/eina_lalloc.h
+++ b/src/lib/eina/eina_lalloc.h
@@ -53,7 +53,7 @@ typedef Eina_Bool (*Eina_Lalloc_Alloc)(void *user_data, int num);
53typedef void (*Eina_Lalloc_Free)(void *user_data); 53typedef void (*Eina_Lalloc_Free)(void *user_data);
54/** 54/**
55 * @def EINA_LALLOC_FREE 55 * @def EINA_LALLOC_FREE
56 * @param function The function to free. 56 * @param[in] function The function to free.
57 */ 57 */
58#define EINA_LALLOC_FREE(function) ((Eina_Lalloc_Free)function) 58#define EINA_LALLOC_FREE(function) ((Eina_Lalloc_Free)function)
59 59
@@ -67,10 +67,10 @@ typedef struct _Eina_Lalloc Eina_Lalloc;
67/** 67/**
68 * @brief Creates a new lazy allocator. 68 * @brief Creates a new lazy allocator.
69 * 69 *
70 * @param data The data for which memory will be allocated. 70 * @param[in] data The data for which memory will be allocated.
71 * @param alloc_cb The callback to allocate memory for @p data items. 71 * @param[in] alloc_cb The callback to allocate memory for @p data items.
72 * @param free_cb The callback to free memory for @p data items. 72 * @param[in] free_cb The callback to free memory for @p data items.
73 * @param num_init The number of @p data items to initially allocate space for. 73 * @param[in] num_init The number of @p data items to initially allocate space for.
74 * 74 *
75 * @return A new lazy allocator. 75 * @return A new lazy allocator.
76 * 76 *
@@ -83,7 +83,7 @@ EAPI Eina_Lalloc *eina_lalloc_new(void *data,
83/** 83/**
84 * @brief Frees the resources for a lazy allocator. 84 * @brief Frees the resources for a lazy allocator.
85 * 85 *
86 * @param a The lazy allocator to free. 86 * @param[in,out] a The lazy allocator to free.
87 * 87 *
88 */ 88 */
89EAPI void eina_lalloc_free(Eina_Lalloc *a) EINA_ARG_NONNULL(1); 89EAPI void eina_lalloc_free(Eina_Lalloc *a) EINA_ARG_NONNULL(1);
@@ -91,8 +91,8 @@ EAPI void eina_lalloc_free(Eina_Lalloc *a) EINA_ARG_NONNULL(1);
91/** 91/**
92 * @brief Adds several elements to a lazy allocator. 92 * @brief Adds several elements to a lazy allocator.
93 * 93 *
94 * @param a The lazy allocator to add items to. 94 * @param[in,out] a The lazy allocator to add items to.
95 * @param num The number of elements to add. 95 * @param[in] num The number of elements to add.
96 * 96 *
97 * @return #EINA_TRUE on success, else #EINA_FALSE. 97 * @return #EINA_TRUE on success, else #EINA_FALSE.
98 * 98 *
@@ -103,7 +103,7 @@ EAPI Eina_Bool eina_lalloc_elements_add(Eina_Lalloc *a,
103/** 103/**
104 * @brief Allocates one more of whatever the lazy allocator is allocating. 104 * @brief Allocates one more of whatever the lazy allocator is allocating.
105 * 105 *
106 * @param a The lazy allocator to add an item to. 106 * @param[in,out] a The lazy allocator to add an item to.
107 * 107 *
108 * @return #EINA_TRUE on success, else #EINA_FALSE. 108 * @return #EINA_TRUE on success, else #EINA_FALSE.
109 * 109 *
diff --git a/src/lib/eina/eina_list.h b/src/lib/eina/eina_list.h
index 985dfc1bc4..9216b5dde1 100644
--- a/src/lib/eina/eina_list.h
+++ b/src/lib/eina/eina_list.h
@@ -344,8 +344,8 @@ struct _Eina_List_Accounting
344/** 344/**
345 * @brief Appends the given data to the given linked list. 345 * @brief Appends the given data to the given linked list.
346 * 346 *
347 * @param list The given list. 347 * @param[in,out] list The given list.
348 * @param data The data to append. 348 * @param[in] data The data to append.
349 * @return A list pointer, or @c NULL on error. 349 * @return A list pointer, or @c NULL on error.
350 * 350 *
351 * This function appends @p data to @p list. If @p list is @c NULL, a 351 * This function appends @p data to @p list. If @p list is @c NULL, a
@@ -371,8 +371,8 @@ EAPI Eina_List *eina_list_append(Eina_List *list, const void *data) E
371/** 371/**
372 * @brief Prepends the given data to the given linked list. 372 * @brief Prepends the given data to the given linked list.
373 * 373 *
374 * @param list The given list. 374 * @param[in,out] list The given list.
375 * @param data The data to prepend. 375 * @param[in] data The data to prepend.
376 * @return A list pointer, or @c NULL on error. 376 * @return A list pointer, or @c NULL on error.
377 * 377 *
378 * This function prepends @p data to @p list. If @p list is @c NULL, a 378 * This function prepends @p data to @p list. If @p list is @c NULL, a
@@ -399,9 +399,9 @@ EAPI Eina_List *eina_list_prepend(Eina_List *list, const void *data)
399/** 399/**
400 * @brief Inserts the given data into the given linked list after the specified data. 400 * @brief Inserts the given data into the given linked list after the specified data.
401 * 401 *
402 * @param list The given linked list. 402 * @param[in,out] list The given linked list.
403 * @param data The data to insert. 403 * @param[in] data The data to insert.
404 * @param relative The data to insert after. 404 * @param[in] relative The data to insert after.
405 * @return A list pointer, or @c NULL on error. 405 * @return A list pointer, or @c NULL on error.
406 * 406 *
407 * This function inserts @p data into @p list after @p relative. If 407 * This function inserts @p data into @p list after @p relative. If
@@ -432,9 +432,9 @@ EAPI Eina_List *eina_list_append_relative(Eina_List *list, const void
432/** 432/**
433 * @brief Appends a list node to a linked list after the specified member. 433 * @brief Appends a list node to a linked list after the specified member.
434 * 434 *
435 * @param list The given linked list. 435 * @param[in,out] list The given linked list.
436 * @param data The data to insert. 436 * @param[in] data The data to insert.
437 * @param relative The list node to insert after. 437 * @param[in] relative The list node to insert after.
438 * @return A list pointer, or @c NULL on error. 438 * @return A list pointer, or @c NULL on error.
439 * 439 *
440 * This function inserts @p data into @p list after the list node 440 * This function inserts @p data into @p list after the list node
@@ -454,9 +454,9 @@ EAPI Eina_List *eina_list_append_relative_list(Eina_List *list, const
454/** 454/**
455 * @brief Prepends a data pointer to a linked list before the specified member. 455 * @brief Prepends a data pointer to a linked list before the specified member.
456 * 456 *
457 * @param list The given linked list. 457 * @param[in,out] list The given linked list.
458 * @param data The data to insert. 458 * @param[in] data The data to insert.
459 * @param relative The member that data will be inserted before. 459 * @param[in] relative The member that data will be inserted before.
460 * @return A list pointer, or @c NULL on error. 460 * @return A list pointer, or @c NULL on error.
461 * 461 *
462 * This function inserts @p data to @p list before @p relative. If 462 * This function inserts @p data to @p list before @p relative. If
@@ -487,9 +487,9 @@ EAPI Eina_List *eina_list_prepend_relative(Eina_List *list, const voi
487/** 487/**
488 * @brief Prepends a list node to a linked list before the specified member. 488 * @brief Prepends a list node to a linked list before the specified member.
489 * 489 *
490 * @param list The given linked list. 490 * @param[in,out] list The given linked list.
491 * @param data The data to insert. 491 * @param[in] data The data to insert.
492 * @param relative The list node to insert before. 492 * @param[in] relative The list node to insert before.
493 * @return A list pointer, or @c NULL on error. 493 * @return A list pointer, or @c NULL on error.
494 * 494 *
495 * This function inserts @p data to @p list before the list node 495 * This function inserts @p data to @p list before the list node
@@ -509,9 +509,9 @@ EAPI Eina_List *eina_list_prepend_relative_list(Eina_List *list, cons
509/** 509/**
510 * @brief Inserts a new node into a sorted list. 510 * @brief Inserts a new node into a sorted list.
511 * 511 *
512 * @param list The given linked list, @b must be sorted. 512 * @param[in,out] list The given linked list, @b must be sorted.
513 * @param func The function called for the sort. 513 * @param[in] func The function called for the sort.
514 * @param data The data to be inserted in sorted order. 514 * @param[in] data The data to be inserted in sorted order.
515 * @return A list pointer, or @c NULL on error. 515 * @return A list pointer, or @c NULL on error.
516 * 516 *
517 * This function inserts values into a linked list assuming it was 517 * This function inserts values into a linked list assuming it was
@@ -535,8 +535,8 @@ EAPI Eina_List *eina_list_sorted_insert(Eina_List *list, Eina_Compare
535/** 535/**
536 * @brief Removes the first instance of the specified data from the given list. 536 * @brief Removes the first instance of the specified data from the given list.
537 * 537 *
538 * @param list The given list. 538 * @param[in,out] list The given list.
539 * @param data The specified data. 539 * @param[in] data The specified data.
540 * @return A list pointer, or @c NULL on error. 540 * @return A list pointer, or @c NULL on error.
541 * 541 *
542 * This function removes the first instance of @p data from @p list. If 542 * This function removes the first instance of @p data from @p list. If
@@ -553,8 +553,8 @@ EAPI Eina_List *eina_list_remove(Eina_List *list, const void *data) E
553/** 553/**
554 * @brief Removes the specified list node. 554 * @brief Removes the specified list node.
555 * 555 *
556 * @param list The given linked list. 556 * @param[in,out] list The given linked list.
557 * @param remove_list The list node which is to be removed. 557 * @param[in] remove_list The list node which is to be removed.
558 * @return A list pointer, or @c NULL on error. 558 * @return A list pointer, or @c NULL on error.
559 * 559 *
560 * This function removes the list node @p remove_list from @p list and 560 * This function removes the list node @p remove_list from @p list and
@@ -591,8 +591,8 @@ EAPI Eina_List *eina_list_remove_list(Eina_List *list, Eina_List *rem
591/** 591/**
592 * @brief Moves the specified data to the head of the list. 592 * @brief Moves the specified data to the head of the list.
593 * 593 *
594 * @param list The given linked list. 594 * @param[in,out] list The given linked list.
595 * @param move_list The list node to move. 595 * @param[in] move_list The list node to move.
596 * @return A new list handle to replace the old one, or @c NULL on error. 596 * @return A new list handle to replace the old one, or @c NULL on error.
597 * 597 *
598 * This function moves @p move_list to the front of @p list. If list is 598 * This function moves @p move_list to the front of @p list. If list is
@@ -625,8 +625,8 @@ EAPI Eina_List *eina_list_promote_list(Eina_List *list, Eina_List *mo
625/** 625/**
626 * @brief Moves the specified data to the tail of the list. 626 * @brief Moves the specified data to the tail of the list.
627 * 627 *
628 * @param list The given linked list. 628 * @param[in,out] list The given linked list.
629 * @param move_list The list node to move. 629 * @param[in] move_list The list node to move.
630 * @return A new list handle to replace the old one, or @c NULL on error. 630 * @return A new list handle to replace the old one, or @c NULL on error.
631 * 631 *
632 * This function move @p move_list to the end of @p list. If list is @c 632 * This function move @p move_list to the end of @p list. If list is @c
@@ -659,8 +659,8 @@ EAPI Eina_List *eina_list_demote_list(Eina_List *list, Eina_List *mov
659/** 659/**
660 * @brief Finds a member of a list and returns it. 660 * @brief Finds a member of a list and returns it.
661 * 661 *
662 * @param list The linked list to search. 662 * @param[in] list The linked list to search.
663 * @param data The data member to find in the list. 663 * @param[in] data The data member to find in the list.
664 * @return The data member pointer if found, or @c NULL otherwise. 664 * @return The data member pointer if found, or @c NULL otherwise.
665 * 665 *
666 * This function searches in @p list from beginning to end for the 666 * This function searches in @p list from beginning to end for the
@@ -686,8 +686,8 @@ EAPI void *eina_list_data_find(const Eina_List *list, const void
686/** 686/**
687 * @brief Finds a member of a list and returns it as a list node. 687 * @brief Finds a member of a list and returns it as a list node.
688 * 688 *
689 * @param list The list to search for data. 689 * @param[in] list The list to search for data.
690 * @param data The data pointer to find in the list. 690 * @param[in] data The data pointer to find in the list.
691 * @return A list node containing the data member on success, @c NULL 691 * @return A list node containing the data member on success, @c NULL
692 * otherwise. 692 * otherwise.
693 * 693 *
@@ -704,9 +704,9 @@ EAPI Eina_List *eina_list_data_find_list(const Eina_List *list, const
704/** 704/**
705 * @brief Moves a data pointer from one list to another. 705 * @brief Moves a data pointer from one list to another.
706 * 706 *
707 * @param to The list to move the data to. 707 * @param[in,out] to The list to move the data to.
708 * @param from The list to move from. 708 * @param[in,out] from The list to move from.
709 * @param data The data member to move. 709 * @param[in] data The data member to move.
710 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 710 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
711 * 711 *
712 * This function is a shortcut for doing the following: 712 * This function is a shortcut for doing the following:
@@ -721,9 +721,9 @@ EAPI Eina_Bool eina_list_move(Eina_List **to, Eina_List **from, void
721/** 721/**
722 * @brief Moves a list node from one list to another. 722 * @brief Moves a list node from one list to another.
723 * 723 *
724 * @param to The list to move the data to. 724 * @param[in,out] to The list to move the data to.
725 * @param from The list to move from. 725 * @param[in,out] from The list to move from.
726 * @param data The list node containing the data to move. 726 * @param[in] data The list node containing the data to move.
727 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 727 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
728 * 728 *
729 * This function is a shortcut for doing the following: 729 * This function is a shortcut for doing the following:
@@ -738,7 +738,7 @@ EAPI Eina_Bool eina_list_move_list(Eina_List **to, Eina_List **from,
738/** 738/**
739 * @brief Frees an entire list and all the nodes, ignoring the data contained. 739 * @brief Frees an entire list and all the nodes, ignoring the data contained.
740 740
741 * @param list The list to free. 741 * @param[in,out] list The list to free.
742 * @return A @c NULL pointer. 742 * @return A @c NULL pointer.
743 * 743 *
744 * This function frees all the nodes of @p list. It does not free the 744 * This function frees all the nodes of @p list. It does not free the
@@ -750,8 +750,8 @@ EAPI Eina_List *eina_list_free(Eina_List *list);
750 * @brief Gets the nth member's data pointer in a list, or @c NULL on 750 * @brief Gets the nth member's data pointer in a list, or @c NULL on
751 * error. 751 * error.
752 * 752 *
753 * @param list The list to get the specified member number from. 753 * @param[in] list The list to get the specified member number from.
754 * @param n The number of the element (0 being the first). 754 * @param[in] n The number of the element (0 being the first).
755 * @return The data pointer stored in the specified element. 755 * @return The data pointer stored in the specified element.
756 * 756 *
757 * This function returns the data pointer of element number @p n, in 757 * This function returns the data pointer of element number @p n, in
@@ -768,8 +768,8 @@ EAPI void *eina_list_nth(const Eina_List *list, unsigned int n)
768/** 768/**
769 * @brief Gets the nth member's list node in a list. 769 * @brief Gets the nth member's list node in a list.
770 * 770 *
771 * @param list The list to get the specified member number from. 771 * @param[in] list The list to get the specified member number from.
772 * @param n The number of the element (0 being the first). 772 * @param[in] n The number of the element (0 being the first).
773 * @return The list node stored in the numbered element, or @c NULL on 773 * @return The list node stored in the numbered element, or @c NULL on
774 * error. 774 * error.
775 * 775 *
@@ -790,7 +790,7 @@ EAPI Eina_List *eina_list_nth_list(const Eina_List *list, unsigned in
790/** 790/**
791 * @brief Reverses all the elements in the list. 791 * @brief Reverses all the elements in the list.
792 * 792 *
793 * @param list The list to reverse. 793 * @param[in,out] list The list to reverse.
794 * @return The list head after it has been reversed, or @c NULL on 794 * @return The list head after it has been reversed, or @c NULL on
795 * error. 795 * error.
796 * 796 *
@@ -812,7 +812,7 @@ EAPI Eina_List *eina_list_reverse(Eina_List *list) EINA_WARN_UNUSED_R
812/** 812/**
813 * @brief Clones (copies) all the elements in the list in reverse order. 813 * @brief Clones (copies) all the elements in the list in reverse order.
814 * 814 *
815 * @param list The list to reverse. 815 * @param[in] list The list to reverse.
816 * @return The new list that has been reversed, or @c NULL on error. 816 * @return The new list that has been reversed, or @c NULL on error.
817 * 817 *
818 * This function reverses the order of all elements in @p list, so the 818 * This function reverses the order of all elements in @p list, so the
@@ -833,7 +833,7 @@ EAPI Eina_List *eina_list_reverse_clone(const Eina_List *list) EINA_W
833/** 833/**
834 * @brief Clones (copies) all the elements in the list in exactly same order. 834 * @brief Clones (copies) all the elements in the list in exactly same order.
835 * 835 *
836 * @param list The list to clone. 836 * @param[in] list The list to clone.
837 * @return The new list that has been cloned, or @c NULL on error. 837 * @return The new list that has been cloned, or @c NULL on error.
838 * 838 *
839 * This function clone in order of all elements in @p list. If @p list 839 * This function clone in order of all elements in @p list. If @p list
@@ -853,9 +853,9 @@ EAPI Eina_List *eina_list_clone(const Eina_List *list) EINA_WARN_UNUS
853/** 853/**
854 * @brief Sorts a list according to the ordering func will return. 854 * @brief Sorts a list according to the ordering func will return.
855 * 855 *
856 * @param list The list handle to sort. 856 * @param[in] list The list handle to sort.
857 * @param limit The maximum number of list elements to sort. 857 * @param[in] limit The maximum number of list elements to sort.
858 * @param func A function pointer that can handle comparing the list data 858 * @param[in] func A function pointer that can handle comparing the list data
859 * nodes. 859 * nodes.
860 * @return The new head of list. 860 * @return The new head of list.
861 * 861 *
@@ -896,8 +896,8 @@ EAPI Eina_List *eina_list_sort(Eina_List *list, unsigned int limit, E
896/** 896/**
897 * @brief Shuffles list. 897 * @brief Shuffles list.
898 * 898 *
899 * @param list The list handle to shuffle. 899 * @param[in] list The list handle to shuffle.
900 * @param func A function pointer that can return an int between 2 inclusive values 900 * @param[in] func A function pointer that can return an int between 2 inclusive values
901 * @return The new head of list. 901 * @return The new head of list.
902 * 902 *
903 * This function shuffles @p list. 903 * This function shuffles @p list.
@@ -917,8 +917,8 @@ EAPI Eina_List *eina_list_shuffle(Eina_List *list, Eina_Random_Cb fun
917/** 917/**
918 * @brief Merges two list. 918 * @brief Merges two list.
919 * 919 *
920 * @param left Head list to merge. 920 * @param[in] left Head list to merge.
921 * @param right Tail list to merge. 921 * @param[in] right Tail list to merge.
922 * @return A new merged list. 922 * @return A new merged list.
923 * 923 *
924 * This function puts right at the end of left and returns the head. 924 * This function puts right at the end of left and returns the head.
@@ -937,9 +937,9 @@ EAPI Eina_List *eina_list_merge(Eina_List *left, Eina_List *right) EI
937/** 937/**
938 * @brief Merges two sorted list according to the ordering func will return. 938 * @brief Merges two sorted list according to the ordering func will return.
939 * 939 *
940 * @param left First list to merge. 940 * @param[in] left First list to merge.
941 * @param right Second list to merge. 941 * @param[in] right Second list to merge.
942 * @param func A function pointer that can handle comparing the list data 942 * @param[in] func A function pointer that can handle comparing the list data
943 * nodes. 943 * nodes.
944 * @return A new sorted list. 944 * @return A new sorted list.
945 * 945 *
@@ -977,9 +977,9 @@ EAPI Eina_List *eina_list_sorted_merge(Eina_List *left, Eina_List *ri
977/** 977/**
978 * @brief Splits a list into 2 lists. 978 * @brief Splits a list into 2 lists.
979 * 979 *
980 * @param list List to split. 980 * @param[in] list List to split.
981 * @param relative The list will be split after @p relative. 981 * @param[in] relative The list will be split after @p relative.
982 * @param right The head of the new right list. 982 * @param[out] right The head of the new right list.
983 * @return The new left list 983 * @return The new left list
984 * 984 *
985 * This function splits @p list into two lists ( left and right ) after the node @p relative. @p Relative 985 * This function splits @p list into two lists ( left and right ) after the node @p relative. @p Relative
@@ -997,10 +997,10 @@ EAPI Eina_List *eina_list_split_list(Eina_List *list, Eina_List *rela
997/** 997/**
998 * @brief Returns node nearest to data from the sorted list. 998 * @brief Returns node nearest to data from the sorted list.
999 * 999 *
1000 * @param list The list to search for data, @b must be sorted. 1000 * @param[in] list The list to search for data, @b must be sorted.
1001 * @param func A function pointer that can handle comparing the list data nodes. 1001 * @param[in] func A function pointer that can handle comparing the list data nodes.
1002 * @param data reference value to search. 1002 * @param[in] data reference value to search.
1003 * @param result_cmp If provided returns the result of 1003 * @param[out] result_cmp If provided returns the result of
1004 * func(node->data, data) node being the last (returned) node. If node 1004 * func(node->data, data) node being the last (returned) node. If node
1005 * was found (exact match), then it is 0. If returned node is smaller 1005 * was found (exact match), then it is 0. If returned node is smaller
1006 * than requested data, it is less than 0 and if it's bigger it's 1006 * than requested data, it is less than 0 and if it's bigger it's
@@ -1059,9 +1059,9 @@ EAPI Eina_List *eina_list_search_sorted_near_list(const Eina_List *li
1059/** 1059/**
1060 * @brief Returns node if data is in the sorted list. 1060 * @brief Returns node if data is in the sorted list.
1061 * 1061 *
1062 * @param list The list to search for data, @b must be sorted. 1062 * @param[in] list The list to search for data, @b must be sorted.
1063 * @param func A function pointer that can handle comparing the list data nodes. 1063 * @param[in] func A function pointer that can handle comparing the list data nodes.
1064 * @param data reference value to search. 1064 * @param[in] data reference value to search.
1065 * @return The node if func(node->data, data) == 0, @c NULL if not found. 1065 * @return The node if func(node->data, data) == 0, @c NULL if not found.
1066 * 1066 *
1067 * This can be used to check if some value is inside the list and get 1067 * This can be used to check if some value is inside the list and get
@@ -1095,9 +1095,9 @@ EAPI Eina_List *eina_list_search_sorted_list(const Eina_List *list, E
1095/** 1095/**
1096 * @brief Returns node data if it is in the sorted list. 1096 * @brief Returns node data if it is in the sorted list.
1097 * 1097 *
1098 * @param list The list to search for data, @b must be sorted. 1098 * @param[in] list The list to search for data, @b must be sorted.
1099 * @param func A function pointer that can handle comparing the list data nodes. 1099 * @param[in] func A function pointer that can handle comparing the list data nodes.
1100 * @param data reference value to search. 1100 * @param[in] data reference value to search.
1101 * @return The node value (@c node->data) if func(node->data, data) == 0, 1101 * @return The node value (@c node->data) if func(node->data, data) == 0,
1102 * @c NULL if not found. 1102 * @c NULL if not found.
1103 * 1103 *
@@ -1131,9 +1131,9 @@ EAPI void *eina_list_search_sorted(const Eina_List *list, Eina_C
1131/** 1131/**
1132 * @brief Returns node if data is in the unsorted list. 1132 * @brief Returns node if data is in the unsorted list.
1133 * 1133 *
1134 * @param list The list to search for data, may be unsorted. 1134 * @param[in] list The list to search for data, may be unsorted.
1135 * @param func A function pointer that can handle comparing the list data nodes. 1135 * @param[in] func A function pointer that can handle comparing the list data nodes.
1136 * @param data reference value to search. 1136 * @param[in] data reference value to search.
1137 * @return The node if func(node->data, data) == 0, @c NULL if not found. 1137 * @return The node if func(node->data, data) == 0, @c NULL if not found.
1138 * 1138 *
1139 * This can be used to check if some value is inside the list and get 1139 * This can be used to check if some value is inside the list and get
@@ -1157,9 +1157,9 @@ EAPI Eina_List *eina_list_search_unsorted_list(const Eina_List *list,
1157/** 1157/**
1158 * @brief Returns node data if it is in the unsorted list. 1158 * @brief Returns node data if it is in the unsorted list.
1159 * 1159 *
1160 * @param list The list to search for data, may be unsorted. 1160 * @param[in] list The list to search for data, may be unsorted.
1161 * @param func A function pointer that can handle comparing the list data nodes. 1161 * @param[in] func A function pointer that can handle comparing the list data nodes.
1162 * @param data reference value to search. 1162 * @param[in] data reference value to search.
1163 * @return The node value (@c node->data) if func(node->data, data) == 0, 1163 * @return The node value (@c node->data) if func(node->data, data) == 0,
1164 * @c NULL if not found. 1164 * @c NULL if not found.
1165 * 1165 *
@@ -1184,7 +1184,7 @@ EAPI void *eina_list_search_unsorted(const Eina_List *list, Eina
1184/** 1184/**
1185 * @brief Gets the last list node in the list. 1185 * @brief Gets the last list node in the list.
1186 * 1186 *
1187 * @param list The list to get the last list node from. 1187 * @param[in] list The list to get the last list node from.
1188 * @return The last list node in the list. 1188 * @return The last list node in the list.
1189 * 1189 *
1190 * This function returns the last list node in the list @p list. If 1190 * This function returns the last list node in the list @p list. If
@@ -1201,7 +1201,7 @@ static inline Eina_List *eina_list_last(const Eina_List *list) EINA_PURE EINA_
1201/** 1201/**
1202 * @brief Gets the next list node after the specified list node. 1202 * @brief Gets the next list node after the specified list node.
1203 * 1203 *
1204 * @param list The list node to get the next list node from 1204 * @param[in] list The list node to get the next list node from
1205 * @return The next list node on success, @c NULL otherwise. 1205 * @return The next list node on success, @c NULL otherwise.
1206 * 1206 *
1207 * This function returns the next list node after the current one in 1207 * This function returns the next list node after the current one in
@@ -1216,7 +1216,7 @@ static inline Eina_List *eina_list_next(const Eina_List *list) EINA_PURE EINA_
1216/** 1216/**
1217 * @brief Gets the list node prior to the specified list node. 1217 * @brief Gets the list node prior to the specified list node.
1218 * 1218 *
1219 * @param list The list node to get the previous list node from. 1219 * @param[in] list The list node to get the previous list node from.
1220 * @return The previous list node on success, @c NULL otherwise. 1220 * @return The previous list node on success, @c NULL otherwise.
1221 * 1221 *
1222 * This function returns the previous list node before the current one 1222 * This function returns the previous list node before the current one
@@ -1231,7 +1231,7 @@ static inline Eina_List *eina_list_prev(const Eina_List *list) EINA_PURE EINA_
1231/** 1231/**
1232 * @brief Gets the list node data member. 1232 * @brief Gets the list node data member.
1233 * 1233 *
1234 * @param list The list node to get the data member of. 1234 * @param[in] list The list node to get the data member of.
1235 * @return The data member from the list node. 1235 * @return The data member from the list node.
1236 * 1236 *
1237 * This function returns the data member of the specified list node @p 1237 * This function returns the data member of the specified list node @p
@@ -1246,8 +1246,8 @@ static inline void *eina_list_data_get(const Eina_List *list) EINA_PURE E
1246/** 1246/**
1247 * @brief Sets the list node data member. 1247 * @brief Sets the list node data member.
1248 * 1248 *
1249 * @param list The list node to set the data member of. 1249 * @param[in,out] list The list node to set the data member of.
1250 * @param data The data to be set. 1250 * @param[in] data The data to be set.
1251 * @return The previous data value. 1251 * @return The previous data value.
1252 * 1252 *
1253 * This function sets the data member @p data of the specified list node 1253 * This function sets the data member @p data of the specified list node
@@ -1262,7 +1262,7 @@ static inline void *eina_list_data_set(Eina_List *list, const void *data)
1262/** 1262/**
1263 * @brief Gets the count of the number of items in a list. 1263 * @brief Gets the count of the number of items in a list.
1264 * 1264 *
1265 * @param list The list whose count to return. 1265 * @param[in] list The list whose count to return.
1266 * @return The number of members in the list. 1266 * @return The number of members in the list.
1267 * 1267 *
1268 * This function returns the quantity of members that @p list 1268 * This function returns the quantity of members that @p list
@@ -1279,7 +1279,7 @@ static inline unsigned int eina_list_count(const Eina_List *list) EINA_PURE;
1279/** 1279/**
1280 * @brief Returns the last list node's data. 1280 * @brief Returns the last list node's data.
1281 * 1281 *
1282 * @param list The list. 1282 * @param[in] list The list.
1283 * @return The node's data, or @c NULL on being passed a @c NULL pointer 1283 * @return The node's data, or @c NULL on being passed a @c NULL pointer
1284 * 1284 *
1285 * This function is a shortcut for typing eina_list_data_get(eina_list_last()) 1285 * This function is a shortcut for typing eina_list_data_get(eina_list_last())
@@ -1291,7 +1291,7 @@ static inline void *eina_list_last_data_get(const Eina_List *list);
1291/** 1291/**
1292 * @brief Returns a new iterator associated with a list. 1292 * @brief Returns a new iterator associated with a list.
1293 * 1293 *
1294 * @param list The list. 1294 * @param[in] list The list.
1295 * @return A new iterator, or @c NULL on memory allocation failure. 1295 * @return A new iterator, or @c NULL on memory allocation failure.
1296 * 1296 *
1297 * This function returns a newly allocated iterator associated with @p 1297 * This function returns a newly allocated iterator associated with @p
@@ -1312,7 +1312,7 @@ EAPI Eina_Iterator *eina_list_iterator_new(const Eina_List *list) EINA_MA
1312/** 1312/**
1313 * @brief Returns a new reversed iterator associated with a list. 1313 * @brief Returns a new reversed iterator associated with a list.
1314 * 1314 *
1315 * @param list The list. 1315 * @param[in] list The list.
1316 * @return A new iterator, or @c NULL on memory allocation failure. 1316 * @return A new iterator, or @c NULL on memory allocation failure.
1317 * 1317 *
1318 * This function returns a newly allocated iterator associated with @p 1318 * This function returns a newly allocated iterator associated with @p
@@ -1335,7 +1335,7 @@ EAPI Eina_Iterator *eina_list_iterator_reversed_new(const Eina_List *list
1335/** 1335/**
1336 * @brief Returns a new accessor associated with a list. 1336 * @brief Returns a new accessor associated with a list.
1337 * 1337 *
1338 * @param list The list. 1338 * @param[in] list The list.
1339 * @return A new accessor, or @c NULL on error. 1339 * @return A new accessor, or @c NULL on error.
1340 * 1340 *
1341 * This function returns a newly allocated accessor associated with 1341 * This function returns a newly allocated accessor associated with
@@ -1352,8 +1352,8 @@ EAPI Eina_Accessor *eina_list_accessor_new(const Eina_List *list) EINA_MA
1352/** 1352/**
1353 * @brief Finds the member of the list and returns the index. 1353 * @brief Finds the member of the list and returns the index.
1354 * 1354 *
1355 * @param list The list. 1355 * @param[in] list The list.
1356 * @param data The data member. 1356 * @param[in] data The data member.
1357 * @return The index of data member if found, @c -1 otherwise. 1357 * @return The index of data member if found, @c -1 otherwise.
1358 * 1358 *
1359 * This function searches in @p list from beginning to end for the 1359 * This function searches in @p list from beginning to end for the
@@ -1371,9 +1371,9 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1371 * @def EINA_LIST_FOREACH 1371 * @def EINA_LIST_FOREACH
1372 * @brief Definition for the macro to iterate over a list. 1372 * @brief Definition for the macro to iterate over a list.
1373 * 1373 *
1374 * @param list The list to iterate over. 1374 * @param[in] list The list to iterate over.
1375 * @param l A list that is used as an iterator and points to the current node. 1375 * @param[out] l A list that is used as an iterator and points to the current node.
1376 * @param data Current item's data. 1376 * @param[out] data Current item's data.
1377 * 1377 *
1378 * This macro iterates over @p list from the first element to 1378 * This macro iterates over @p list from the first element to
1379 * the last. @p data is the data related to the current element. 1379 * the last. @p data is the data related to the current element.
@@ -1432,9 +1432,9 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1432 * @def EINA_LIST_REVERSE_FOREACH 1432 * @def EINA_LIST_REVERSE_FOREACH
1433 * @brief Definition for the macro to iterate over a list in the reverse order. 1433 * @brief Definition for the macro to iterate over a list in the reverse order.
1434 * 1434 *
1435 * @param list The list to iterate over. 1435 * @param[in] list The list to iterate over.
1436 * @param l A list that is used as an iterator and points to the current node. 1436 * @param[out] l A list that is used as an iterator and points to the current node.
1437 * @param data Current item's data. 1437 * @param[out] data Current item's data.
1438 * 1438 *
1439 * This macro works like EINA_LIST_FOREACH, but iterates from the 1439 * This macro works like EINA_LIST_FOREACH, but iterates from the
1440 * last element of a list to the first. 1440 * last element of a list to the first.
@@ -1492,10 +1492,10 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1492 * @def EINA_LIST_FOREACH_SAFE 1492 * @def EINA_LIST_FOREACH_SAFE
1493 * @brief Definition for the macro to iterate over a list with support for node deletion. 1493 * @brief Definition for the macro to iterate over a list with support for node deletion.
1494 * 1494 *
1495 * @param list The list to iterate over. 1495 * @param[in] list The list to iterate over.
1496 * @param l A list that is used as an iterator and points to the current node. 1496 * @param[out] l A list that is used as an iterator and points to the current node.
1497 * @param l_next A list that is used as an iterator and points to the next node. 1497 * @param[out] l_next A list that is used as an iterator and points to the next node.
1498 * @param data Current item's data. 1498 * @param[out] data Current item's data.
1499 * 1499 *
1500 * This macro iterates over @p list from the first element to 1500 * This macro iterates over @p list from the first element to
1501 * the last. @p data is the data related to the current element. 1501 * the last. @p data is the data related to the current element.
@@ -1552,10 +1552,10 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1552 * @brief Definition for the macro to iterate over a list in the reverse order with support 1552 * @brief Definition for the macro to iterate over a list in the reverse order with support
1553 * for deletion. 1553 * for deletion.
1554 * 1554 *
1555 * @param list The list to iterate over. 1555 * @param[in] list The list to iterate over.
1556 * @param l A list that is used as an iterator and points to the current node. 1556 * @param[out] l A list that is used as an iterator and points to the current node.
1557 * @param l_prev A list that is used as an iterator and points to the previous node. 1557 * @param[out] l_prev A list that is used as an iterator and points to the previous node.
1558 * @param data Current item's data. 1558 * @param[out] data Current item's data.
1559 * 1559 *
1560 * This macro works like EINA_LIST_FOREACH_SAFE, but iterates from the 1560 * This macro works like EINA_LIST_FOREACH_SAFE, but iterates from the
1561 * last element of a list to the first. 1561 * last element of a list to the first.
@@ -1612,8 +1612,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1612 * @def EINA_LIST_FREE 1612 * @def EINA_LIST_FREE
1613 * @brief Definition for the macro to remove each list node while having access to each node's data. 1613 * @brief Definition for the macro to remove each list node while having access to each node's data.
1614 * 1614 *
1615 * @param list The list that will be cleared. 1615 * @param[in,out] list The list that will be cleared.
1616 * @param data Current node's data. 1616 * @param[out] data Current node's data.
1617 * 1617 *
1618 * This macro will call #eina_list_remove_list for each list node, and store 1618 * This macro will call #eina_list_remove_list for each list node, and store
1619 * the data contained in the current node in @p data. 1619 * the data contained in the current node in @p data.