forked from enlightenment/efl
eina: Fix spelling errors in documentation (log..matrix)
Reviewers: cedric, ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5417
This commit is contained in:
Bryce Harrington
Jean-Philippe Andre
parent
9cec14918c
commit
054e817572
|
|
@ -48,7 +48,7 @@
|
|||
* The Eina Log module provides logging facilities for libraries and
|
||||
* applications. It provides colored logging, basic logging levels (error,
|
||||
* warning, debug, info, critical) and loggers - called logging domains -
|
||||
* which will be covered on next sections.
|
||||
* which will be covered in next sections.
|
||||
*
|
||||
* @section tutorial_log_basic_usage Basic Usage
|
||||
*
|
||||
|
|
@ -71,7 +71,7 @@
|
|||
* log messages into a context (e.g. a module) and provide a way of controlling
|
||||
* this set as a whole.
|
||||
*
|
||||
* For example, suppose you have 3 different modules on your application and you
|
||||
* For example, suppose you have 3 different modules in your application and you
|
||||
* want to get logging only from one of them (e.g. create some sort of filter).
|
||||
* For achieving that, all you need to do is create a logging domain for each
|
||||
* 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);
|
|||
* @param color Color of the domain name
|
||||
*
|
||||
* @return Domain index that will be used as the DOMAIN parameter on log
|
||||
* macros. A negative return value means an log occurred.
|
||||
* macros. A negative return value means an error occurred.
|
||||
*
|
||||
* @note MT: Safe to call from any thread.
|
||||
*/
|
||||
|
|
@ -886,8 +886,7 @@ EAPI void eina_log_print_cb_stdout(const Eina_Log_Domain *d,
|
|||
* EINA_LOG_COLOR_DISABLE=0. If EINA_LOG_COLOR_DISABLE is unset (or
|
||||
* -1), then Eina will disable color if terminal ($TERM) is
|
||||
* unsupported or if redirecting to a file.
|
||||
|
||||
. Similarly, to disable file and line
|
||||
* Similarly, to disable file and line
|
||||
* information, set EINA_LOG_FILE_DISABLE=1 or
|
||||
* EINA_LOG_FUNCTION_DISABLE=1 to avoid function name in output. It is
|
||||
* not acceptable to have both EINA_LOG_FILE_DISABLE and
|
||||
|
|
|
|||
|
|
@ -133,7 +133,7 @@
|
|||
typedef unsigned int Eina_Magic;
|
||||
|
||||
/**
|
||||
* @brief Gets the string associated to the given magic identifier.
|
||||
* @brief Gets the string associated with the given magic identifier.
|
||||
* @details This function returns the string associated to @p magic. Even if none are
|
||||
* found this function still returns non @c NULL, in this case an identifier
|
||||
* such as "(none)", "(undefined)", or "(unknown)".
|
||||
|
|
@ -152,13 +152,13 @@ typedef unsigned int Eina_Magic;
|
|||
*/
|
||||
EAPI const char *eina_magic_string_get(Eina_Magic magic) EINA_WARN_UNUSED_RESULT;
|
||||
/**
|
||||
* @brief Sets the string associated to the given magic identifier.
|
||||
* @brief Sets the string associated with the given magic identifier.
|
||||
* @details This function sets the string @p magic_name to @p magic. It is not
|
||||
* checked if number or string are already set, in which case you end with
|
||||
* duplicates. Internally, eina makes a copy of @p magic_name.
|
||||
*
|
||||
* @param[in] magic The magic identifier
|
||||
* @param[in] magic_name The string associated to the identifier, must not
|
||||
* @param[in] magic_name The string associated with the identifier, must not
|
||||
* be @c NULL
|
||||
*
|
||||
* @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure
|
||||
|
|
@ -169,14 +169,14 @@ EAPI Eina_Bool eina_magic_string_set(Eina_Magic magic,
|
|||
const char *magic_name) EINA_ARG_NONNULL(2);
|
||||
|
||||
/**
|
||||
* @brief Sets the string associated to the given magic identifier.
|
||||
* @brief Sets the string associated with the given magic identifier.
|
||||
* @details This function sets the string @p magic_name to @p magic. It is not checked if
|
||||
* number or string are already set, in which case you might end with
|
||||
* duplicates. Eina does @b not make a copy of @p magic_name, this means that
|
||||
* @p magic_name has to be a valid pointer for as long as @p magic is used.
|
||||
*
|
||||
* @param[in] magic The magic identifier
|
||||
* @param[in] magic_name The string associated to the identifier, must not be
|
||||
* @param[in] magic_name The string associated with the identifier, must not be
|
||||
* @c NULL
|
||||
*
|
||||
* @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
/**
|
||||
* @addtogroup Eina_Main_Group Main
|
||||
*
|
||||
* @brief These functions provide general initialisation and shut down
|
||||
* @brief These functions provide general initialization and shut down
|
||||
* functions.
|
||||
*/
|
||||
|
||||
|
|
@ -183,10 +183,10 @@ EAPI int eina_init(void);
|
|||
*
|
||||
* This function shuts down the Eina library. It returns 0 when it has
|
||||
* been called the same number of times than eina_init(). In that case
|
||||
* it shut down all the Eina modules.
|
||||
* it shuts down all the Eina modules.
|
||||
*
|
||||
* Once this function succeeds (that is, @c 0 is returned), you must
|
||||
* not call any of the Eina function anymore. You must call
|
||||
* not call any of the Eina functions anymore. You must call
|
||||
* eina_init() again to use the Eina functions again.
|
||||
*/
|
||||
EAPI int eina_shutdown(void);
|
||||
|
|
@ -219,7 +219,7 @@ EAPI int eina_threads_init(void);
|
|||
* it shut down all the mutexes.
|
||||
*
|
||||
* Once this function succeeds (that is, @c 0 is returned), you must
|
||||
* not call any of the Eina function in a thread anymore. You must call
|
||||
* not call any of the Eina functions in a thread anymore. You must call
|
||||
* eina_threads_init() again to use the Eina functions in a thread again.
|
||||
*
|
||||
* This function should never be called outside of the main loop.
|
||||
|
|
@ -233,14 +233,14 @@ EAPI int eina_threads_shutdown(void);
|
|||
*
|
||||
* @since 1.1.0
|
||||
*
|
||||
* Most EFL function are not thread safe and all the call need to happen in
|
||||
* Most EFL functions are not thread safe and all the calls need to happen in
|
||||
* the main loop. With this call you could know if you can call an EFL
|
||||
* function or not.
|
||||
*/
|
||||
EAPI Eina_Bool eina_main_loop_is(void);
|
||||
|
||||
/**
|
||||
* @brief You should never use that function except if you really really know what your are doing.
|
||||
* @brief You should never use this function except if you really really know what your are doing.
|
||||
* @since 1.1.0
|
||||
*
|
||||
* If you are reading this documentation, that certainly means you don't know what is the purpose of
|
||||
|
|
|
|||
|
|
@ -253,7 +253,7 @@ EAPI Eina_Matrix_Type eina_matrix3_type_get(const Eina_Matrix3 *m);
|
|||
* @param yy The fifth coefficient value.
|
||||
* @param yz The sixth coefficient value.
|
||||
* @param zx The seventh coefficient value.
|
||||
* @param zy The heighth coefficient value.
|
||||
* @param zy The eighth coefficient value.
|
||||
* @param zz The nineth coefficient value.
|
||||
*
|
||||
* This function sets the values of the coefficients of the matrix
|
||||
|
|
@ -280,7 +280,7 @@ EAPI void eina_matrix3_values_set(Eina_Matrix3 *m,
|
|||
* @param yy The fifth coefficient value.
|
||||
* @param yz The sixth coefficient value.
|
||||
* @param zx The seventh coefficient value.
|
||||
* @param zy The heighth coefficient value.
|
||||
* @param zy The eighth coefficient value.
|
||||
* @param zz The nineth coefficient value.
|
||||
*
|
||||
* 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,
|
|||
* @param yy The fifth coefficient value.
|
||||
* @param yz The sixth coefficient value.
|
||||
* @param zx The seventh coefficient value.
|
||||
* @param zy The heighth coefficient value.
|
||||
* @param zy The eighth coefficient value.
|
||||
* @param zz The nineth coefficient value.
|
||||
*
|
||||
* 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,
|
|||
* @param m2 The second matrix.
|
||||
* @return EINA_TRUE if the two matrices are equal, @c 0 otherwise.
|
||||
*
|
||||
* This function return EINA_TRUE if thematrices @p m1 and @p m2 are
|
||||
* This function return EINA_TRUE if the matrices @p m1 and @p m2 are
|
||||
* equal, EINA_FALSE otherwise. No check is done on the matrices.
|
||||
*
|
||||
* @since 1.14
|
||||
|
|
@ -604,7 +604,7 @@ EAPI void eina_matrix3_array_set(Eina_Matrix3 *m, const double *v);
|
|||
EAPI void eina_matrix3_copy(Eina_Matrix3 *dst, const Eina_Matrix3 *src);
|
||||
|
||||
/**
|
||||
* @brief Multiplies two matrix.
|
||||
* @brief Multiplies two matrices.
|
||||
*
|
||||
* @param out The resulting matrix
|
||||
* @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,
|
|||
const Eina_Matrix3 *mat_b);
|
||||
|
||||
/**
|
||||
* @brief Multiplies two matrix.
|
||||
* @brief Multiplies two matrices.
|
||||
*
|
||||
* @param out The resulting matrix
|
||||
* @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);
|
|||
* @param yx The fifth coefficient value.
|
||||
* @param yy The sixth coefficient value.
|
||||
* @param yz The seventh coefficient value.
|
||||
* @param yw The heighth coefficient value.
|
||||
* @param yw The eighth coefficient value.
|
||||
* @param zx The nineth coefficient value.
|
||||
* @param zy The tenth coefficient value.
|
||||
* @param zz The eleventh coefficient value.
|
||||
|
|
@ -740,7 +740,7 @@ EAPI void eina_matrix4_values_set(Eina_Matrix4 *m,
|
|||
* @param yx The fifth coefficient value.
|
||||
* @param yy The sixth coefficient value.
|
||||
* @param yz The seventh coefficient value.
|
||||
* @param yw The heighth coefficient value.
|
||||
* @param yw The eighth coefficient value.
|
||||
* @param zx The nineth coefficient value.
|
||||
* @param zy The tenth coefficient value.
|
||||
* @param zz The eleventh coefficient value.
|
||||
|
|
@ -868,7 +868,7 @@ EAPI void eina_matrix4_array_set(Eina_Matrix4 *m, const double *v);
|
|||
EAPI void eina_matrix4_copy(Eina_Matrix4 *dst, const Eina_Matrix4 *src);
|
||||
|
||||
/**
|
||||
* @brief Multiplies two matrix with check.
|
||||
* @brief Multiplies two matrices with check.
|
||||
*
|
||||
* @param out The resulting matrix
|
||||
* @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);
|
|||
EAPI void eina_matrix2_copy(Eina_Matrix2 *dst, const Eina_Matrix2 *src);
|
||||
|
||||
/**
|
||||
* @brief Multiplies two matrix.
|
||||
* @brief Multiplies two matrices.
|
||||
*
|
||||
* @param out The resulting matrix
|
||||
* @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,
|
|||
const Eina_Matrix2 *mat_b);
|
||||
|
||||
/**
|
||||
* @brief Multiplies two matrix with check.
|
||||
* @brief Multiplies two matrices with check.
|
||||
*
|
||||
* @param out The resulting matrix
|
||||
* @param mat_a The first member of the multiplication
|
||||
|
|
|
|||
Loading…
Reference in New Issue