summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-11-01 11:36:50 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-11-01 11:36:50 +0900
commit054e81757257a2aa08d3ff3eca8d12bd6a38b865 (patch)
tree4cb4ae40afa39f864bbdd43cc24f3a0845506153 /src
parent9cec14918c089d94a742cb067872181dd452b7ef (diff)
eina: Fix spelling errors in documentation (log..matrix)
Reviewers: cedric, ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5417
Diffstat (limited to 'src')
-rw-r--r--src/lib/eina/eina_log.h9
-rw-r--r--src/lib/eina/eina_magic.h10
-rw-r--r--src/lib/eina/eina_main.h12
-rw-r--r--src/lib/eina/eina_matrix.h22
4 files changed, 26 insertions, 27 deletions
diff --git a/src/lib/eina/eina_log.h b/src/lib/eina/eina_log.h
index a78056e12e..5f855ddeb0 100644
--- a/src/lib/eina/eina_log.h
+++ b/src/lib/eina/eina_log.h
@@ -48,7 +48,7 @@
48 * The Eina Log module provides logging facilities for libraries and 48 * The Eina Log module provides logging facilities for libraries and
49 * applications. It provides colored logging, basic logging levels (error, 49 * applications. It provides colored logging, basic logging levels (error,
50 * warning, debug, info, critical) and loggers - called logging domains - 50 * warning, debug, info, critical) and loggers - called logging domains -
51 * which will be covered on next sections. 51 * which will be covered in next sections.
52 * 52 *
53 * @section tutorial_log_basic_usage Basic Usage 53 * @section tutorial_log_basic_usage Basic Usage
54 * 54 *
@@ -71,7 +71,7 @@
71 * log messages into a context (e.g. a module) and provide a way of controlling 71 * log messages into a context (e.g. a module) and provide a way of controlling
72 * this set as a whole. 72 * this set as a whole.
73 * 73 *
74 * For example, suppose you have 3 different modules on your application and you 74 * For example, suppose you have 3 different modules in your application and you
75 * want to get logging only from one of them (e.g. create some sort of filter). 75 * want to get logging only from one of them (e.g. create some sort of filter).
76 * For achieving that, all you need to do is create a logging domain for each 76 * For achieving that, all you need to do is create a logging domain for each
77 * module so that all logging inside a module can be considered as a whole. 77 * module so that all logging inside a module can be considered as a whole.
@@ -742,7 +742,7 @@ static inline Eina_Bool eina_log_domain_level_check(int domain, int level);
742 * @param color Color of the domain name 742 * @param color Color of the domain name
743 * 743 *
744 * @return Domain index that will be used as the DOMAIN parameter on log 744 * @return Domain index that will be used as the DOMAIN parameter on log
745 * macros. A negative return value means an log occurred. 745 * macros. A negative return value means an error occurred.
746 * 746 *
747 * @note MT: Safe to call from any thread. 747 * @note MT: Safe to call from any thread.
748 */ 748 */
@@ -886,8 +886,7 @@ EAPI void eina_log_print_cb_stdout(const Eina_Log_Domain *d,
886 * EINA_LOG_COLOR_DISABLE=0. If EINA_LOG_COLOR_DISABLE is unset (or 886 * EINA_LOG_COLOR_DISABLE=0. If EINA_LOG_COLOR_DISABLE is unset (or
887 * -1), then Eina will disable color if terminal ($TERM) is 887 * -1), then Eina will disable color if terminal ($TERM) is
888 * unsupported or if redirecting to a file. 888 * unsupported or if redirecting to a file.
889 889 * Similarly, to disable file and line
890 . Similarly, to disable file and line
891 * information, set EINA_LOG_FILE_DISABLE=1 or 890 * information, set EINA_LOG_FILE_DISABLE=1 or
892 * EINA_LOG_FUNCTION_DISABLE=1 to avoid function name in output. It is 891 * EINA_LOG_FUNCTION_DISABLE=1 to avoid function name in output. It is
893 * not acceptable to have both EINA_LOG_FILE_DISABLE and 892 * not acceptable to have both EINA_LOG_FILE_DISABLE and
diff --git a/src/lib/eina/eina_magic.h b/src/lib/eina/eina_magic.h
index 57643d40c1..7222f045f2 100644
--- a/src/lib/eina/eina_magic.h
+++ b/src/lib/eina/eina_magic.h
@@ -133,7 +133,7 @@
133typedef unsigned int Eina_Magic; 133typedef unsigned int Eina_Magic;
134 134
135/** 135/**
136 * @brief Gets the string associated to the given magic identifier. 136 * @brief Gets the string associated with the given magic identifier.
137 * @details This function returns the string associated to @p magic. Even if none are 137 * @details This function returns the string associated to @p magic. Even if none are
138 * found this function still returns non @c NULL, in this case an identifier 138 * found this function still returns non @c NULL, in this case an identifier
139 * such as "(none)", "(undefined)", or "(unknown)". 139 * such as "(none)", "(undefined)", or "(unknown)".
@@ -152,13 +152,13 @@ typedef unsigned int Eina_Magic;
152 */ 152 */
153EAPI const char *eina_magic_string_get(Eina_Magic magic) EINA_WARN_UNUSED_RESULT; 153EAPI const char *eina_magic_string_get(Eina_Magic magic) EINA_WARN_UNUSED_RESULT;
154/** 154/**
155 * @brief Sets the string associated to the given magic identifier. 155 * @brief Sets the string associated with the given magic identifier.
156 * @details This function sets the string @p magic_name to @p magic. It is not 156 * @details This function sets the string @p magic_name to @p magic. It is not
157 * checked if number or string are already set, in which case you end with 157 * checked if number or string are already set, in which case you end with
158 * duplicates. Internally, eina makes a copy of @p magic_name. 158 * duplicates. Internally, eina makes a copy of @p magic_name.
159 * 159 *
160 * @param[in] magic The magic identifier 160 * @param[in] magic The magic identifier
161 * @param[in] magic_name The string associated to the identifier, must not 161 * @param[in] magic_name The string associated with the identifier, must not
162 * be @c NULL 162 * be @c NULL
163 * 163 *
164 * @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure 164 * @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure
@@ -169,14 +169,14 @@ EAPI Eina_Bool eina_magic_string_set(Eina_Magic magic,
169 const char *magic_name) EINA_ARG_NONNULL(2); 169 const char *magic_name) EINA_ARG_NONNULL(2);
170 170
171/** 171/**
172 * @brief Sets the string associated to the given magic identifier. 172 * @brief Sets the string associated with the given magic identifier.
173 * @details This function sets the string @p magic_name to @p magic. It is not checked if 173 * @details This function sets the string @p magic_name to @p magic. It is not checked if
174 * number or string are already set, in which case you might end with 174 * number or string are already set, in which case you might end with
175 * duplicates. Eina does @b not make a copy of @p magic_name, this means that 175 * duplicates. Eina does @b not make a copy of @p magic_name, this means that
176 * @p magic_name has to be a valid pointer for as long as @p magic is used. 176 * @p magic_name has to be a valid pointer for as long as @p magic is used.
177 * 177 *
178 * @param[in] magic The magic identifier 178 * @param[in] magic The magic identifier
179 * @param[in] magic_name The string associated to the identifier, must not be 179 * @param[in] magic_name The string associated with the identifier, must not be
180 * @c NULL 180 * @c NULL
181 * 181 *
182 * @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure 182 * @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure
diff --git a/src/lib/eina/eina_main.h b/src/lib/eina/eina_main.h
index 12b4b1dcd8..c7a2d9e303 100644
--- a/src/lib/eina/eina_main.h
+++ b/src/lib/eina/eina_main.h
@@ -26,7 +26,7 @@
26/** 26/**
27 * @addtogroup Eina_Main_Group Main 27 * @addtogroup Eina_Main_Group Main
28 * 28 *
29 * @brief These functions provide general initialisation and shut down 29 * @brief These functions provide general initialization and shut down
30 * functions. 30 * functions.
31 */ 31 */
32 32
@@ -183,10 +183,10 @@ EAPI int eina_init(void);
183 * 183 *
184 * This function shuts down the Eina library. It returns 0 when it has 184 * This function shuts down the Eina library. It returns 0 when it has
185 * been called the same number of times than eina_init(). In that case 185 * been called the same number of times than eina_init(). In that case
186 * it shut down all the Eina modules. 186 * it shuts down all the Eina modules.
187 * 187 *
188 * Once this function succeeds (that is, @c 0 is returned), you must 188 * Once this function succeeds (that is, @c 0 is returned), you must
189 * not call any of the Eina function anymore. You must call 189 * not call any of the Eina functions anymore. You must call
190 * eina_init() again to use the Eina functions again. 190 * eina_init() again to use the Eina functions again.
191 */ 191 */
192EAPI int eina_shutdown(void); 192EAPI int eina_shutdown(void);
@@ -219,7 +219,7 @@ EAPI int eina_threads_init(void);
219 * it shut down all the mutexes. 219 * it shut down all the mutexes.
220 * 220 *
221 * Once this function succeeds (that is, @c 0 is returned), you must 221 * Once this function succeeds (that is, @c 0 is returned), you must
222 * not call any of the Eina function in a thread anymore. You must call 222 * not call any of the Eina functions in a thread anymore. You must call
223 * eina_threads_init() again to use the Eina functions in a thread again. 223 * eina_threads_init() again to use the Eina functions in a thread again.
224 * 224 *
225 * This function should never be called outside of the main loop. 225 * This function should never be called outside of the main loop.
@@ -233,14 +233,14 @@ EAPI int eina_threads_shutdown(void);
233 * 233 *
234 * @since 1.1.0 234 * @since 1.1.0
235 * 235 *
236 * Most EFL function are not thread safe and all the call need to happen in 236 * Most EFL functions are not thread safe and all the calls need to happen in
237 * the main loop. With this call you could know if you can call an EFL 237 * the main loop. With this call you could know if you can call an EFL
238 * function or not. 238 * function or not.
239 */ 239 */
240EAPI Eina_Bool eina_main_loop_is(void); 240EAPI Eina_Bool eina_main_loop_is(void);
241 241
242/** 242/**
243 * @brief You should never use that function except if you really really know what your are doing. 243 * @brief You should never use this function except if you really really know what your are doing.
244 * @since 1.1.0 244 * @since 1.1.0
245 * 245 *
246 * If you are reading this documentation, that certainly means you don't know what is the purpose of 246 * If you are reading this documentation, that certainly means you don't know what is the purpose of
diff --git a/src/lib/eina/eina_matrix.h b/src/lib/eina/eina_matrix.h
index feed8935ec..d49f5d40f1 100644
--- a/src/lib/eina/eina_matrix.h
+++ b/src/lib/eina/eina_matrix.h
@@ -253,7 +253,7 @@ EAPI Eina_Matrix_Type eina_matrix3_type_get(const Eina_Matrix3 *m);
253 * @param yy The fifth coefficient value. 253 * @param yy The fifth coefficient value.
254 * @param yz The sixth coefficient value. 254 * @param yz The sixth coefficient value.
255 * @param zx The seventh coefficient value. 255 * @param zx The seventh coefficient value.
256 * @param zy The heighth coefficient value. 256 * @param zy The eighth coefficient value.
257 * @param zz The nineth coefficient value. 257 * @param zz The nineth coefficient value.
258 * 258 *
259 * This function sets the values of the coefficients of the matrix 259 * This function sets the values of the coefficients of the matrix
@@ -280,7 +280,7 @@ EAPI void eina_matrix3_values_set(Eina_Matrix3 *m,
280 * @param yy The fifth coefficient value. 280 * @param yy The fifth coefficient value.
281 * @param yz The sixth coefficient value. 281 * @param yz The sixth coefficient value.
282 * @param zx The seventh coefficient value. 282 * @param zx The seventh coefficient value.
283 * @param zy The heighth coefficient value. 283 * @param zy The eighth coefficient value.
284 * @param zz The nineth coefficient value. 284 * @param zz The nineth coefficient value.
285 * 285 *
286 * This function gets the values of the coefficients of the matrix 286 * This function gets the values of the coefficients of the matrix
@@ -307,7 +307,7 @@ EAPI void eina_matrix3_values_get(const Eina_Matrix3 *m,
307 * @param yy The fifth coefficient value. 307 * @param yy The fifth coefficient value.
308 * @param yz The sixth coefficient value. 308 * @param yz The sixth coefficient value.
309 * @param zx The seventh coefficient value. 309 * @param zx The seventh coefficient value.
310 * @param zy The heighth coefficient value. 310 * @param zy The eighth coefficient value.
311 * @param zz The nineth coefficient value. 311 * @param zz The nineth coefficient value.
312 * 312 *
313 * This function gets the values of the coefficients of the matrix 313 * This function gets the values of the coefficients of the matrix
@@ -345,7 +345,7 @@ EAPI void eina_matrix3_matrix3_f16p16_to(const Eina_Matrix3 *m,
345 * @param m2 The second matrix. 345 * @param m2 The second matrix.
346 * @return EINA_TRUE if the two matrices are equal, @c 0 otherwise. 346 * @return EINA_TRUE if the two matrices are equal, @c 0 otherwise.
347 * 347 *
348 * This function return EINA_TRUE if thematrices @p m1 and @p m2 are 348 * This function return EINA_TRUE if the matrices @p m1 and @p m2 are
349 * equal, EINA_FALSE otherwise. No check is done on the matrices. 349 * equal, EINA_FALSE otherwise. No check is done on the matrices.
350 * 350 *
351 * @since 1.14 351 * @since 1.14
@@ -604,7 +604,7 @@ EAPI void eina_matrix3_array_set(Eina_Matrix3 *m, const double *v);
604EAPI void eina_matrix3_copy(Eina_Matrix3 *dst, const Eina_Matrix3 *src); 604EAPI void eina_matrix3_copy(Eina_Matrix3 *dst, const Eina_Matrix3 *src);
605 605
606/** 606/**
607 * @brief Multiplies two matrix. 607 * @brief Multiplies two matrices.
608 * 608 *
609 * @param out The resulting matrix 609 * @param out The resulting matrix
610 * @param mat_a The first member of the multiplication 610 * @param mat_a The first member of the multiplication
@@ -616,7 +616,7 @@ EAPI void eina_matrix3_multiply(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a,
616 const Eina_Matrix3 *mat_b); 616 const Eina_Matrix3 *mat_b);
617 617
618/** 618/**
619 * @brief Multiplies two matrix. 619 * @brief Multiplies two matrices.
620 * 620 *
621 * @param out The resulting matrix 621 * @param out The resulting matrix
622 * @param mat_a The first member of the multiplication 622 * @param mat_a The first member of the multiplication
@@ -705,7 +705,7 @@ EAPI Eina_Matrix_Type eina_matrix4_type_get(const Eina_Matrix4 *m);
705 * @param yx The fifth coefficient value. 705 * @param yx The fifth coefficient value.
706 * @param yy The sixth coefficient value. 706 * @param yy The sixth coefficient value.
707 * @param yz The seventh coefficient value. 707 * @param yz The seventh coefficient value.
708 * @param yw The heighth coefficient value. 708 * @param yw The eighth coefficient value.
709 * @param zx The nineth coefficient value. 709 * @param zx The nineth coefficient value.
710 * @param zy The tenth coefficient value. 710 * @param zy The tenth coefficient value.
711 * @param zz The eleventh coefficient value. 711 * @param zz The eleventh coefficient value.
@@ -740,7 +740,7 @@ EAPI void eina_matrix4_values_set(Eina_Matrix4 *m,
740 * @param yx The fifth coefficient value. 740 * @param yx The fifth coefficient value.
741 * @param yy The sixth coefficient value. 741 * @param yy The sixth coefficient value.
742 * @param yz The seventh coefficient value. 742 * @param yz The seventh coefficient value.
743 * @param yw The heighth coefficient value. 743 * @param yw The eighth coefficient value.
744 * @param zx The nineth coefficient value. 744 * @param zx The nineth coefficient value.
745 * @param zy The tenth coefficient value. 745 * @param zy The tenth coefficient value.
746 * @param zz The eleventh coefficient value. 746 * @param zz The eleventh coefficient value.
@@ -868,7 +868,7 @@ EAPI void eina_matrix4_array_set(Eina_Matrix4 *m, const double *v);
868EAPI void eina_matrix4_copy(Eina_Matrix4 *dst, const Eina_Matrix4 *src); 868EAPI void eina_matrix4_copy(Eina_Matrix4 *dst, const Eina_Matrix4 *src);
869 869
870/** 870/**
871 * @brief Multiplies two matrix with check. 871 * @brief Multiplies two matrices with check.
872 * 872 *
873 * @param out The resulting matrix 873 * @param out The resulting matrix
874 * @param mat_a The first member of the multiplication 874 * @param mat_a The first member of the multiplication
@@ -1016,7 +1016,7 @@ EAPI void eina_matrix2_array_set(Eina_Matrix2 *m, const double *v);
1016EAPI void eina_matrix2_copy(Eina_Matrix2 *dst, const Eina_Matrix2 *src); 1016EAPI void eina_matrix2_copy(Eina_Matrix2 *dst, const Eina_Matrix2 *src);
1017 1017
1018/** 1018/**
1019 * @brief Multiplies two matrix. 1019 * @brief Multiplies two matrices.
1020 * 1020 *
1021 * @param out The resulting matrix 1021 * @param out The resulting matrix
1022 * @param mat_a The first member of the multiplication 1022 * @param mat_a The first member of the multiplication
@@ -1028,7 +1028,7 @@ EAPI void eina_matrix2_multiply(Eina_Matrix2 *out, const Eina_Matrix2 *mat_a,
1028 const Eina_Matrix2 *mat_b); 1028 const Eina_Matrix2 *mat_b);
1029 1029
1030/** 1030/**
1031 * @brief Multiplies two matrix with check. 1031 * @brief Multiplies two matrices with check.
1032 * 1032 *
1033 * @param out The resulting matrix 1033 * @param out The resulting matrix
1034 * @param mat_a The first member of the multiplication 1034 * @param mat_a The first member of the multiplication