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

src/lib/eina/eina_file.h

@@ -656,7 +656,7 @@ EAPI void eina_file_map_free(Eina_File *file, void *map);
  * @brief Asks the OS to populate or otherwise pages of memory in file mapping.
  * @details This advises the operating system as to what to do with the memory mapped
  *          to the given @p file. This affects a specific range of memory and may not
- *          be honoured if the system chooses to ignore the request.
+ *          be honored if the system chooses to ignore the request.
  * 
  * @param[in] file The file handle from which the map comes
  * @param[in] rule The rule to apply to the mapped memory

src/lib/eina/eina_hash.h

@@ -215,7 +215,7 @@
  * However, @ref eina_hash_string_small_new still uses the same hash calculation
  * function that @ref eina_hash_string_superfast_new, which is more complex than
  * @ref eina_hash_string_djb2_new. The latter has a faster hash computation
- * function, but that will imply on a not so good distribution. But if just a
+ * function, but that will imply a not so good distribution. But if just a
  * few keys are being added, this is not a problem, it will still have not many
  * collisions and be faster to calculate the hash than in a hash created with
  * @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,
                               int             buckets_power_size) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2, 3);
 
 /**
- * @brief Redefines the callback that clean the data of a hash.
+ * @brief Redefines the callback that cleans the data of a hash.
  *
  * @param hash The given hash table
  * @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);
  * @return  The new hash table.
  *
  * This function creates a new hash table optimized for stringshared
- * values. Values CAN NOT be looked up with pointers not
+ * values. Values CANNOT be looked up with pointers not
  * equal to the original key pointer that was used to add a value. On failure,
  * this function returns @c NULL.
  *
@@ -564,7 +564,6 @@ EAPI Eina_Bool  eina_hash_add(Eina_Hash  *hash,
 
 /**
  * @brief Adds an entry to the given hash table without duplicating the string.
- * key.
  *
  * @param hash The given hash table. Cannot be @c NULL.
  * @param key A unique key. Cannot be @c NULL.
@@ -602,7 +601,7 @@ EAPI Eina_Bool eina_hash_direct_add(Eina_Hash  *hash,
  * This function removes the entry identified by @p key or @p data
  * from @p hash. If a free function was given to the
  * callback on creation, it will be called for the data being
- * deleted. If @p hash is @c NULL, the functions returns immediately #EINA_FALSE.
+ * deleted. If @p hash is @c NULL, the function returns immediately #EINA_FALSE.
  * If @p key is @c NULL, then @p data is used to find the a
  * match to remove, otherwise @p key is used and @p data is not
  * 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,
  * @param hash The hash table to be freed.
  *
  * This function frees up all the memory allocated to storing @p hash,
- * and call the free callback if it has been passed to the hash table
+ * and calls the free callback if it has been passed to the hash table
  * at creation time. If no free callback has been passed, any entries
  * in the table that the program has no more pointers for elsewhere
  * 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,
  * @param hash The given hash table. Cannot be @c NULL.
  * @param key The key. Cannot be @c NULL.
  * @param key_length The length of the key.
- * @param key_hash The hash that always match the key.
+ * @param key_hash The hash that always matches the key.
  * @return #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
  *
  * 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,
  * callback on creation, it will be called for the data being
  * deleted. Do not forget to count '\\0' for string when setting the
  * value of @p key_length. If @p hash or @p key are @c NULL, the
- * functions returns immediately #EINA_FALSE. This function
+ * function returns immediately #EINA_FALSE. This function
  * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
  *
  * @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,
  *
  * This function removes the entry identified by @p key from @p
  * hash. The key length and hash will be calculated automatically by
- * using function provided to has creation function. If a free
+ * using function provided to hash creation function. If a free
  * function was given to the callback on creation, it will be called
  * for the data being deleted. If @p hash or @p key are @c NULL, the
- * functions returns immediately #EINA_FALSE. This function
+ * function returns immediately #EINA_FALSE. This function
  * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
  *
  * @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,
  * This function removes the entry identified by @p data from @p
  * hash. If a free function was given to the callback on creation, it
  * will be called for the data being deleted. If @p hash or @p data
- * are @c NULL, the functions returns immediately #EINA_FALSE. This
+ * are @c NULL, the function returns immediately #EINA_FALSE. This
  * function returns #EINA_FALSE if an error occurred, #EINA_TRUE
  * otherwise.
  *
@@ -890,7 +889,7 @@ EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash  *hash,
  * This function removes the entry identified by @p key and
  * @p key_hash, or @p data, from @p hash. If a free function was given to
  * the  callback on creation, it will be called for the data being
- * deleted. If @p hash is @c NULL, the functions returns immediately #EINA_FALSE.
+ * deleted. If @p hash is @c NULL, the function returns immediately #EINA_FALSE.
  * If @p key is @c NULL, then @p key_length and @p key_hash
  * are ignored and @p data is used to find a match to remove,
  * 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
  * valid iterator that will always return false on
  * eina_iterator_next(), thus keeping API sane.
  *
- * If the memory can not be allocated, @c NULL is returned.
+ * If the memory cannot be allocated, @c NULL is returned.
  * Otherwise, a valid iterator is returned.
  *
  * @warning if the hash structure changes then the iterator becomes

src/lib/eina/eina_inarray.h

@@ -28,7 +28,7 @@
  * @dontinclude eina_inarray_01.c
  *
  * This example creates an inline array of chars, adds some elements, prints
- * them, re-purposes the array to store ints, adds some elements and print that.
+ * them, re-purposes the array to store ints, adds some elements and prints that.
  *
  * We are going to start with a function to compare ints. We need this because the '>'
  * operator is not a function and can't be used where Eina_Compare_Cb is needed.
@@ -48,7 +48,7 @@
  *
  * Once we have an array we can start adding elements to it. Because the
  * insertion function expects a memory address we have to put the value we want
- * to store in a variable(this should be no problem since in the real world usage
+ * to store in a variable (this should be no problem since in the real world usage
  * that's usually where the value is anyways):
  * @until push
  * @note Because the inline array copies the value given to it we can later
@@ -80,7 +80,7 @@
  * because we're storing a different type, but because our types have
  * different sizes. Eina inline arrays don't actually know anything about types,
  * they only deal with blocks of memory of a given size.
- * @note Since eina_inarray_step_set() receives already allocated memory, you can(and
+ * @note Since eina_inarray_step_set() receives already allocated memory, you can (and
  * it is in fact a good practice) use inline arrays that are not declared as pointers:
  * @code
  * Eina_Inarray arr;
@@ -164,9 +164,9 @@
  * We then create the array much like we did on @ref eina_inarray_example_01 :
  * @until inarray_new
  *
- * We then add element using eina_inarray_insert and print. Then remove that
+ * We then add an element using eina_inarray_insert and print. Then remove that
- * element and add again using eina_inarray_insert_sorted and prints. This
+ * element and add it again using eina_inarray_insert_sorted and print. This
- * shows the 2 different positions the element gets added. Then searches an
+ * shows the 2 different positions the element gets added. Then search for an
  * element in the unsorted array using eina_inarray_search, then sorts the
  * array and then searches the same element using eina_inarray_search_sorted.
  * @until }
@@ -187,7 +187,7 @@
  *
  * @brief Inline array is a container that stores the data itself, not the pointers to the data.
  *
- * This means there is no memory fragmentation, also for small data types(such
+ * This means there is no memory fragmentation, also for small data types (such
  * as char, short, int, and so on) it's more memory efficient.
  *
  * Usage of the inline array is very similar to that of other

src/lib/eina/eina_inlist.h

@@ -133,7 +133,7 @@
  * @image rtf eina_inlist-node_eg2-my-struct.png
  * @image latex eina_inlist-node_eg2-my-struct.eps
  *
- * Now we need some pointers and auxiliar variables that will help us iterate on
+ * Now we need some pointers and auxiliary variables that will help us iterate on
  * the lists:
  *
  * @skip struct
@@ -729,12 +729,12 @@ EAPI void eina_inlist_sorted_state_free(Eina_Inlist_Sorted_State *state);
  * @return A list pointer.
  * @since 1.1.0
  *
- * This function inserts item into a linked list assuming @p state match
+ * This function inserts item into a linked list assuming @p state matches
- * the exact content order of the list. It use @p state to do a fast
+ * the exact content order of the list. It uses @p state to do a fast
  * first step dichotomic search before starting to walk the inlist itself.
- * This make this code much faster than eina_inlist_sorted_insert() as it
+ * This makes this code much faster than eina_inlist_sorted_insert() as it
  * doesn't need to walk the list at all. The result is of course a sorted
- * list with an updated state.. If @p list is @c NULLL, item
+ * list with an updated state. If @p list is @c NULL, item
  * is returned. On success, a new list pointer that should be
  * used in place of the one given to this function is
  * returned. Otherwise, the old pointer is returned.
@@ -742,8 +742,8 @@ EAPI void eina_inlist_sorted_state_free(Eina_Inlist_Sorted_State *state);
  * @note O(log2(n)) comparisons (calls to @p func) average/worst case
  * performance. As said in eina_list_search_sorted_near_list(),
  * lists do not have O(1) access time, so walking to the correct node
- * can be costly, but this version try to minimize that by making it a
+ * can be costly, but this version tries to minimize that by making it a
- * O(log2(n)) for number small number. After n == 256, it start to add a
+ * O(log2(n)) for number small number. After n == 256, it starts to add a
  * linear cost again. Consider worst case to be almost O(n) pointer
  * dereference (list walk).
  */
