summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-26 20:04:46 +0900
committerHermet Park <hermetpark@gmail.com>2018-07-26 20:04:46 +0900
commitff5cc5d988006616406a65b8119ea6499b7b8bf6 (patch)
tree45cdfc69ad5200ca949b6f193d1ecaac2d823ca2
parente4f823934fa2f31169581eb3c0e5ee8fab7df8dd (diff)
eina: Add doxygen in/out tags for inlist and iterator
Reviewers: segfaultxavi Subscribers: segfaultxavi, cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6686
-rw-r--r--src/lib/eina/eina_inlist.h122
-rw-r--r--src/lib/eina/eina_iterator.h32
2 files changed, 80 insertions, 74 deletions
diff --git a/src/lib/eina/eina_inlist.h b/src/lib/eina/eina_inlist.h
index 25260d1afa..0d20286639 100644
--- a/src/lib/eina/eina_inlist.h
+++ b/src/lib/eina/eina_inlist.h
@@ -430,8 +430,8 @@ struct _Eina_Inlist
430 * check of @a new_l prev and next pointers is done, so it's safe 430 * check of @a new_l prev and next pointers is done, so it's safe
431 * to have them uninitialized. 431 * to have them uninitialized.
432 * 432 *
433 * @param in_list Existing list head or @c NULL to create a new list. 433 * @param[in,out] in_list Existing list head or @c NULL to create a new list.
434 * @param in_item New list node, must not be @c NULL. 434 * @param[in] in_item New list node, must not be @c NULL.
435 * 435 *
436 * @return The new list head. Use it and not @a in_list anymore. 436 * @return The new list head. Use it and not @a in_list anymore.
437 */ 437 */
@@ -449,8 +449,8 @@ EAPI Eina_Inlist *eina_inlist_append(Eina_Inlist *in_list,
449 * check of @a new_l prev and next pointers is done, so it's safe 449 * check of @a new_l prev and next pointers is done, so it's safe
450 * to have them uninitialized. 450 * to have them uninitialized.
451 * 451 *
452 * @param in_list Existing list head or @c NULL to create a new list. 452 * @param[in,out] in_list Existing list head or @c NULL to create a new list.
453 * @param in_item New list node, must not be @c NULL. 453 * @param[in] in_item New list node, must not be @c NULL.
454 * 454 *
455 * @return The new list head. Use it and not @a in_list anymore. 455 * @return The new list head. Use it and not @a in_list anymore.
456 */ 456 */
@@ -473,9 +473,9 @@ EAPI Eina_Inlist *eina_inlist_prepend(Eina_Inlist *in_list,
473 * will lead to problems. Giving NULL @a in_relative is the same as 473 * will lead to problems. Giving NULL @a in_relative is the same as
474 * eina_list_append(). 474 * eina_list_append().
475 * 475 *
476 * @param in_list Existing list head or @c NULL to create a new list. 476 * @param[in,out] in_list Existing list head or @c NULL to create a new list.
477 * @param in_item New list node, must not be @c NULL. 477 * @param[in] in_item New list node, must not be @c NULL.
478 * @param in_relative Reference node, @a in_item will be added after it. 478 * @param[in] in_relative Reference node, @a in_item will be added after it.
479 * 479 *
480 * @return The new list head. Use it and not @a list anymore. 480 * @return The new list head. Use it and not @a list anymore.
481 */ 481 */
@@ -499,9 +499,9 @@ EAPI Eina_Inlist *eina_inlist_append_relative(Eina_Inlist *in_list,
499 * will lead to problems. Giving NULL @a in_relative is the same as 499 * will lead to problems. Giving NULL @a in_relative is the same as
500 * eina_list_prepend(). 500 * eina_list_prepend().
501 * 501 *
502 * @param in_list Existing list head or @c NULL to create a new list. 502 * @param[in,out] in_list Existing list head or @c NULL to create a new list.
503 * @param in_item New list node, must not be @c NULL. 503 * @param[in] in_item New list node, must not be @c NULL.
504 * @param in_relative Reference node, @a in_item will be added before it. 504 * @param[in] in_relative Reference node, @a in_item will be added before it.
505 * 505 *
506 * @return The new list head. Use it and not @a in_list anymore. 506 * @return The new list head. Use it and not @a in_list anymore.
507 */ 507 */
@@ -521,8 +521,8 @@ EAPI Eina_Inlist *eina_inlist_prepend_relative(Eina_Inlist *in_list,
521 * it will be different from @a list and the wrong new head will 521 * it will be different from @a list and the wrong new head will
522 * be returned. 522 * be returned.
523 * 523 *
524 * @param in_list Existing list head, must not be @c NULL. 524 * @param[in,out] in_list Existing list head, must not be @c NULL.
525 * @param in_item Existing list node, must not be @c NULL. 525 * @param[in] in_item Existing list node, must not be @c NULL.
526 * 526 *
527 * @return The new list head. Use it and not @a list anymore. 527 * @return The new list head. Use it and not @a list anymore.
528 */ 528 */
@@ -535,8 +535,8 @@ EAPI Eina_Inlist *eina_inlist_remove(Eina_Inlist *in_list,
535 * @warning This is an expensive call and has O(n) cost, possibly 535 * @warning This is an expensive call and has O(n) cost, possibly
536 * walking the whole list. 536 * walking the whole list.
537 * 537 *
538 * @param in_list Existing list to search @a in_item in, must not be @c NULL. 538 * @param[in] in_list Existing list to search @a in_item in, must not be @c NULL.
539 * @param in_item What to search for, must not be @c NULL. 539 * @param[in] in_item What to search for, must not be @c NULL.
540 * 540 *
541 * @return @a in_item if found, @c NULL if not. 541 * @return @a in_item if found, @c NULL if not.
542 */ 542 */
@@ -553,8 +553,8 @@ EAPI Eina_Inlist *eina_inlist_find(Eina_Inlist *in_list,
553 * done to confirm this, and giving nodes from different lists 553 * done to confirm this, and giving nodes from different lists
554 * will lead to problems. 554 * will lead to problems.
555 * 555 *
556 * @param list Existing list head or @c NULL to create a new list. 556 * @param[in] list Existing list head or @c NULL to create a new list.
557 * @param item List node to move to beginning (head), must not be @c NULL. 557 * @param[in] item List node to move to beginning (head), must not be @c NULL.
558 * 558 *
559 * @return The new list head. Use it and not @a list anymore. 559 * @return The new list head. Use it and not @a list anymore.
560 */ 560 */
@@ -571,8 +571,8 @@ EAPI Eina_Inlist *eina_inlist_promote(Eina_Inlist *list,
571 * done to confirm this, and giving nodes from different lists 571 * done to confirm this, and giving nodes from different lists
572 * will lead to problems. 572 * will lead to problems.
573 * 573 *
574 * @param list Existing list head or @c NULL to create a new list. 574 * @param[in] list Existing list head or @c NULL to create a new list.
575 * @param item List node to move to end (tail), must not be @c NULL. 575 * @param[in] item List node to move to end (tail), must not be @c NULL.
576 * 576 *
577 * @return The new list head. Use it and not @a list anymore. 577 * @return The new list head. Use it and not @a list anymore.
578 */ 578 */
@@ -582,7 +582,7 @@ EAPI Eina_Inlist *eina_inlist_demote(Eina_Inlist *list,
582/** 582/**
583 * @brief Gets the first list node in the list. 583 * @brief Gets the first list node in the list.
584 * 584 *
585 * @param list The list to get the first list node from. 585 * @param[in] list The list to get the first list node from.
586 * @return The first list node in the list. 586 * @return The first list node in the list.
587 * 587 *
588 * This function returns the first list node in the list @p list. If 588 * This function returns the first list node in the list @p list. If
@@ -598,7 +598,7 @@ static inline Eina_Inlist *eina_inlist_first(const Eina_Inlist *list) EINA_PURE
598/** 598/**
599 * @brief Gets the last list node in the list. 599 * @brief Gets the last list node in the list.
600 * 600 *
601 * @param list The list to get the last list node from. 601 * @param[in] list The list to get the last list node from.
602 * @return The last list node in the list. 602 * @return The last list node in the list.
603 * 603 *
604 * This function returns the last list node in the list @p list. If 604 * This function returns the last list node in the list @p list. If
@@ -614,7 +614,7 @@ static inline Eina_Inlist *eina_inlist_last(const Eina_Inlist *list) EINA_PURE E
614/** 614/**
615 * @brief Gets the count of the number of items in a list. 615 * @brief Gets the count of the number of items in a list.
616 * 616 *
617 * @param list The list whose count to return. 617 * @param[in] list The list whose count to return.
618 * @return The number of members in the list. 618 * @return The number of members in the list.
619 * 619 *
620 * This function returns how many members @p list contains. If the 620 * This function returns how many members @p list contains. If the
@@ -630,7 +630,7 @@ EAPI unsigned int eina_inlist_count(const Eina_Inlist *list) EINA_WARN_UNUSED_
630/** 630/**
631 * @brief Returns a new iterator associated to @a list. 631 * @brief Returns a new iterator associated to @a list.
632 * 632 *
633 * @param in_list The list. 633 * @param[in] in_list The list.
634 * @return A new iterator. 634 * @return A new iterator.
635 * 635 *
636 * This function returns a newly allocated iterator associated to @p 636 * This function returns a newly allocated iterator associated to @p
@@ -651,7 +651,7 @@ EAPI Eina_Iterator *eina_inlist_iterator_new(const Eina_Inlist *in_list) EINA_MA
651/** 651/**
652 * @brief Returns a new accessor associated to a list. 652 * @brief Returns a new accessor associated to a list.
653 * 653 *
654 * @param in_list The list. 654 * @param[in] in_list The list.
655 * @return A new accessor. 655 * @return A new accessor.
656 * 656 *
657 * This function returns a newly allocated accessor associated to 657 * This function returns a newly allocated accessor associated to
@@ -665,11 +665,10 @@ EAPI Eina_Accessor *eina_inlist_accessor_new(const Eina_Inlist *in_list) EINA_MA
665/** 665/**
666 * @brief Inserts a new node into a sorted list. 666 * @brief Inserts a new node into a sorted list.
667 * 667 *
668 * @param list The given linked list, @b must be sorted. 668 * @param[in,out] list The given linked list, @b must be sorted.
669 * @param item List node to insert, must not be @c NULL. 669 * @param[in] item List node to insert, must not be @c NULL.
670 * @param func The function called for the sort. 670 * @param[in] func The function called for the sort.
671 * @return A list pointer. 671 * @return A list pointer.
672 * @since 1.1.0
673 * 672 *
674 * This function inserts item into a linked list assuming it was 673 * This function inserts item into a linked list assuming it was
675 * sorted and the result will be sorted. If @p list is @c NULL, item 674 * sorted and the result will be sorted. If @p list is @c NULL, item
@@ -682,6 +681,8 @@ EAPI Eina_Accessor *eina_inlist_accessor_new(const Eina_Inlist *in_list) EINA_MA
682 * lists do not have O(1) access time, so walking to the correct node 681 * lists do not have O(1) access time, so walking to the correct node
683 * can be costly, consider worst case to be almost O(n) pointer 682 * can be costly, consider worst case to be almost O(n) pointer
684 * dereference (list walk). 683 * dereference (list walk).
684 *
685 * @since 1.1.0
685 */ 686 */
686EAPI Eina_Inlist *eina_inlist_sorted_insert(Eina_Inlist *list, Eina_Inlist *item, Eina_Compare_Cb func) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT; 687EAPI Eina_Inlist *eina_inlist_sorted_insert(Eina_Inlist *list, Eina_Inlist *item, Eina_Compare_Cb func) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT;
687 688
@@ -689,6 +690,7 @@ EAPI Eina_Inlist *eina_inlist_sorted_insert(Eina_Inlist *list, Eina_Inlist *item
689 * @brief Creates state with valid data in it. 690 * @brief Creates state with valid data in it.
690 * 691 *
691 * @return A valid Eina_Inlist_Sorted_State. 692 * @return A valid Eina_Inlist_Sorted_State.
693 *
692 * @since 1.1.0 694 * @since 1.1.0
693 * 695 *
694 * See eina_inlist_sorted_state_insert() for more information. 696 * See eina_inlist_sorted_state_insert() for more information.
@@ -698,9 +700,10 @@ EAPI Eina_Inlist_Sorted_State *eina_inlist_sorted_state_new(void);
698/** 700/**
699 * @brief Forces an Eina_Inlist_Sorted_State to match the content of a list. 701 * @brief Forces an Eina_Inlist_Sorted_State to match the content of a list.
700 * 702 *
701 * @param state The state to update 703 * @param[in,out] state The state to update
702 * @param list The list to match 704 * @param[in] list The list to match
703 * @return The number of item in the actually in the list 705 * @return The number of item in the actually in the list
706 *
704 * @since 1.1.0 707 * @since 1.1.0
705 * 708 *
706 * See eina_inlist_sorted_state_insert() for more information. This function is 709 * See eina_inlist_sorted_state_insert() for more information. This function is
@@ -712,7 +715,8 @@ EAPI int eina_inlist_sorted_state_init(Eina_Inlist_Sorted_State *state, Eina_Inl
712/** 715/**
713 * @brief Frees an Eina_Inlist_Sorted_State. 716 * @brief Frees an Eina_Inlist_Sorted_State.
714 * 717 *
715 * @param state The state to destroy 718 * @param[in,out] state The state to destroy
719 *
716 * @since 1.1.0 720 * @since 1.1.0
717 * 721 *
718 * See eina_inlist_sorted_state_insert() for more information. 722 * See eina_inlist_sorted_state_insert() for more information.
@@ -722,10 +726,10 @@ EAPI void eina_inlist_sorted_state_free(Eina_Inlist_Sorted_State *state);
722/** 726/**
723 * @brief Inserts a new node into a sorted list. 727 * @brief Inserts a new node into a sorted list.
724 * 728 *
725 * @param list The given linked list, @b must be sorted. 729 * @param[in,out] list The given linked list, @b must be sorted.
726 * @param item list node to insert, must not be @c NULL. 730 * @param[in] item list node to insert, must not be @c NULL.
727 * @param func The function called for the sort. 731 * @param[in] func The function called for the sort.
728 * @param state The current array for initial dichotomic search 732 * @param[in,out] state The current array for initial dichotomic search
729 * @return A list pointer. 733 * @return A list pointer.
730 * @since 1.1.0 734 * @since 1.1.0
731 * 735 *
@@ -754,8 +758,8 @@ EAPI Eina_Inlist *eina_inlist_sorted_state_insert(Eina_Inlist *list,
754/** 758/**
755 * @brief Sorts a list according to the ordering func will return. 759 * @brief Sorts a list according to the ordering func will return.
756 * 760 *
757 * @param head The list handle to sort. 761 * @param[in,out] head The list handle to sort.
758 * @param func A function pointer that can handle comparing the list data 762 * @param[in] func A function pointer that can handle comparing the list data
759 * nodes. 763 * nodes.
760 * @return the new head of list. 764 * @return the new head of list.
761 * 765 *
@@ -800,15 +804,15 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
800/* These two macros are helpers for the _FOREACH ones, don't use them */ 804/* These two macros are helpers for the _FOREACH ones, don't use them */
801/** 805/**
802 * @def _EINA_INLIST_OFFSET 806 * @def _EINA_INLIST_OFFSET
803 * @param ref The reference to be used. 807 * @param[in,out] ref The reference to be used.
804 */ 808 */
805#define _EINA_INLIST_OFFSET(ref) ((char *)&(ref)->__in_list - (char *)(ref)) 809#define _EINA_INLIST_OFFSET(ref) ((char *)&(ref)->__in_list - (char *)(ref))
806 810
807#if !defined(__cplusplus) 811#if !defined(__cplusplus)
808/** 812/**
809 * @def _EINA_INLIST_CONTAINER 813 * @def _EINA_INLIST_CONTAINER
810 * @param ref The reference to be used. 814 * @param[in,out] ref The reference to be used.
811 * @param ptr The pointer to be used. 815 * @param[out] ptr The pointer to be used.
812 */ 816 */
813#define _EINA_INLIST_CONTAINER(ref, ptr) (void *)((char *)(ptr) - \ 817#define _EINA_INLIST_CONTAINER(ref, ptr) (void *)((char *)(ptr) - \
814 _EINA_INLIST_OFFSET(ref)) 818 _EINA_INLIST_OFFSET(ref))
@@ -823,9 +827,9 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
823 827
824/** 828/**
825 * @def EINA_INLIST_FOREACH 829 * @def EINA_INLIST_FOREACH
826 * @param list The list to iterate on. 830 * @param[in,out] list The list to iterate on.
827 * @param it The pointer to the list item, i.e. a pointer to each item 831 * @param[out] it The pointer to the list item, i.e. a pointer to each
828 * that is part of the list. 832 * item that is part of the list.
829 */ 833 */
830#define EINA_INLIST_FOREACH(list, it) \ 834#define EINA_INLIST_FOREACH(list, it) \
831 for (it = NULL, it = (list ? _EINA_INLIST_CONTAINER(it, list) : NULL); it; \ 835 for (it = NULL, it = (list ? _EINA_INLIST_CONTAINER(it, list) : NULL); it; \
@@ -833,13 +837,14 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
833 837
834/** 838/**
835 * @def EINA_INLIST_FOREACH_SAFE 839 * @def EINA_INLIST_FOREACH_SAFE
836 * @param list The list to iterate on. 840 * @param[in,out] list The list to iterate on.
837 * @param list2 Auxiliary Eina_Inlist variable so we can save the pointer to the 841 * @param[out] list2 Auxiliary Eina_Inlist variable so we can save the
838 * next element, allowing us to free/remove the current one. Note that this 842 * pointer to the next element, allowing us to free/remove
839 * macro is only safe if the next element is not removed. Only the current one 843 * the current one. Note that this macro is only safe if the
840 * is allowed to be removed. 844 * next element is not removed. Only the current one is
841 * @param it The pointer to the list item, i.e. a pointer to each item 845 * allowed to be removed.
842 * that is part of the list. 846 * @param[out] it The pointer to the list item, i.e. a pointer to each
847 * item that is part of the list.
843 */ 848 */
844#define EINA_INLIST_FOREACH_SAFE(list, list2, it) \ 849#define EINA_INLIST_FOREACH_SAFE(list, list2, it) \
845 for (it = NULL, it = (list ? _EINA_INLIST_CONTAINER(it, list) : NULL), list2 = it ? EINA_INLIST_GET(it)->next : NULL; \ 850 for (it = NULL, it = (list ? _EINA_INLIST_CONTAINER(it, list) : NULL), list2 = it ? EINA_INLIST_GET(it)->next : NULL; \
@@ -848,9 +853,9 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
848 853
849/** 854/**
850 * @def EINA_INLIST_REVERSE_FOREACH 855 * @def EINA_INLIST_REVERSE_FOREACH
851 * @param list The list to traverse in reverse order. 856 * @param[in,out] list The list to traverse in reverse order.
852 * @param it The pointer to the list item, i.e. a pointer to each item 857 * @param[out] it The pointer to the list item, i.e. a pointer to each
853 * that is part of the list. 858 * item that is part of the list.
854 */ 859 */
855#define EINA_INLIST_REVERSE_FOREACH(list, it) \ 860#define EINA_INLIST_REVERSE_FOREACH(list, it) \
856 for (it = NULL, it = (list ? _EINA_INLIST_CONTAINER(it, list->last) : NULL); \ 861 for (it = NULL, it = (list ? _EINA_INLIST_CONTAINER(it, list->last) : NULL); \
@@ -858,10 +863,11 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
858 863
859/** 864/**
860 * @def EINA_INLIST_REVERSE_FOREACH_FROM 865 * @def EINA_INLIST_REVERSE_FOREACH_FROM
861 * @param list The last list to traverse in reverse order. 866 * @param[in,out] list The last list to traverse in reverse order.
862 * @param it The pointer to the list item, i.e. a pointer to each item 867 * @param[in] it The pointer to the list item, i.e. a pointer to each
863 * that is part of the list. 868 * item that is part of the list.
864 * @see EINA_INLIST_REVERSE_FOREACH() 869 * @see EINA_INLIST_REVERSE_FOREACH()
870 *
865 * @since 1.8 871 * @since 1.8
866 * 872 *
867 * EINA_INLIST_REVERSE_FOREACH() starts from last list of the given list. 873 * EINA_INLIST_REVERSE_FOREACH() starts from last list of the given list.
@@ -873,9 +879,9 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
873 879
874/** 880/**
875 * @def EINA_INLIST_FREE 881 * @def EINA_INLIST_FREE
876 * @param list The list to free. 882 * @param[in,out] list The list to free.
877 * @param it The pointer to the list item, i.e. a pointer to each item 883 * @param[in] it The pointer to the list item, i.e. a pointer to each item
878 * that is part of the list. 884 * that is part of the list.
879 * 885 *
880 * NOTE: it is the duty of the body loop to properly remove the item from the 886 * NOTE: it is the duty of the body loop to properly remove the item from the
881 * inlist and free it. This function will turn into a infinite loop if you 887 * inlist and free it. This function will turn into a infinite loop if you
diff --git a/src/lib/eina/eina_iterator.h b/src/lib/eina/eina_iterator.h
index d26b2cc9dc..6c33db1a63 100644
--- a/src/lib/eina/eina_iterator.h
+++ b/src/lib/eina/eina_iterator.h
@@ -199,7 +199,7 @@ struct _Eina_Iterator
199/** 199/**
200 * @brief Frees an iterator. 200 * @brief Frees an iterator.
201 * 201 *
202 * @param iterator The iterator to free. 202 * @param[in,out] iterator The iterator to free.
203 * 203 *
204 * This function frees @p iterator if it is not @c NULL; 204 * This function frees @p iterator if it is not @c NULL;
205 */ 205 */
@@ -209,7 +209,7 @@ EAPI void eina_iterator_free(Eina_Iterator *iterator);
209/** 209/**
210 * @brief Returns the container of an iterator. 210 * @brief Returns the container of an iterator.
211 * 211 *
212 * @param iterator The iterator. 212 * @param[in] iterator The iterator.
213 * @return The container which created the iterator. 213 * @return The container which created the iterator.
214 * 214 *
215 * This function returns the container which created @p iterator. If 215 * This function returns the container which created @p iterator. If
@@ -220,8 +220,8 @@ EAPI void *eina_iterator_container_get(Eina_Iterator *iterator) EINA_ARG_NON
220/** 220/**
221 * @brief Returns the value of the current element and go to the next one. 221 * @brief Returns the value of the current element and go to the next one.
222 * 222 *
223 * @param iterator The iterator. 223 * @param[in,out] iterator The iterator.
224 * @param data The data of the element. 224 * @param[out] data The data of the element.
225 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 225 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
226 * 226 *
227 * This function returns the value of the current element pointed by 227 * This function returns the value of the current element pointed by
@@ -236,9 +236,9 @@ EAPI Eina_Bool eina_iterator_next(Eina_Iterator *iterator,
236/** 236/**
237 * @brief Iterates over the container and execute a callback on each element. 237 * @brief Iterates over the container and execute a callback on each element.
238 * 238 *
239 * @param iterator The iterator. 239 * @param[in,out] iterator The iterator.
240 * @param callback The callback called on each iteration. 240 * @param[in] callback The callback called on each iteration.
241 * @param fdata The data passed to the callback. 241 * @param[in] fdata The data passed to the callback.
242 * 242 *
243 * This function iterates over the elements pointed by @p iterator, 243 * This function iterates over the elements pointed by @p iterator,
244 * beginning with the current element. For each element, the callback 244 * beginning with the current element. For each element, the callback
@@ -255,7 +255,7 @@ EAPI void eina_iterator_foreach(Eina_Iterator *iterator,
255/** 255/**
256 * @brief Locks the container of the iterator. 256 * @brief Locks the container of the iterator.
257 * 257 *
258 * @param iterator The iterator. 258 * @param[in,out] iterator The iterator.
259 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 259 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
260 * 260 *
261 * If the container of the @p iterator permits it, it will be locked. When a 261 * If the container of the @p iterator permits it, it will be locked. When a
@@ -271,7 +271,7 @@ EAPI Eina_Bool eina_iterator_lock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1);
271/** 271/**
272 * @brief Unlocks the container of the iterator. 272 * @brief Unlocks the container of the iterator.
273 * 273 *
274 * @param iterator The iterator. 274 * @param[in,out] iterator The iterator.
275 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 275 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
276 * 276 *
277 * If the container of the @p iterator permits it and was previously 277 * If the container of the @p iterator permits it and was previously
@@ -288,7 +288,7 @@ EAPI Eina_Bool eina_iterator_unlock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1)
288 * @brief Creates an Eina_Iterator that iterates through a 288 * @brief Creates an Eina_Iterator that iterates through a
289 * NUL-terminated C array. 289 * NUL-terminated C array.
290 * 290 *
291 * @param array The NUL-terminated array 291 * @param[in] array The NUL-terminated array
292 * 292 *
293 * You can create it like this: 293 * You can create it like this:
294 * int array[] = {1, 2, 3, 4}; 294 * int array[] = {1, 2, 3, 4};
@@ -303,10 +303,10 @@ EAPI Eina_Iterator* eina_carray_iterator_new(void** array) EINA_ARG_NONNULL(1) E
303/** 303/**
304 * @brief Creates a new iterator which which iterates through all elements with are accepted by the filter callback 304 * @brief Creates a new iterator which which iterates through all elements with are accepted by the filter callback
305 * 305 *
306 * @param original the iterator the use as original set 306 * @param[in] original the iterator the use as original set
307 * @param filter if the callback returns true the element from the original set is taken into the the new set. 307 * @param[in] filter if the callback returns true the element from the original set is taken into the the new set.
308 * @param free_cb when the iterator is gone this callback will be called with data as argument 308 * @param[in] free_cb when the iterator is gone this callback will be called with data as argument
309 * @param data the data which is passed to the filter callback 309 * @param[in] data the data which is passed to the filter callback
310 * 310 *
311 * The iterator is filtered while it is being iterated. 311 * The iterator is filtered while it is being iterated.
312 * The original iterator you pass in here is is then owned and will be freed once the the new iterator is freed. 312 * The original iterator you pass in here is is then owned and will be freed once the the new iterator is freed.
@@ -319,8 +319,8 @@ EAPI Eina_Iterator* eina_iterator_filter_new(Eina_Iterator *original, Eina_Each_
319 * @def EINA_ITERATOR_FOREACH 319 * @def EINA_ITERATOR_FOREACH
320 * @brief Definition for the macro to iterate over all elements easily. 320 * @brief Definition for the macro to iterate over all elements easily.
321 * 321 *
322 * @param itr The iterator to use. 322 * @param[in,out] itr The iterator to use.
323 * @param data Where to store * data, must be a pointer support getting 323 * @param[out] data Where to store * data, must be a pointer support getting
324 * its address since * eina_iterator_next() requires a pointer 324 * its address since * eina_iterator_next() requires a pointer
325 * to pointer! 325 * to pointer!
326 * 326 *