summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-10-27 11:35:10 -0700
committerCedric Bail <cedric@osg.samsung.com>2017-10-27 12:12:25 -0700
commit6ac449716255e55fe6df31da3507bd97e1d5dc40 (patch)
treee5faf6d4b648d35765290c5405b742e920eedd85 /src/lib
parentb550581dde0082176e3652a0f5c0174610611785 (diff)
eina: fix spelling errors in documentation
Reviewers: cedric, ajwillia.ms Reviewed By: cedric Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5395 Signed-off-by: Cedric Bail <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/eina/eina_array.h12
-rw-r--r--src/lib/eina/eina_benchmark.h18
-rw-r--r--src/lib/eina/eina_bezier.h4
-rw-r--r--src/lib/eina/eina_binbuf.h10
-rw-r--r--src/lib/eina/eina_convert.h2
-rw-r--r--src/lib/eina/eina_counter.h8
-rw-r--r--src/lib/eina/eina_cow.h24
-rw-r--r--src/lib/eina/eina_debug.h2
-rw-r--r--src/lib/eina/eina_evlog.h16
-rw-r--r--src/lib/eina/eina_file.h4
-rw-r--r--src/lib/eina/eina_file_common.h6
-rw-r--r--src/lib/eina/eina_freeq.h4
12 files changed, 55 insertions, 55 deletions
diff --git a/src/lib/eina/eina_array.h b/src/lib/eina/eina_array.h
index c17fbd9dd0..823f824958 100644
--- a/src/lib/eina/eina_array.h
+++ b/src/lib/eina/eina_array.h
@@ -43,7 +43,7 @@
43 * Here we have a callback that prints the element given to it: 43 * Here we have a callback that prints the element given to it:
44 * @until } 44 * @until }
45 * 45 *
46 * Now we create our entry point and declare some variables, nothing especial: 46 * Now we create our entry point and declare some variables, nothing special:
47 * @until unsigned 47 * @until unsigned
48 * 48 *
49 * Before we can start using any array function we need to initialize eina: 49 * Before we can start using any array function we need to initialize eina:
@@ -262,7 +262,7 @@ EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_
262 * @param array The array to free. 262 * @param array The array to free.
263 * 263 *
264 * This function frees @p array. It calls first eina_array_flush() then 264 * This function frees @p array. It calls first eina_array_flush() then
265 * free the memory of the pointer. It does not free the memory 265 * frees the memory of the pointer. It does not free the memory
266 * allocated for the elements of @p array. To free them, walk the array with 266 * allocated for the elements of @p array. To free them, walk the array with
267 * #EINA_ARRAY_ITER_NEXT. 267 * #EINA_ARRAY_ITER_NEXT.
268 */ 268 */
@@ -316,7 +316,7 @@ EAPI void eina_array_flush(Eina_Array *array) EINA_ARG_NONNULL(1);
316 * @param gdata The data to pass to the function keep. 316 * @param gdata The data to pass to the function keep.
317 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 317 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
318 * 318 *
319 * This function rebuilds @p array be specifying the elements to keep with the 319 * This function rebuilds @p array by specifying the elements to keep with the
320 * function @p keep. No empty/invalid fields are left in the array. @p gdata is 320 * function @p keep. No empty/invalid fields are left in the array. @p gdata is
321 * an additional data to pass to @p keep. For performance reasons, there is no 321 * an additional data to pass to @p keep. For performance reasons, there is no
322 * check of @p array. If it is @c NULL or invalid, the program may crash. 322 * check of @p array. If it is @c NULL or invalid, the program may crash.
@@ -414,7 +414,7 @@ static inline unsigned int eina_array_count_get(const Eina_Array *array) EINA_AR
414static inline unsigned int eina_array_count(const Eina_Array *array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 414static inline unsigned int eina_array_count(const Eina_Array *array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
415 415
416/** 416/**
417 * @brief Gets a new iterator associated to an array. 417 * @brief Gets a new iterator associated with an array.
418 * 418 *
419 * @param array The array. 419 * @param array The array.
420 * @return A new iterator. 420 * @return A new iterator.
@@ -427,7 +427,7 @@ static inline unsigned int eina_array_count(const Eina_Array *array) EINA_ARG_NO
427EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 427EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
428 428
429/** 429/**
430 * @brief Gets a new accessor associated to an array. 430 * @brief Gets a new accessor associated with an array.
431 * 431 *
432 * @param array The array. 432 * @param array The array.
433 * @return A new accessor. 433 * @return A new accessor.
@@ -445,7 +445,7 @@ EAPI Eina_Accessor *eina_array_accessor_new(const Eina_Array *array) EINA
445 * @param array The array to iterate over. 445 * @param array The array to iterate over.
446 * @param cb The callback to call for each item. 446 * @param cb The callback to call for each item.
447 * @param fdata The user data to pass to the callback. 447 * @param fdata The user data to pass to the callback.
448 * @return #EINA_TRUE if it successfully iterate all items of the array. 448 * @return #EINA_TRUE if it successfully iterated all items of the array.
449 * 449 *
450 * This function provides a safe way to iterate over an array. @p cb should 450 * This function provides a safe way to iterate over an array. @p cb should
451 * return #EINA_TRUE as long as you want the function to continue iterating. 451 * return #EINA_TRUE as long as you want the function to continue iterating.
diff --git a/src/lib/eina/eina_benchmark.h b/src/lib/eina/eina_benchmark.h
index b54c984db2..695ad5673a 100644
--- a/src/lib/eina/eina_benchmark.h
+++ b/src/lib/eina/eina_benchmark.h
@@ -27,9 +27,9 @@
27 * @page tutorial_benchmark_page Benchmark Tutorial 27 * @page tutorial_benchmark_page Benchmark Tutorial
28 * 28 *
29 * The Benchmark module allows you to write easily benchmarks 29 * The Benchmark module allows you to write easily benchmarks
30 * framework in a project for timing critical part and detect slow 30 * framework to a project for timing critical parts and detecting slow
31 * parts of code. In addition it automatically creates data files of 31 * parts of code. In addition it automatically creates data files of
32 * these benchmark, as well as a gnuplot file which can display the 32 * these benchmarks, as well as a gnuplot file which can display the
33 * comparison curves of the benchmarks. 33 * comparison curves of the benchmarks.
34 * 34 *
35 * @section tutorial_benchmark_basic_usage Basic Usage 35 * @section tutorial_benchmark_basic_usage Basic Usage
@@ -116,7 +116,7 @@
116 * The first column (specimen) is the integer passed to the work1() 116 * The first column (specimen) is the integer passed to the work1()
117 * function when the test is run. The second column (experiment time) 117 * function when the test is run. The second column (experiment time)
118 * is the time, in nanosecond, that work1() takes. The third and 118 * is the time, in nanosecond, that work1() takes. The third and
119 * fourth column are self-explicit. 119 * fourth columns are self-explicit.
120 * 120 *
121 * You can see that the integer passed work1() starts from 200 and 121 * You can see that the integer passed work1() starts from 200 and
122 * finishes at 290, with a step of 10. These values are computed withe 122 * finishes at 290, with a step of 10. These values are computed withe
@@ -297,8 +297,8 @@
297/** 297/**
298 * @addtogroup Eina_Benchmark_Group Benchmark 298 * @addtogroup Eina_Benchmark_Group Benchmark
299 * 299 *
300 * These functions allow you to add benchmark framework in a project 300 * These functions allow you to add a benchmark framework to a project
301 * for timing critical part and detect slow parts of code. It is used 301 * for timing critical parts and detecting slow parts of code. It is used
302 * in Eina to compare the time used by eina, glib, evas and ecore data 302 * in Eina to compare the time used by eina, glib, evas and ecore data
303 * types. 303 * types.
304 * 304 *
@@ -364,9 +364,9 @@ typedef void (*Eina_Benchmark_Specimens)(int request);
364 * This function creates a new benchmark. @p name and @p run are used 364 * This function creates a new benchmark. @p name and @p run are used
365 * to name the gnuplot file that eina_benchmark_run() will create. 365 * to name the gnuplot file that eina_benchmark_run() will create.
366 * 366 *
367 * This function return a valid benchmark on success, or @c NULL if 367 * This function returns a valid benchmark on success, or @c NULL if
368 * memory allocation fails. 368 * memory allocation fails.
369 * 369 *
370 * When the new module is not needed anymore, use 370 * When the new module is not needed anymore, use
371 * eina_benchmark_free() to free the allocated memory. 371 * eina_benchmark_free() to free the allocated memory.
372 */ 372 */
@@ -418,8 +418,8 @@ EAPI Eina_Bool eina_benchmark_register(Eina_Benchmark *bench,
418 * @param bench The benchmark. 418 * @param bench The benchmark.
419 * @return The list of names of the test files. 419 * @return The list of names of the test files.
420 * 420 *
421 * This function runs all the tests that as been registered with 421 * This function runs all the tests that have been registered with
422 * eina_benchmark_register() and save the result in a gnuplot 422 * eina_benchmark_register() and saves the result in a gnuplot
423 * file. The name of the file has the following format: 423 * file. The name of the file has the following format:
424 * 424 *
425 * @code 425 * @code
diff --git a/src/lib/eina/eina_bezier.h b/src/lib/eina/eina_bezier.h
index dfbee11d4e..ab9b8e1b8f 100644
--- a/src/lib/eina/eina_bezier.h
+++ b/src/lib/eina/eina_bezier.h
@@ -144,7 +144,7 @@ EAPI double eina_bezier_angle_at(const Eina_Bezier *b, double t) EINA_ARG_NONNUL
144EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bezier *left, Eina_Bezier *right) EINA_ARG_NONNULL(1); 144EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bezier *left, Eina_Bezier *right) EINA_ARG_NONNULL(1);
145 145
146/** 146/**
147 * @brief Gets the bound of the the bezier. 147 * @brief Gets the bounds of the bezier.
148 * 148 *
149 * @param b The floating point bezier. 149 * @param b The floating point bezier.
150 * @param x x coordinate of bounding box. 150 * @param x x coordinate of bounding box.
@@ -158,7 +158,7 @@ EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bez
158EAPI void eina_bezier_bounds_get(const Eina_Bezier *b, double *x, double *y, double *w, double *h) EINA_ARG_NONNULL(1); 158EAPI void eina_bezier_bounds_get(const Eina_Bezier *b, double *x, double *y, double *w, double *h) EINA_ARG_NONNULL(1);
159 159
160/** 160/**
161 * @brief Finds the bezier at given interval. 161 * @brief Finds the bezier at the given interval.
162 * 162 *
163 * @param b The floating point bezier. 163 * @param b The floating point bezier.
164 * @param t0 The start interval. 164 * @param t0 The start interval.
diff --git a/src/lib/eina/eina_binbuf.h b/src/lib/eina/eina_binbuf.h
index e84453731e..cea0c93f38 100644
--- a/src/lib/eina/eina_binbuf.h
+++ b/src/lib/eina/eina_binbuf.h
@@ -10,7 +10,7 @@
10/** 10/**
11 * @addtogroup Eina_Binary_Buffer_Group Binary Buffer 11 * @addtogroup Eina_Binary_Buffer_Group Binary Buffer
12 * 12 *
13 * @brief These functions provide string buffers management. 13 * @brief These functions provide string buffer management.
14 * 14 *
15 * The Binary Buffer data type is designed to be a mutable string, 15 * The Binary Buffer data type is designed to be a mutable string,
16 * allowing to append, prepend or insert a string to a buffer. 16 * allowing to append, prepend or insert a string to a buffer.
@@ -125,8 +125,8 @@ EAPI void eina_binbuf_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
125 * 125 *
126 * @param buf The string buffer to reset. 126 * @param buf The string buffer to reset.
127 * 127 *
128 * This function reset @p buf: the buffer len is set to 0, and the 128 * This function resets @p buf: the buffer len is set to 0, and the
129 * string is set to '\\0'. No memory is free'd. 129 * string is set to '\\0'. No memory is freed.
130 */ 130 */
131EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); 131EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
132 132
@@ -193,7 +193,7 @@ EAPI Eina_Bool eina_binbuf_use(Eina_Binbuf *buf, size_t extra_bytes) EINA_ARG_NO
193 * This function appends @p str to @p buf. @p str must be of size at 193 * This function appends @p str to @p buf. @p str must be of size at
194 * most @p length. It is slightly faster than eina_binbuf_append() as 194 * most @p length. It is slightly faster than eina_binbuf_append() as
195 * it does not compute the size of @p str. It is useful when dealing 195 * it does not compute the size of @p str. It is useful when dealing
196 * with strings of known size, such as eina_strngshare. If @p buf 196 * with strings of known size, such as eina_stringshare. If @p buf
197 * can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is 197 * can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
198 * returned. 198 * returned.
199 * 199 *
@@ -261,7 +261,7 @@ EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_A
261 * This function inserts @p str to @p buf. @p str must be of size at 261 * This function inserts @p str to @p buf. @p str must be of size at
262 * most @p length. It is slightly faster than eina_binbuf_insert() as 262 * most @p length. It is slightly faster than eina_binbuf_insert() as
263 * it does not compute the size of @p str. It is useful when dealing 263 * it does not compute the size of @p str. It is useful when dealing
264 * with strings of known size, such as eina_strngshare. If @p buf 264 * with strings of known size, such as eina_stringshare. If @p buf
265 * can't insert it, #EINA_FALSE is returned, otherwise #EINA_TRUE is 265 * can't insert it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
266 * returned. 266 * returned.
267 * 267 *
diff --git a/src/lib/eina/eina_convert.h b/src/lib/eina/eina_convert.h
index 1234e4cf50..5d74bafd78 100644
--- a/src/lib/eina/eina_convert.h
+++ b/src/lib/eina/eina_convert.h
@@ -312,7 +312,7 @@ EAPI int eina_convert_fptoa(Eina_F32p32 fp,
312 * [-]0xh.hhhhhp[+-]e 312 * [-]0xh.hhhhhp[+-]e
313 * @endcode 313 * @endcode
314 * 314 *
315 * where the h are the hexadecimal cyphers of the mantissas and e the 315 * where the h's are the hexadecimal cyphers of the mantissas and e the
316 * exponent (a decimal number). If n is the number of cyphers after the 316 * exponent (a decimal number). If n is the number of cyphers after the
317 * point, the returned mantissas and exponents are: 317 * point, the returned mantissas and exponents are:
318 * 318 *
diff --git a/src/lib/eina/eina_counter.h b/src/lib/eina/eina_counter.h
index a4ad3395b6..ca56ba5024 100644
--- a/src/lib/eina/eina_counter.h
+++ b/src/lib/eina/eina_counter.h
@@ -33,7 +33,7 @@
33 * eina_counter_free(). 33 * eina_counter_free().
34 * 34 *
35 * To time a part of a code, call eina_counter_start() just before it, 35 * To time a part of a code, call eina_counter_start() just before it,
36 * and eina_counter_stop() just after it. Each time you start to time 36 * and eina_counter_stop() just after it. Each time you start timing
37 * a code, a clock is added to a list. You can give the number of that 37 * a code, a clock is added to a list. You can give the number of that
38 * clock with the second argument of eina_counter_stop(). To send all 38 * clock with the second argument of eina_counter_stop(). To send all
39 * the registered clocks to a stream (like stdout, for a file), use 39 * the registered clocks to a stream (like stdout, for a file), use
@@ -121,7 +121,7 @@ typedef struct _Eina_Counter Eina_Counter;
121 * @param[in] name The name of the counter 121 * @param[in] name The name of the counter
122 * @return A newly allocated counter 122 * @return A newly allocated counter
123 * 123 *
124 * @note Whe the new counter is not needed anymore, use eina_counter_free() to 124 * @note When the new counter is not needed anymore, use eina_counter_free() to
125 * free the allocated memory. 125 * free the allocated memory.
126 */ 126 */
127EAPI Eina_Counter *eina_counter_new(const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 127EAPI Eina_Counter *eina_counter_new(const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
@@ -145,8 +145,8 @@ EAPI void eina_counter_free(Eina_Counter *counter) EINA_ARG_NONNULL(1);
145 * 145 *
146 * @param[in] counter The counter 146 * @param[in] counter The counter
147 * 147 *
148 * @note This function adds the clock associated to @p counter in a list. If 148 * @note This function adds the clock associated with @p counter in a list. If
149 * the memory needed by that clock can not be allocated, the function 149 * the memory needed by that clock cannot be allocated, the function
150 * returns and nothing is done. 150 * returns and nothing is done.
151 * 151 *
152 * @note To stop the timing, eina_counter_stop() must be called with the 152 * @note To stop the timing, eina_counter_stop() must be called with the
diff --git a/src/lib/eina/eina_cow.h b/src/lib/eina/eina_cow.h
index c98c4b60f1..347a8c5c62 100644
--- a/src/lib/eina/eina_cow.h
+++ b/src/lib/eina/eina_cow.h
@@ -29,11 +29,11 @@
29/** 29/**
30 * @defgroup Eina_Cow_Group Copy On Write 30 * @defgroup Eina_Cow_Group Copy On Write
31 * 31 *
32 * @brief These functions provide some helper for a pseudo Copy On Write mechanism. 32 * @brief These functions provide some helper for a pseudo Copy-On-Write mechanism.
33 * 33 *
34 * Eina_Cow will return const memory pointer to some default value that you will 34 * Eina_Cow will return a const memory pointer to some default value that you will
35 * be able to change only by requesting a writable pointer. Later on a garbage collector 35 * be able to change only by requesting a writable pointer. Later on a garbage collector
36 * can come online and try to merge back some of those pointer. 36 * can come online and try to merge back some of those pointers.
37 * 37 *
38 * @since 1.8.0 38 * @since 1.8.0
39 * 39 *
@@ -54,7 +54,7 @@ typedef void Eina_Cow_Data;
54/** 54/**
55 * @brief Instantiates a new Eina_Cow pool. 55 * @brief Instantiates a new Eina_Cow pool.
56 * 56 *
57 * @param name The name of this pool, used for debug. 57 * @param name The name of this pool, used for debugging.
58 * @param struct_size The size of the object from this pool. 58 * @param struct_size The size of the object from this pool.
59 * @param step How many objects to allocate when the pool gets empty. 59 * @param step How many objects to allocate when the pool gets empty.
60 * @param default_value The default value returned by this pool. 60 * @param default_value The default value returned by this pool.
@@ -89,7 +89,7 @@ EAPI void eina_cow_free(Eina_Cow *cow, const Eina_Cow_Data **data);
89 89
90/** 90/**
91 * @brief Gets a writeable pointer from a const pointer. 91 * @brief Gets a writeable pointer from a const pointer.
92 * @param cow The pool the pointer come from. 92 * @param cow The pool the pointer came from.
93 * @param src The pointer you want to write to. 93 * @param src The pointer you want to write to.
94 * 94 *
95 * NOTE: this function is not thread safe, be careful. 95 * NOTE: this function is not thread safe, be careful.
@@ -98,7 +98,7 @@ EAPI void *eina_cow_write(Eina_Cow *cow,
98 const Eina_Cow_Data * const *src) EINA_WARN_UNUSED_RESULT; 98 const Eina_Cow_Data * const *src) EINA_WARN_UNUSED_RESULT;
99/** 99/**
100 * @brief Sets back a pointer into read only. 100 * @brief Sets back a pointer into read only.
101 * @param cow The pool the pointer come from. 101 * @param cow The pool the pointer came from.
102 * @param dst The read only version of the pointer. 102 * @param dst The read only version of the pointer.
103 * @param data The pointer to which data was written to. 103 * @param data The pointer to which data was written to.
104 * @param needed_gc Does this pool need to be garbage collected? 104 * @param needed_gc Does this pool need to be garbage collected?
@@ -111,7 +111,7 @@ EAPI void eina_cow_done(Eina_Cow *cow,
111 Eina_Bool needed_gc); 111 Eina_Bool needed_gc);
112/** 112/**
113 * @brief Makes the destination contain the same thing as the source pointer. 113 * @brief Makes the destination contain the same thing as the source pointer.
114 * @param cow The pool the pointers come from. 114 * @param cow The pool the pointers came from.
115 * @param dst The destination to update. 115 * @param dst The destination to update.
116 * @param src The source of information to copy. 116 * @param src The source of information to copy.
117 */ 117 */
@@ -126,20 +126,20 @@ EAPI void eina_cow_memcpy(Eina_Cow *cow,
126 * 126 *
127 * There is no guaranty in the time it will require, but should remain low. 127 * There is no guaranty in the time it will require, but should remain low.
128 * It does run a hash function on all possible common structures trying to 128 * It does run a hash function on all possible common structures trying to
129 * find the one that match and merge them into one pointer. 129 * find the one that matches and merge them into one pointer.
130 */ 130 */
131EAPI Eina_Bool eina_cow_gc(Eina_Cow *cow); 131EAPI Eina_Bool eina_cow_gc(Eina_Cow *cow);
132 132
133/** 133/**
134 * @def EINA_COW_WRITE_BEGIN 134 * @def EINA_COW_WRITE_BEGIN
135 * @brief Definition for the macro to setup a writeable pointer from a const one. 135 * @brief Definition for the macro to setup a writeable pointer from a const one.
136 * @param Cow The Eina_Cow where the const pointer come from. 136 * @param Cow The Eina_Cow where the const pointer came from.
137 * @param Read The const pointer to get a writable handler from. 137 * @param Read The const pointer to get a writable handler from.
138 * @param Write_Type The type of the pointer you want to write to. 138 * @param Write_Type The type of the pointer you want to write to.
139 * @param Write The name of the variable where to put the writeable pointer to. 139 * @param Write The name of the variable where to put the writeable pointer to.
140 * @since 1.8.0 140 * @since 1.8.0
141 * 141 *
142 * Be careful this macro opens a C scope that is expected to be closed by 142 * Be careful: this macro opens a C scope that is expected to be closed by
143 * EINA_COW_WRITE_END(). 143 * EINA_COW_WRITE_END().
144 */ 144 */
145#define EINA_COW_WRITE_BEGIN(Cow, Read, Write_Type, Write) \ 145#define EINA_COW_WRITE_BEGIN(Cow, Read, Write_Type, Write) \
@@ -152,12 +152,12 @@ EAPI Eina_Bool eina_cow_gc(Eina_Cow *cow);
152/** 152/**
153 * @def EINA_COW_WRITE_END 153 * @def EINA_COW_WRITE_END
154 * @brief Definition for the macro to close the writeable pointer. 154 * @brief Definition for the macro to close the writeable pointer.
155 * @param Cow The Eina_Cow where the const pointer come from. 155 * @param Cow The Eina_Cow where the const pointer came from.
156 * @param Read The const pointer to get a writable handler from. 156 * @param Read The const pointer to get a writable handler from.
157 * @param Write The name of the variable where to put the writeable pointer to. 157 * @param Write The name of the variable where to put the writeable pointer to.
158 * @since 1.8.0 158 * @since 1.8.0
159 * 159 *
160 * Be careful this macro close the scope opened by EINA_COW_WRITE_BEGIN(). 160 * Be careful: this macro close the scope opened by EINA_COW_WRITE_BEGIN().
161 */ 161 */
162#define EINA_COW_WRITE_END(Cow, Read, Write) \ 162#define EINA_COW_WRITE_END(Cow, Read, Write) \
163 eina_cow_done(Cow, ((const Eina_Cow_Data**)&(Read)), Write, \ 163 eina_cow_done(Cow, ((const Eina_Cow_Data**)&(Read)), Write, \
diff --git a/src/lib/eina/eina_debug.h b/src/lib/eina/eina_debug.h
index 42afe19bed..a5ef86b0f3 100644
--- a/src/lib/eina/eina_debug.h
+++ b/src/lib/eina/eina_debug.h
@@ -216,7 +216,7 @@ EAPI Eina_Debug_Dispatch_Cb eina_debug_session_dispatch_get(Eina_Debug_Session *
216/** 216/**
217 * @brief Dispatch a given packet according to its header. 217 * @brief Dispatch a given packet according to its header.
218 * 218 *
219 * This function checks the header contained into the packet and invokes 219 * This function checks the header contained in the packet and invokes
220 * the correct callback according to the opcode. 220 * the correct callback according to the opcode.
221 * This is the default dispatcher. 221 * This is the default dispatcher.
222 * 222 *
diff --git a/src/lib/eina/eina_evlog.h b/src/lib/eina/eina_evlog.h
index 65f7908651..4369ace253 100644
--- a/src/lib/eina/eina_evlog.h
+++ b/src/lib/eina/eina_evlog.h
@@ -52,14 +52,14 @@ struct _Eina_Evlog_Buf
52 unsigned char *buf; // current buffer we fill with event logs 52 unsigned char *buf; // current buffer we fill with event logs
53 unsigned int size; // the max size of the evlog buffer 53 unsigned int size; // the max size of the evlog buffer
54 unsigned int top; // the current top byte for a new evlog item 54 unsigned int top; // the current top byte for a new evlog item
55 unsigned int overflow; // how many times this buffer has overflown 55 unsigned int overflow; // how many times this buffer has overflowed
56}; 56};
57 57
58/** 58/**
59 * @brief Logs an event in our event log for profiling data. 59 * @brief Logs an event in our event log for profiling data.
60 * 60 *
61 * Log some interesting event inside of EFL, eg a wakeup (and why etc.). 61 * Log some interesting event inside of EFL, eg a wakeup (and why etc.).
62 * The @p event string must alwasy be provided and be of the form: 62 * The @p event string must always be provided and be of the form:
63 * 63 *
64 * "+eventname" 64 * "+eventname"
65 * "-eventname" 65 * "-eventname"
@@ -72,12 +72,12 @@ struct _Eina_Evlog_Buf
72 * events logged are really children of this event). The "-" char means an 72 * events logged are really children of this event). The "-" char means an
73 * event is ending and so all child events SHOULD have ended by now. A "!" 73 * event is ending and so all child events SHOULD have ended by now. A "!"
74 * character means the event is a one-off with no beginning or end. A"*" 74 * character means the event is a one-off with no beginning or end. A"*"
75 * Means this is special metadata and the defail field may need special 75 * means this is special metadata and the detail field may need special
76 * parsing based on the eventname, so ignroe unless known. A ">" 76 * parsing based on the eventname, so ignore unless known. A ">"
77 * character means we begin this "state" of the process (these are separate 77 * character means we begin this "state" of the process (these are separate
78 * to "+" and "-" events and don't nest - arenot related to a thread or 78 * to "+" and "-" events and don't nest - are not related to a thread or
79 * any other event, but just a state). "<" Ends the given state given by 79 * any other event, but just a state). "<" Ends the given state given by
80 * the "eventname" spart of the string. Any string following this initial 80 * the "eventname" part of the string. Any string following this initial
81 * character is the event or state name (and must be provided in the exact 81 * character is the event or state name (and must be provided in the exact
82 * same string at both "+", "<" and "-", ">" events). This is what will be 82 * same string at both "+", "<" and "-", ">" events). This is what will be
83 * displayed in a debugger (and may be a well known string thus given a nice 83 * displayed in a debugger (and may be a well known string thus given a nice
@@ -89,11 +89,11 @@ struct _Eina_Evlog_Buf
89 * The @p object is optional, and if not used, pass in NULL. If it is used, 89 * The @p object is optional, and if not used, pass in NULL. If it is used,
90 * it can be a pointer to anything. It is intended simply to be of use to 90 * it can be a pointer to anything. It is intended simply to be of use to
91 * indicate an event happens on object A vs object B. What this points to 91 * indicate an event happens on object A vs object B. What this points to
92 * is irrelevant as the pointer is never de-references or used other than 92 * is irrelevant as the pointer is never de-referenced or used other than
93 * as a label to differentiate an event on 2 different objects. 93 * as a label to differentiate an event on 2 different objects.
94 * 94 *
95 * The @p srctime parameter is 0.0 if not used, or if used, contains a 95 * The @p srctime parameter is 0.0 if not used, or if used, contains a
96 * timepoint for an event that triggered this one. For example, if a device 96 * timepoint for an event that triggered this once. For example, if a device
97 * or hardware interrupt causes this event, that device may provide a 97 * or hardware interrupt causes this event, that device may provide a
98 * timestamp/timepoint as part of the device information to indicate the 98 * timestamp/timepoint as part of the device information to indicate the
99 * exact time the hardware interrupt happened. This can be useful to have 99 * exact time the hardware interrupt happened. This can be useful to have
diff --git a/src/lib/eina/eina_file.h b/src/lib/eina/eina_file.h
index 9fd08a434e..86bce9e2b3 100644
--- a/src/lib/eina/eina_file.h
+++ b/src/lib/eina/eina_file.h
@@ -34,7 +34,7 @@
34 * @page eina_file_example_01_page 34 * @page eina_file_example_01_page
35 * @dontinclude eina_file_01.c 35 * @dontinclude eina_file_01.c
36 * 36 *
37 * To include brevity, variable declarations and initialization is omitted 37 * For brevity, variable declarations and initialization are omitted
38 * from this page, however the full source code can be seen @ref 38 * from this page, however the full source code can be seen @ref
39 * eina_file_example_01 "here". 39 * eina_file_example_01 "here".
40 * 40 *
@@ -512,7 +512,7 @@ EAPI Eina_File *
512eina_file_virtualize(const char *virtual_name, const void *data, unsigned long long length, Eina_Bool copy) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 512eina_file_virtualize(const char *virtual_name, const void *data, unsigned long long length, Eina_Bool copy) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
513 513
514/** 514/**
515 * @brief Tells if a file is a real file or only exist in memory. 515 * @brief Tells if a file is a real file or only exists in memory.
516 * 516 *
517 * @param file The file to test 517 * @param file The file to test
518 * @return #EINA_TRUE if the file is a virtual file 518 * @return #EINA_TRUE if the file is a virtual file
diff --git a/src/lib/eina/eina_file_common.h b/src/lib/eina/eina_file_common.h
index 93ba274923..cc041f64b2 100644
--- a/src/lib/eina/eina_file_common.h
+++ b/src/lib/eina/eina_file_common.h
@@ -139,7 +139,7 @@ struct _Eina_Lines_Iterator
139 const char *map; /**< A pointer to the head of the file that has been mapped with mmap(2). */ 139 const char *map; /**< A pointer to the head of the file that has been mapped with mmap(2). */
140 const char *end; /**< A pointer to the end of the file that has been mapped with mmap(2). */ 140 const char *end; /**< A pointer to the end of the file that has been mapped with mmap(2). */
141 141
142 int boundary; /**< Curretnly hard coded to 4096. */ 142 int boundary; /**< Currently hard coded to 4096. */
143 143
144 Eina_File_Line current; /**< The current line */ 144 Eina_File_Line current; /**< The current line */
145}; 145};
@@ -176,7 +176,7 @@ struct _Eina_Lines_Iterator
176 176
177/** 177/**
178 * @brief Determines if a path is relative or absolute. 178 * @brief Determines if a path is relative or absolute.
179 * The implementation simply chekcs if the fist char in the path is '/'. If it 179 * The implementation simply chekcs if the first char in the path is '/'. If it
180 * is not, the path is considered relative. 180 * is not, the path is considered relative.
181 * 181 *
182 * @param path The path to check. 182 * @param path The path to check.
@@ -300,7 +300,7 @@ void eina_file_virtual_map_free(Eina_File *file, void *map);
300 * @warning This function is not yet implemented. At present it ony returns 300 * @warning This function is not yet implemented. At present it ony returns
301 * @code sizeof (unsigned long int) * 2 @endcode 301 * @code sizeof (unsigned long int) * 2 @endcode
302 * 302 *
303 * @param key The key for which length will be calcualted. 303 * @param key The key for which length will be calculated.
304 * 304 *
305 * @return The length of the key. 305 * @return The length of the key.
306 * 306 *
diff --git a/src/lib/eina/eina_freeq.h b/src/lib/eina/eina_freeq.h
index e6fed415c2..834e168764 100644
--- a/src/lib/eina/eina_freeq.h
+++ b/src/lib/eina/eina_freeq.h
@@ -25,7 +25,7 @@
25 * it to 0 to force the free queue to work and delay freeing of items. 25 * it to 0 to force the free queue to work and delay freeing of items.
26 * Note that you can override this by setting count or mem max by 26 * Note that you can override this by setting count or mem max by
27 * eina_freeq_count_max_set() or eina_freeq_mem_max_set() which will 27 * eina_freeq_count_max_set() or eina_freeq_mem_max_set() which will
28 * disable bypass for that specific free queue. once bypass is disabled 28 * disable bypass for that specific free queue. Once bypass is disabled
29 * it cannot be re-enabled. 29 * it cannot be re-enabled.
30 * 30 *
31 * EINA_FREEQ_FILL_MAX=N 31 * EINA_FREEQ_FILL_MAX=N
@@ -50,7 +50,7 @@
50 * 50 *
51 * EINA_FREEQ_FILL=N 51 * EINA_FREEQ_FILL=N
52 * 52 *
53 * This sets the buyte value to write to every byte of an allocation that 53 * This sets the byte value to write to every byte of an allocation that
54 * is added to the free queue when it is added to mark the data as invalid. 54 * is added to the free queue when it is added to mark the data as invalid.
55 * The default value is 0x55 (85). Memory is only filled if the size of 55 * The default value is 0x55 (85). Memory is only filled if the size of
56 * the allocation is less than the max that you can adjust with 56 * the allocation is less than the max that you can adjust with