summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-10-31 11:31:24 +0000
committerAndy Williams <andy@andywilliams.me>2017-10-31 11:31:41 +0000
commit57d0617fec179c4fa63c30766d861e619c9856c5 (patch)
tree891a84d960ed4f56297f6be66572b69e513ecb61
parentc8e7ad530e35305870471a40a870112495dc221e (diff)
eina: Fix spelling errors in documentation (file..lock)
Summary: Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewers: cedric, ajwillia.ms Reviewed By: ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5410
-rw-r--r--src/lib/eina/eina_file.h2
-rw-r--r--src/lib/eina/eina_hash.h25
-rw-r--r--src/lib/eina/eina_inarray.h14
-rw-r--r--src/lib/eina/eina_inlist.h20
-rw-r--r--src/lib/eina/eina_iterator.h16
-rw-r--r--src/lib/eina/eina_list.h24
-rw-r--r--src/lib/eina/eina_lock.h6
7 files changed, 53 insertions, 54 deletions
diff --git a/src/lib/eina/eina_file.h b/src/lib/eina/eina_file.h
index 86bce9e2b3..bccadeb734 100644
--- a/src/lib/eina/eina_file.h
+++ b/src/lib/eina/eina_file.h
@@ -656,7 +656,7 @@ EAPI void eina_file_map_free(Eina_File *file, void *map);
656 * @brief Asks the OS to populate or otherwise pages of memory in file mapping. 656 * @brief Asks the OS to populate or otherwise pages of memory in file mapping.
657 * @details This advises the operating system as to what to do with the memory mapped 657 * @details This advises the operating system as to what to do with the memory mapped
658 * to the given @p file. This affects a specific range of memory and may not 658 * to the given @p file. This affects a specific range of memory and may not
659 * be honoured if the system chooses to ignore the request. 659 * be honored if the system chooses to ignore the request.
660 * 660 *
661 * @param[in] file The file handle from which the map comes 661 * @param[in] file The file handle from which the map comes
662 * @param[in] rule The rule to apply to the mapped memory 662 * @param[in] rule The rule to apply to the mapped memory
diff --git a/src/lib/eina/eina_hash.h b/src/lib/eina/eina_hash.h
index a0cd06e9c4..40b0c227f6 100644
--- a/src/lib/eina/eina_hash.h
+++ b/src/lib/eina/eina_hash.h
@@ -215,7 +215,7 @@
215 * However, @ref eina_hash_string_small_new still uses the same hash calculation 215 * However, @ref eina_hash_string_small_new still uses the same hash calculation
216 * function that @ref eina_hash_string_superfast_new, which is more complex than 216 * function that @ref eina_hash_string_superfast_new, which is more complex than
217 * @ref eina_hash_string_djb2_new. The latter has a faster hash computation 217 * @ref eina_hash_string_djb2_new. The latter has a faster hash computation
218 * function, but that will imply on a not so good distribution. But if just a 218 * function, but that will imply a not so good distribution. But if just a
219 * few keys are being added, this is not a problem, it will still have not many 219 * few keys are being added, this is not a problem, it will still have not many
220 * collisions and be faster to calculate the hash than in a hash created with 220 * collisions and be faster to calculate the hash than in a hash created with
221 * @ref eina_hash_string_small_new and @ref eina_hash_string_superfast_new. 221 * @ref eina_hash_string_small_new and @ref eina_hash_string_superfast_new.
@@ -381,7 +381,7 @@ EAPI Eina_Hash *eina_hash_new(Eina_Key_Length key_length_cb,
381 int buckets_power_size) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2, 3); 381 int buckets_power_size) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2, 3);
382 382
383/** 383/**
384 * @brief Redefines the callback that clean the data of a hash. 384 * @brief Redefines the callback that cleans the data of a hash.
385 * 385 *
386 * @param hash The given hash table 386 * @param hash The given hash table
387 * @param data_free_cb The function called on each value when the hash 387 * @param data_free_cb The function called on each value when the hash
@@ -520,7 +520,7 @@ EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb);
520 * @return The new hash table. 520 * @return The new hash table.
521 * 521 *
522 * This function creates a new hash table optimized for stringshared 522 * This function creates a new hash table optimized for stringshared
523 * values. Values CAN NOT be looked up with pointers not 523 * values. Values CANNOT be looked up with pointers not
524 * equal to the original key pointer that was used to add a value. On failure, 524 * equal to the original key pointer that was used to add a value. On failure,
525 * this function returns @c NULL. 525 * this function returns @c NULL.
526 * 526 *
@@ -564,7 +564,6 @@ EAPI Eina_Bool eina_hash_add(Eina_Hash *hash,
564 564
565/** 565/**
566 * @brief Adds an entry to the given hash table without duplicating the string. 566 * @brief Adds an entry to the given hash table without duplicating the string.
567 * key.
568 * 567 *
569 * @param hash The given hash table. Cannot be @c NULL. 568 * @param hash The given hash table. Cannot be @c NULL.
570 * @param key A unique key. Cannot be @c NULL. 569 * @param key A unique key. Cannot be @c NULL.
@@ -602,7 +601,7 @@ EAPI Eina_Bool eina_hash_direct_add(Eina_Hash *hash,
602 * This function removes the entry identified by @p key or @p data 601 * This function removes the entry identified by @p key or @p data
603 * from @p hash. If a free function was given to the 602 * from @p hash. If a free function was given to the
604 * callback on creation, it will be called for the data being 603 * callback on creation, it will be called for the data being
605 * deleted. If @p hash is @c NULL, the functions returns immediately #EINA_FALSE. 604 * deleted. If @p hash is @c NULL, the function returns immediately #EINA_FALSE.
606 * If @p key is @c NULL, then @p data is used to find the a 605 * If @p key is @c NULL, then @p data is used to find the a
607 * match to remove, otherwise @p key is used and @p data is not 606 * match to remove, otherwise @p key is used and @p data is not
608 * required and can be @c NULL. This function returns #EINA_FALSE if 607 * required and can be @c NULL. This function returns #EINA_FALSE if
@@ -692,7 +691,7 @@ EAPI Eina_Bool eina_hash_move(Eina_Hash *hash,
692 * @param hash The hash table to be freed. 691 * @param hash The hash table to be freed.
693 * 692 *
694 * This function frees up all the memory allocated to storing @p hash, 693 * This function frees up all the memory allocated to storing @p hash,
695 * and call the free callback if it has been passed to the hash table 694 * and calls the free callback if it has been passed to the hash table
696 * at creation time. If no free callback has been passed, any entries 695 * at creation time. If no free callback has been passed, any entries
697 * in the table that the program has no more pointers for elsewhere 696 * in the table that the program has no more pointers for elsewhere
698 * may now be lost, so this should only be called if the program has 697 * may now be lost, so this should only be called if the program has
@@ -806,7 +805,7 @@ EAPI Eina_Bool eina_hash_direct_add_by_hash(Eina_Hash *hash,
806 * @param hash The given hash table. Cannot be @c NULL. 805 * @param hash The given hash table. Cannot be @c NULL.
807 * @param key The key. Cannot be @c NULL. 806 * @param key The key. Cannot be @c NULL.
808 * @param key_length The length of the key. 807 * @param key_length The length of the key.
809 * @param key_hash The hash that always match the key. 808 * @param key_hash The hash that always matches the key.
810 * @return #EINA_FALSE if an error occurred, #EINA_TRUE otherwise. 809 * @return #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
811 * 810 *
812 * This function removes the entry identified by @p key and 811 * This function removes the entry identified by @p key and
@@ -814,7 +813,7 @@ EAPI Eina_Bool eina_hash_direct_add_by_hash(Eina_Hash *hash,
814 * callback on creation, it will be called for the data being 813 * callback on creation, it will be called for the data being
815 * deleted. Do not forget to count '\\0' for string when setting the 814 * deleted. Do not forget to count '\\0' for string when setting the
816 * value of @p key_length. If @p hash or @p key are @c NULL, the 815 * value of @p key_length. If @p hash or @p key are @c NULL, the
817 * functions returns immediately #EINA_FALSE. This function 816 * function returns immediately #EINA_FALSE. This function
818 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise. 817 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
819 * 818 *
820 * @note If you don't have the key_hash, use eina_hash_del_by_key() instead. 819 * @note If you don't have the key_hash, use eina_hash_del_by_key() instead.
@@ -837,10 +836,10 @@ EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash,
837 * 836 *
838 * This function removes the entry identified by @p key from @p 837 * This function removes the entry identified by @p key from @p
839 * hash. The key length and hash will be calculated automatically by 838 * hash. The key length and hash will be calculated automatically by
840 * using function provided to has creation function. If a free 839 * using function provided to hash creation function. If a free
841 * function was given to the callback on creation, it will be called 840 * function was given to the callback on creation, it will be called
842 * for the data being deleted. If @p hash or @p key are @c NULL, the 841 * for the data being deleted. If @p hash or @p key are @c NULL, the
843 * functions returns immediately #EINA_FALSE. This function 842 * function returns immediately #EINA_FALSE. This function
844 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise. 843 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
845 * 844 *
846 * @note If you already have the key_hash, use eina_hash_del_by_key_hash() 845 * @note If you already have the key_hash, use eina_hash_del_by_key_hash()
@@ -863,7 +862,7 @@ EAPI Eina_Bool eina_hash_del_by_key(Eina_Hash *hash,
863 * This function removes the entry identified by @p data from @p 862 * This function removes the entry identified by @p data from @p
864 * hash. If a free function was given to the callback on creation, it 863 * hash. If a free function was given to the callback on creation, it
865 * will be called for the data being deleted. If @p hash or @p data 864 * will be called for the data being deleted. If @p hash or @p data
866 * are @c NULL, the functions returns immediately #EINA_FALSE. This 865 * are @c NULL, the function returns immediately #EINA_FALSE. This
867 * function returns #EINA_FALSE if an error occurred, #EINA_TRUE 866 * function returns #EINA_FALSE if an error occurred, #EINA_TRUE
868 * otherwise. 867 * otherwise.
869 * 868 *
@@ -890,7 +889,7 @@ EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash *hash,
890 * This function removes the entry identified by @p key and 889 * This function removes the entry identified by @p key and
891 * @p key_hash, or @p data, from @p hash. If a free function was given to 890 * @p key_hash, or @p data, from @p hash. If a free function was given to
892 * the callback on creation, it will be called for the data being 891 * the callback on creation, it will be called for the data being
893 * deleted. If @p hash is @c NULL, the functions returns immediately #EINA_FALSE. 892 * deleted. If @p hash is @c NULL, the function returns immediately #EINA_FALSE.
894 * If @p key is @c NULL, then @p key_length and @p key_hash 893 * If @p key is @c NULL, then @p key_length and @p key_hash
895 * are ignored and @p data is used to find a match to remove, 894 * are ignored and @p data is used to find a match to remove,
896 * otherwise @p key and @p key_hash are used and @p data is not 895 * otherwise @p key and @p key_hash are used and @p data is not
@@ -982,7 +981,7 @@ EAPI Eina_Iterator *eina_hash_iterator_key_new(const Eina_Hash *hash) EINA_MALLO
982 * valid iterator that will always return false on 981 * valid iterator that will always return false on
983 * eina_iterator_next(), thus keeping API sane. 982 * eina_iterator_next(), thus keeping API sane.
984 * 983 *
985 * If the memory can not be allocated, @c NULL is returned. 984 * If the memory cannot be allocated, @c NULL is returned.
986 * Otherwise, a valid iterator is returned. 985 * Otherwise, a valid iterator is returned.
987 * 986 *
988 * @warning if the hash structure changes then the iterator becomes 987 * @warning if the hash structure changes then the iterator becomes
diff --git a/src/lib/eina/eina_inarray.h b/src/lib/eina/eina_inarray.h
index 8935354f52..2ac314fb1d 100644
--- a/src/lib/eina/eina_inarray.h
+++ b/src/lib/eina/eina_inarray.h
@@ -28,7 +28,7 @@
28 * @dontinclude eina_inarray_01.c 28 * @dontinclude eina_inarray_01.c
29 * 29 *
30 * This example creates an inline array of chars, adds some elements, prints 30 * This example creates an inline array of chars, adds some elements, prints
31 * them, re-purposes the array to store ints, adds some elements and print that. 31 * them, re-purposes the array to store ints, adds some elements and prints that.
32 * 32 *
33 * We are going to start with a function to compare ints. We need this because the '>' 33 * We are going to start with a function to compare ints. We need this because the '>'
34 * operator is not a function and can't be used where Eina_Compare_Cb is needed. 34 * operator is not a function and can't be used where Eina_Compare_Cb is needed.
@@ -48,7 +48,7 @@
48 * 48 *
49 * Once we have an array we can start adding elements to it. Because the 49 * Once we have an array we can start adding elements to it. Because the
50 * insertion function expects a memory address we have to put the value we want 50 * insertion function expects a memory address we have to put the value we want
51 * to store in a variable(this should be no problem since in the real world usage 51 * to store in a variable (this should be no problem since in the real world usage
52 * that's usually where the value is anyways): 52 * that's usually where the value is anyways):
53 * @until push 53 * @until push
54 * @note Because the inline array copies the value given to it we can later 54 * @note Because the inline array copies the value given to it we can later
@@ -80,7 +80,7 @@
80 * because we're storing a different type, but because our types have 80 * because we're storing a different type, but because our types have
81 * different sizes. Eina inline arrays don't actually know anything about types, 81 * different sizes. Eina inline arrays don't actually know anything about types,
82 * they only deal with blocks of memory of a given size. 82 * they only deal with blocks of memory of a given size.
83 * @note Since eina_inarray_step_set() receives already allocated memory, you can(and 83 * @note Since eina_inarray_step_set() receives already allocated memory, you can (and
84 * it is in fact a good practice) use inline arrays that are not declared as pointers: 84 * it is in fact a good practice) use inline arrays that are not declared as pointers:
85 * @code 85 * @code
86 * Eina_Inarray arr; 86 * Eina_Inarray arr;
@@ -164,9 +164,9 @@
164 * We then create the array much like we did on @ref eina_inarray_example_01 : 164 * We then create the array much like we did on @ref eina_inarray_example_01 :
165 * @until inarray_new 165 * @until inarray_new
166 * 166 *
167 * We then add element using eina_inarray_insert and print. Then remove that 167 * We then add an element using eina_inarray_insert and print. Then remove that
168 * element and add again using eina_inarray_insert_sorted and prints. This 168 * element and add it again using eina_inarray_insert_sorted and print. This
169 * shows the 2 different positions the element gets added. Then searches an 169 * shows the 2 different positions the element gets added. Then search for an
170 * element in the unsorted array using eina_inarray_search, then sorts the 170 * element in the unsorted array using eina_inarray_search, then sorts the
171 * array and then searches the same element using eina_inarray_search_sorted. 171 * array and then searches the same element using eina_inarray_search_sorted.
172 * @until } 172 * @until }
@@ -187,7 +187,7 @@
187 * 187 *
188 * @brief Inline array is a container that stores the data itself, not the pointers to the data. 188 * @brief Inline array is a container that stores the data itself, not the pointers to the data.
189 * 189 *
190 * This means there is no memory fragmentation, also for small data types(such 190 * This means there is no memory fragmentation, also for small data types (such
191 * as char, short, int, and so on) it's more memory efficient. 191 * as char, short, int, and so on) it's more memory efficient.
192 * 192 *
193 * Usage of the inline array is very similar to that of other 193 * Usage of the inline array is very similar to that of other
diff --git a/src/lib/eina/eina_inlist.h b/src/lib/eina/eina_inlist.h
index 79a6c6ea0f..25260d1afa 100644
--- a/src/lib/eina/eina_inlist.h
+++ b/src/lib/eina/eina_inlist.h
@@ -133,7 +133,7 @@
133 * @image rtf eina_inlist-node_eg2-my-struct.png 133 * @image rtf eina_inlist-node_eg2-my-struct.png
134 * @image latex eina_inlist-node_eg2-my-struct.eps 134 * @image latex eina_inlist-node_eg2-my-struct.eps
135 * 135 *
136 * Now we need some pointers and auxiliar variables that will help us iterate on 136 * Now we need some pointers and auxiliary variables that will help us iterate on
137 * the lists: 137 * the lists:
138 * 138 *
139 * @skip struct 139 * @skip struct
@@ -729,12 +729,12 @@ EAPI void eina_inlist_sorted_state_free(Eina_Inlist_Sorted_State *state);
729 * @return A list pointer. 729 * @return A list pointer.
730 * @since 1.1.0 730 * @since 1.1.0
731 * 731 *
732 * This function inserts item into a linked list assuming @p state match 732 * This function inserts item into a linked list assuming @p state matches
733 * the exact content order of the list. It use @p state to do a fast 733 * the exact content order of the list. It uses @p state to do a fast
734 * first step dichotomic search before starting to walk the inlist itself. 734 * first step dichotomic search before starting to walk the inlist itself.
735 * This make this code much faster than eina_inlist_sorted_insert() as it 735 * This makes this code much faster than eina_inlist_sorted_insert() as it
736 * doesn't need to walk the list at all. The result is of course a sorted 736 * doesn't need to walk the list at all. The result is of course a sorted
737 * list with an updated state.. If @p list is @c NULLL, item 737 * list with an updated state. If @p list is @c NULL, item
738 * is returned. On success, a new list pointer that should be 738 * is returned. On success, a new list pointer that should be
739 * used in place of the one given to this function is 739 * used in place of the one given to this function is
740 * returned. Otherwise, the old pointer is returned. 740 * returned. Otherwise, the old pointer is returned.
@@ -742,8 +742,8 @@ EAPI void eina_inlist_sorted_state_free(Eina_Inlist_Sorted_State *state);
742 * @note O(log2(n)) comparisons (calls to @p func) average/worst case 742 * @note O(log2(n)) comparisons (calls to @p func) average/worst case
743 * performance. As said in eina_list_search_sorted_near_list(), 743 * performance. As said in eina_list_search_sorted_near_list(),
744 * lists do not have O(1) access time, so walking to the correct node 744 * lists do not have O(1) access time, so walking to the correct node
745 * can be costly, but this version try to minimize that by making it a 745 * can be costly, but this version tries to minimize that by making it a
746 * O(log2(n)) for number small number. After n == 256, it start to add a 746 * O(log2(n)) for number small number. After n == 256, it starts to add a
747 * linear cost again. Consider worst case to be almost O(n) pointer 747 * linear cost again. Consider worst case to be almost O(n) pointer
748 * dereference (list walk). 748 * dereference (list walk).
749 */ 749 */
@@ -797,7 +797,7 @@ EAPI Eina_Inlist *eina_inlist_sorted_state_insert(Eina_Inlist *list,
797 */ 797 */
798EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func); 798EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
799 799
800/* This two macros are helpers for the _FOREACH ones, don't use them */ 800/* These two macros are helpers for the _FOREACH ones, don't use them */
801/** 801/**
802 * @def _EINA_INLIST_OFFSET 802 * @def _EINA_INLIST_OFFSET
803 * @param ref The reference to be used. 803 * @param ref The reference to be used.
@@ -848,7 +848,7 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
848 848
849/** 849/**
850 * @def EINA_INLIST_REVERSE_FOREACH 850 * @def EINA_INLIST_REVERSE_FOREACH
851 * @param list The list to traversed in reverse order. 851 * @param list The list to traverse in reverse order.
852 * @param it The pointer to the list item, i.e. a pointer to each item 852 * @param it The pointer to the list item, i.e. a pointer to each item
853 * that is part of the list. 853 * that is part of the list.
854 */ 854 */
@@ -858,7 +858,7 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
858 858
859/** 859/**
860 * @def EINA_INLIST_REVERSE_FOREACH_FROM 860 * @def EINA_INLIST_REVERSE_FOREACH_FROM
861 * @param list The last list to traversed in reverse order. 861 * @param 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 862 * @param it The pointer to the list item, i.e. a pointer to each item
863 * that is part of the list. 863 * that is part of the list.
864 * @see EINA_INLIST_REVERSE_FOREACH() 864 * @see EINA_INLIST_REVERSE_FOREACH()
diff --git a/src/lib/eina/eina_iterator.h b/src/lib/eina/eina_iterator.h
index 4a63581e3d..20bc2ecc23 100644
--- a/src/lib/eina/eina_iterator.h
+++ b/src/lib/eina/eina_iterator.h
@@ -38,7 +38,7 @@
38 * @note Returning EINA_TRUE is important so we don't stop iterating over the 38 * @note Returning EINA_TRUE is important so we don't stop iterating over the
39 * container. 39 * container.
40 * 40 *
41 * And here a more interesting function, it uses an iterator to print the 41 * And here's a more interesting function, it uses an iterator to print the
42 * contents of a container. What's interesting about it is that it doesn't care 42 * contents of a container. What's interesting about it is that it doesn't care
43 * the type of container, it works for anything that can provide an iterator: 43 * the type of container, it works for anything that can provide an iterator:
44 * @until } 44 * @until }
@@ -87,16 +87,16 @@
87 * 87 *
88 * @brief These functions manage iterators on containers. 88 * @brief These functions manage iterators on containers.
89 * 89 *
90 * These functions allow to access elements of a container in a 90 * These functions allow accessing elements of a container in a
91 * generic way, without knowing which container is used (a bit like 91 * generic way, without knowing which container is used (a bit like
92 * iterators in the C++ STL). Iterators only allows sequential access 92 * iterators in the C++ STL). Iterators only allow sequential access
93 * (that is, from an element to the next one). For random access, see 93 * (that is, from one element to the next one). For random access, see
94 * @ref Eina_Accessor_Group. 94 * @ref Eina_Accessor_Group.
95 * 95 *
96 * Getting an iterator to access elements of a given container is done through 96 * Getting an iterator to access elements of a given container is done through
97 * the functions of that particular container. There is no function to create 97 * the functions of that particular container. There is no function to create
98 * a generic iterator as iterators absolutely depend on the container. This 98 * a generic iterator as iterators absolutely depend on the container. This
99 * means you won't find iterator creation function here, those can be found on 99 * means you won't find an iterator creation function here, those can be found with
100 * the documentation of the container type you're using. Though created with 100 * the documentation of the container type you're using. Though created with
101 * container specific functions iterators are always deleted with the same 101 * container specific functions iterators are always deleted with the same
102 * function: eina_iterator_free(). 102 * function: eina_iterator_free().
@@ -241,7 +241,7 @@ EAPI Eina_Bool eina_iterator_next(Eina_Iterator *iterator,
241 * @param fdata The data passed to the callback. 241 * @param 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 from the current element. For Each element, the callback 244 * beginning with the current element. For each element, the callback
245 * @p cb is called with the data @p fdata. If @p iterator is @c NULL, 245 * @p cb is called with the data @p fdata. If @p iterator is @c NULL,
246 * the function returns immediately. Also, if @p cb returns #EINA_FALSE, 246 * the function returns immediately. Also, if @p cb returns #EINA_FALSE,
247 * the iteration stops at that point, if @p cb returns #EINA_TRUE 247 * the iteration stops at that point, if @p cb returns #EINA_TRUE
@@ -301,14 +301,14 @@ EAPI Eina_Bool eina_iterator_unlock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1)
301EAPI Eina_Iterator* eina_carray_iterator_new(void** array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 301EAPI Eina_Iterator* eina_carray_iterator_new(void** array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
302 302
303/** 303/**
304 * @brief Creates a new iterator which which iterates throuw 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 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 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 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 data the data which is passed to the filter callback
310 * 310 *
311 * The iterator is filtered while it is beeing 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.
313 * 313 *
314 * @since 1.19 314 * @since 1.19
diff --git a/src/lib/eina/eina_list.h b/src/lib/eina/eina_list.h
index e4e855ace1..155cd4e8da 100644
--- a/src/lib/eina/eina_list.h
+++ b/src/lib/eina/eina_list.h
@@ -39,7 +39,7 @@
39 * @skip #include 39 * @skip #include
40 * @until Eina.h 40 * @until Eina.h
41 * 41 *
42 * Just some boilerplate code, declaring some variable and initializing eina. 42 * Just some boilerplate code, declaring some variables and initializing eina.
43 * @until eina_init 43 * @until eina_init
44 * Here we add a sequence of elements to our list. By using append we add 44 * Here we add a sequence of elements to our list. By using append we add
45 * elements to the end of the list, so the list will look like this:@n 45 * elements to the end of the list, so the list will look like this:@n
@@ -69,7 +69,7 @@
69 * accomplished using @ref eina_list_append_relative() and 69 * accomplished using @ref eina_list_append_relative() and
70 * @ref eina_list_append_relative_list(): 70 * @ref eina_list_append_relative_list():
71 * @until zarek 71 * @until zarek
72 * First @a "cain" is added after the second element(remember that indexes are 72 * First @a "cain" is added after the second element (remember that indexes are
73 * 0 based) and then we add @a "zarek" after @a "cain". 73 * 0 based) and then we add @a "zarek" after @a "cain".
74 * 74 *
75 * @ref Eina_List also has prepend analogs to append functions we have used so 75 * @ref Eina_List also has prepend analogs to append functions we have used so
@@ -170,7 +170,7 @@
170 * @until sagitarius 170 * @until sagitarius
171 * 171 *
172 * To replace an element in the list it is not necessary to remove it and then 172 * To replace an element in the list it is not necessary to remove it and then
173 * add with the new value, it is possible to just change the value of a node: 173 * re-add with the new value, it is possible to just change the value of a node:
174 * @until aquarius 174 * @until aquarius
175 * 175 *
176 * We will now take a peek to see if the list still has the right number of 176 * We will now take a peek to see if the list still has the right number of
@@ -408,7 +408,7 @@ EAPI Eina_List *eina_list_prepend(Eina_List *list, const void *data)
408 * @p relative is not in the list, @p data is appended to the end of 408 * @p relative is not in the list, @p data is appended to the end of
409 * the list. If @p list is @c NULL, a new list is returned. If there 409 * the list. If @p list is @c NULL, a new list is returned. If there
410 * are multiple instances of @p relative in the list, @p data is 410 * are multiple instances of @p relative in the list, @p data is
411 * inserted after the first instance.On success, a new list pointer 411 * inserted after the first instance. On success, a new list pointer
412 * that should be used in place of the one given to this function is 412 * that should be used in place of the one given to this function is
413 * returned. Otherwise, the old pointer is returned. 413 * returned. Otherwise, the old pointer is returned.
414 * 414 *
@@ -992,7 +992,7 @@ EAPI Eina_List *eina_list_split_list(Eina_List *list, Eina_List *rela
992 992
993 993
994/** 994/**
995 * @brief Returns node nearest to data is in the sorted list. 995 * @brief Returns node nearest to data from the sorted list.
996 * 996 *
997 * @param list The list to search for data, @b must be sorted. 997 * @param list The list to search for data, @b must be sorted.
998 * @param func A function pointer that can handle comparing the list data nodes. 998 * @param func A function pointer that can handle comparing the list data nodes.
@@ -1033,7 +1033,7 @@ EAPI Eina_List *eina_list_split_list(Eina_List *list, Eina_List *rela
1033 * 1033 *
1034 * If @a cmp_result is 0 the element is already in the list and we need not 1034 * If @a cmp_result is 0 the element is already in the list and we need not
1035 * insert it, if @a cmp_result is greater than zero @a "my @a data" needs to 1035 * insert it, if @a cmp_result is greater than zero @a "my @a data" needs to
1036 * come after @a l(the nearest node present), if less than zero before. 1036 * come after @a l (the nearest node present), if less than zero before.
1037 * 1037 *
1038 * @note O(log2(n)) average/worst case performance, for 1,000,000 1038 * @note O(log2(n)) average/worst case performance, for 1,000,000
1039 * elements it will do a maximum of 20 comparisons. This is much 1039 * elements it will do a maximum of 20 comparisons. This is much
@@ -1243,7 +1243,7 @@ static inline void *eina_list_data_get(const Eina_List *list) EINA_PURE E
1243 * @param data The data member to the list node. 1243 * @param data The data member to the list node.
1244 * @return The previous data value. 1244 * @return The previous data value.
1245 * 1245 *
1246 * This function set the data member @p data of the specified list node 1246 * This function sets the data member @p data of the specified list node
1247 * @p list. It returns the previous data of the node. If @p list is 1247 * @p list. It returns the previous data of the node. If @p list is
1248 * @c NULL, this function returns @c NULL. 1248 * @c NULL, this function returns @c NULL.
1249 * 1249 *
@@ -1337,7 +1337,7 @@ EAPI Eina_Iterator *eina_list_iterator_reversed_new(const Eina_List *list
1337 * This function returns a newly allocated accessor associated to 1337 * This function returns a newly allocated accessor associated to
1338 * @p list. If @p list is @c NULL or the count member of @p list is 1338 * @p list. If @p list is @c NULL or the count member of @p list is
1339 * less or equal than 0, this function returns @c NULL. If the memory can 1339 * less or equal than 0, this function returns @c NULL. If the memory can
1340 * not be allocated, @c NULL is returned Otherwise, a valid accessor is 1340 * not be allocated, @c NULL is returned; otherwise, a valid accessor is
1341 * returned. 1341 * returned.
1342 * 1342 *
1343 * @warning @p list must be a pointer to the first element of the list. 1343 * @warning @p list must be a pointer to the first element of the list.
@@ -1345,7 +1345,7 @@ EAPI Eina_Iterator *eina_list_iterator_reversed_new(const Eina_List *list
1345EAPI Eina_Accessor *eina_list_accessor_new(const Eina_List *list) EINA_MALLOC EINA_WARN_UNUSED_RESULT; 1345EAPI Eina_Accessor *eina_list_accessor_new(const Eina_List *list) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
1346 1346
1347/** 1347/**
1348 * @brief Finds the member of the list and return the index. 1348 * @brief Finds the member of the list and returns the index.
1349 * 1349 *
1350 * @param list The list. 1350 * @param list The list.
1351 * @param data The data member. 1351 * @param data The data member.
@@ -1499,7 +1499,7 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1499 * deleting the current node and continuing looping is safe. 1499 * deleting the current node and continuing looping is safe.
1500 * 1500 *
1501 * The following diagram illustrates this macro iterating over a list of four 1501 * The following diagram illustrates this macro iterating over a list of four
1502 * elements("one", "two", "three" and "four"): 1502 * elements ("one", "two", "three" and "four"):
1503 * @htmlonly 1503 * @htmlonly
1504 * <img src="eina-list-foreach-safe.png" style="max-width: 100%;" /> 1504 * <img src="eina-list-foreach-safe.png" style="max-width: 100%;" />
1505 * <a href="eina-list-foreach-safe.png">Full-size</a> 1505 * <a href="eina-list-foreach-safe.png">Full-size</a>
@@ -1560,7 +1560,7 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1560 * deleting the current node and continuing looping is safe. 1560 * deleting the current node and continuing looping is safe.
1561 * 1561 *
1562 * The following diagram illustrates this macro iterating over a list of four 1562 * The following diagram illustrates this macro iterating over a list of four
1563 * elements("one", "two", "three" and "four"): 1563 * elements ("one", "two", "three" and "four"):
1564 * @htmlonly 1564 * @htmlonly
1565 * <img src="eina-list-reverse-foreach-safe.png" style="max-width: 100%;" /> 1565 * <img src="eina-list-reverse-foreach-safe.png" style="max-width: 100%;" />
1566 * <a href="eina-list-reverse-foreach-safe.png">Full-size</a> 1566 * <a href="eina-list-reverse-foreach-safe.png">Full-size</a>
@@ -1613,7 +1613,7 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1613 * the data contained in the current node in @p data. 1613 * the data contained in the current node in @p data.
1614 * 1614 *
1615 * The following diagram illustrates this macro iterating over a list of four 1615 * The following diagram illustrates this macro iterating over a list of four
1616 * elements("one", "two", "three" and "four"): 1616 * elements ("one", "two", "three" and "four"):
1617 * @htmlonly 1617 * @htmlonly
1618 * <img src="eina-list-free.png" style="max-width: 100%;" /> 1618 * <img src="eina-list-free.png" style="max-width: 100%;" />
1619 * <a href="eina-list-free.png">Full-size</a> 1619 * <a href="eina-list-free.png">Full-size</a>
diff --git a/src/lib/eina/eina_lock.h b/src/lib/eina/eina_lock.h
index 2a8a8d5ac6..ea0d6e7f2c 100644
--- a/src/lib/eina/eina_lock.h
+++ b/src/lib/eina/eina_lock.h
@@ -29,7 +29,7 @@
29 * @ingroup Eina_Tools_Group 29 * @ingroup Eina_Tools_Group
30 * @brief This group provides thread locking and synchronization capabilities. 30 * @brief This group provides thread locking and synchronization capabilities.
31 * 31 *
32 * Similar to POISIX threads (pthreads), but it takes care of the platform specific 32 * Similar to POSIX threads (pthreads), but it takes care of the platform specific
33 * details so you don't have to. 33 * details so you don't have to.
34 * 34 *
35 * If you know how @c pthreads work, this library will look familiar to you. 35 * If you know how @c pthreads work, this library will look familiar to you.
@@ -334,7 +334,7 @@ static inline void eina_rwlock_free(Eina_RWLock *mutex);
334 * 334 *
335 * @return Returns #EINA_LOCK_SUCCEED on success, #EINA_LOCK_FAIL on failure. 335 * @return Returns #EINA_LOCK_SUCCEED on success, #EINA_LOCK_FAIL on failure.
336 * 336 *
337 * @note This function never return #EINA_LOCK_DEADLOCK. 337 * @note This function never returns #EINA_LOCK_DEADLOCK.
338 * 338 *
339 * @see eina_rwlock_release() 339 * @see eina_rwlock_release()
340 */ 340 */
@@ -350,7 +350,7 @@ static inline Eina_Lock_Result eina_rwlock_take_read(Eina_RWLock *mutex);
350 * 350 *
351 * @return Returns #EINA_LOCK_SUCCEED on success, #EINA_LOCK_FAIL on failure. 351 * @return Returns #EINA_LOCK_SUCCEED on success, #EINA_LOCK_FAIL on failure.
352 * 352 *
353 * @note This function never return #EINA_LOCK_DEADLOCK. 353 * @note This function never returns #EINA_LOCK_DEADLOCK.
354 * 354 *
355 * @see eina_rwlock_release() 355 * @see eina_rwlock_release()
356 */ 356 */