@@ -797,7 +797,7 @@ EAPI Eina_Inlist *eina_inlist_sorted_state_insert(Eina_Inlist *list,
  */
 EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
 
-/* This two macros are helpers for the _FOREACH ones, don't use them */
+/* These two macros are helpers for the _FOREACH ones, don't use them */
 /**
  * @def _EINA_INLIST_OFFSET
  * @param ref The reference to be used.
@@ -848,7 +848,7 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
 
 /**
  * @def EINA_INLIST_REVERSE_FOREACH
- * @param list The list to traversed in reverse order.
+ * @param list The list to traverse in reverse order.
  * @param it The pointer to the list item, i.e. a pointer to each item
  * that is part of the list.
  */
@@ -858,7 +858,7 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
 
 /**
  * @def EINA_INLIST_REVERSE_FOREACH_FROM
- * @param list The last list to traversed in reverse order.
+ * @param list The last list to traverse in reverse order.
  * @param it The pointer to the list item, i.e. a pointer to each item
  * that is part of the list.
  * @see EINA_INLIST_REVERSE_FOREACH()

src/lib/eina/eina_iterator.h

@@ -38,7 +38,7 @@
  * @note Returning EINA_TRUE is important so we don't stop iterating over the
  * container.
  *
- * And here a more interesting function, it uses an iterator to print the
+ * And here's a more interesting function, it uses an iterator to print the
  * contents of a container. What's interesting about it is that it doesn't care
  * the type of container, it works for anything that can provide an iterator:
  * @until }
@@ -87,16 +87,16 @@
  *
  * @brief These functions manage iterators on containers.
  *
- * These functions allow to access elements of a container in a
+ * These functions allow accessing elements of a container in a
  * generic way, without knowing which container is used (a bit like
- * iterators in the C++ STL). Iterators only allows sequential access
+ * iterators in the C++ STL). Iterators only allow sequential access
- * (that is, from an element to the next one). For random access, see
+ * (that is, from one element to the next one). For random access, see
  * @ref Eina_Accessor_Group.
  *
  * Getting an iterator to access elements of a given container is done through
  * the functions of that particular container. There is no function to create
  * a generic iterator as iterators absolutely depend on the container. This
- * means you won't find iterator creation function here, those can be found on
+ * means you won't find an iterator creation function here, those can be found with
  * the documentation of the container type you're using. Though created with
  * container specific functions iterators are always deleted with the same
  * function: eina_iterator_free().
@@ -241,7 +241,7 @@ EAPI Eina_Bool eina_iterator_next(Eina_Iterator *iterator,
  * @param fdata The data passed to the callback.
  *
  * This function iterates over the elements pointed by @p iterator,
- * beginning from the current element. For Each element, the callback
+ * beginning with the current element. For each element, the callback
  * @p cb is called with the data @p fdata. If @p iterator is @c NULL,
  * the function returns immediately. Also, if @p cb returns #EINA_FALSE,
  * 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)
 EAPI Eina_Iterator* eina_carray_iterator_new(void** array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
 
 /**
- * @brief Creates a new iterator which which iterates throuw all elements with are accepted by the filter callback
+ * @brief Creates a new iterator which which iterates through all elements with are accepted by the filter callback
  *
  * @param original the iterator the use as original set
  * @param filter if the callback returns true the element from the original set is taken into the the new set.
  * @param free_cb when the iterator is gone this callback will be called with data as argument
  * @param data the data which is passed to the filter callback
  *
- * The iterator is filtered while it is beeing iterated.
+ * The iterator is filtered while it is being iterated.
  * The original iterator you pass in here is is then owned and will be freed once the the new iterator is freed.
  *
  * @since 1.19

src/lib/eina/eina_list.h

@@ -39,7 +39,7 @@
  * @skip #include
  * @until Eina.h
  *
- * Just some boilerplate code, declaring some variable and initializing eina.
+ * Just some boilerplate code, declaring some variables and initializing eina.
  * @until eina_init
  * Here we add a sequence of elements to our list. By using append we add
  * elements to the end of the list, so the list will look like this:@n
@@ -69,7 +69,7 @@
  * accomplished using @ref eina_list_append_relative() and
  * @ref eina_list_append_relative_list():
  * @until zarek
- * First @a "cain" is added after the second element(remember that indexes are
+ * First @a "cain" is added after the second element (remember that indexes are
  * 0 based) and then we add @a "zarek" after @a "cain".
  *
  * @ref Eina_List also has prepend analogs to append functions we have used so
@@ -170,7 +170,7 @@
  * @until sagitarius
  *
  * To replace an element in the list it is not necessary to remove it and then
- * add with the new value, it is possible to just change the value of a node:
+ * re-add with the new value, it is possible to just change the value of a node:
  * @until aquarius
  *
  * 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)
  * @p relative is not in the list, @p data is appended to the end of
  * the list.  If @p list is @c NULL, a  new list is returned. If there
  * are multiple instances of @p relative in the list, @p data is
- * inserted after the first instance.On success, a new list pointer
+ * inserted after the first instance. On success, a new list pointer
  * that should be used in place of the one given to this function is
  * returned. Otherwise, the old pointer is returned.
  *
@@ -992,7 +992,7 @@ EAPI Eina_List            *eina_list_split_list(Eina_List *list, Eina_List *rela
 
 
 /**
- * @brief Returns node nearest to data is in the sorted list.
+ * @brief Returns node nearest to data from the sorted list.
  *
  * @param list The list to search for data, @b must be sorted.
  * @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
  * 
  * If @a cmp_result is 0 the element is already in the list and we need not
  * insert it, if @a cmp_result is greater than zero @a "my @a data" needs to
- * come after @a l(the nearest node present), if less than zero before.
+ * come after @a l (the nearest node present), if less than zero before.
  *
  * @note O(log2(n)) average/worst case performance, for 1,000,000
  * 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
  * @param data The data member to the list node.
  * @return The previous data value.
  *
- * This function set the data member @p data of the specified list node
+ * This function sets the data member @p data of the specified list node
  * @p list. It returns the previous data of the node. If @p list is
  * @c NULL, this function returns @c NULL.
  *
@@ -1337,7 +1337,7 @@ EAPI Eina_Iterator        *eina_list_iterator_reversed_new(const Eina_List *list
  * This function returns a newly allocated accessor associated to
  * @p list. If @p list is @c NULL or the count member of @p list is
  * less or equal than 0, this function returns @c NULL. If the memory can
- * not be allocated, @c NULL is returned Otherwise, a valid accessor is
+ * not be allocated, @c NULL is returned; otherwise, a valid accessor is
  * returned.
  *
  * @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
 EAPI Eina_Accessor        *eina_list_accessor_new(const Eina_List *list) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
 
 /**
- * @brief Finds the member of the list and return the index.
+ * @brief Finds the member of the list and returns the index.
  *
  * @param list The list.
  * @param data The data member.
@@ -1499,7 +1499,7 @@ EAPI int                   eina_list_data_idx(const Eina_List *list, void *data)
  * deleting the current node and continuing looping is safe.
  *
  * The following diagram illustrates this macro iterating over a list of four
- * elements("one", "two", "three" and "four"):
+ * elements ("one", "two", "three" and "four"):
  * @htmlonly
  * <img src="eina-list-foreach-safe.png" style="max-width: 100%;" />
  * <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)
  * deleting the current node and continuing looping is safe.
  *
  * The following diagram illustrates this macro iterating over a list of four
- * elements("one", "two", "three" and "four"):
+ * elements ("one", "two", "three" and "four"):
  * @htmlonly
  * <img src="eina-list-reverse-foreach-safe.png" style="max-width: 100%;" />
  * <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)
  * the data contained in the current node in @p data.
  *
  * The following diagram illustrates this macro iterating over a list of four
- * elements("one", "two", "three" and "four"):
+ * elements ("one", "two", "three" and "four"):
  * @htmlonly
  * <img src="eina-list-free.png" style="max-width: 100%;" />
  * <a href="eina-list-free.png">Full-size</a>

src/lib/eina/eina_lock.h

@@ -29,7 +29,7 @@
  * @ingroup Eina_Tools_Group
  * @brief This group provides thread locking and synchronization capabilities.
  *
- * Similar to POISIX threads (pthreads), but it takes care of the platform specific
+ * Similar to POSIX threads (pthreads), but it takes care of the platform specific
  * details so you don't have to.
  *
  * 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);
  *
  * @return Returns #EINA_LOCK_SUCCEED on success, #EINA_LOCK_FAIL on failure.
  *
- * @note This function never return #EINA_LOCK_DEADLOCK.
+ * @note This function never returns #EINA_LOCK_DEADLOCK.
  *
  * @see eina_rwlock_release()
  */
@@ -350,7 +350,7 @@ static inline Eina_Lock_Result eina_rwlock_take_read(Eina_RWLock *mutex);
  *
  * @return Returns #EINA_LOCK_SUCCEED on success, #EINA_LOCK_FAIL on failure.
  *
- * @note This function never return #EINA_LOCK_DEADLOCK.
+ * @note This function never returns #EINA_LOCK_DEADLOCK.
  *
  * @see eina_rwlock_release()
  */