dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

eina: Spelling fixes 

Reviewers: devilhorns, Hermet

Reviewed By: Hermet

Subscribers: cedric, #committers, zmike

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D6570
This commit is contained in:
Bryce Harrington 2018-07-12 16:27:15 +09:00 committed by Hermet Park
parent b05a5cb4c7
commit bdb9a41750
37 changed files with 111 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/lib/eina/eina_benchmark.h
View File

@ -289,8 +289,7 @@
* program, or integrate the Eina benchmark framework in an autotooled
* project. See that
* <a href="http://trac.enlightenment.org/e/wiki/AutotoolsIntegration#Benchmark">page</a>
* for more informations.
*
* for more information.
*/

10
src/lib/eina/eina_convert.h
View File

@ -34,7 +34,7 @@
* To use these functions, you have to call eina_init()
* first, and eina_shutdown() when eina is not used anymore.
*
* @section Eina_Convert_From_Integer_To_Sring Conversion from integer to string
* @section Eina_Convert_From_Integer_To_String Conversion from integer to string
*
* To convert an integer to a string in the decimal base,
* eina_convert_itoa() should be used. If the hexadecimal base is
@ -95,7 +95,7 @@
* has the following mantissas and exponent:
*
* @code
* mantiss : [-]hhhhhh
* mantissa : [-]hhhhhh
* exponent : 2^([+-]e - 4 * n)
* @endcode
*
@ -247,7 +247,7 @@ EAPI int eina_convert_dtoa(double d, char *des) EINA_ARG_NONNULL(2);
* point, the returned mantissas and exponents are:
*
* @code
* mantiss : [-]hhhhhh
* mantissa : [-]hhhhhh
* exponent : 2^([+-]e - 4 * n)
* @endcode
*
@ -288,7 +288,7 @@ EAPI Eina_Bool eina_convert_atod(const char *src,
*
* @note The code is the same than eina_convert_dtoa() except that it
* implements the frexp() function for fixed point numbers and does
* some optimisations.
* some optimization.
*/
EAPI int eina_convert_fptoa(Eina_F32p32 fp,
char *des) EINA_ARG_NONNULL(2);
@ -317,7 +317,7 @@ EAPI int eina_convert_fptoa(Eina_F32p32 fp,
* point, the returned mantissas and exponents are:
*
* @code
* mantiss : [-]hhhhhh
* mantissa : [-]hhhhhh
* exponent : 2^([+-]e - 4 * n)
* @endcode
*

2
src/lib/eina/eina_counter.h
View File

@ -170,7 +170,7 @@ EAPI void eina_counter_stop(Eina_Counter *counter,
/**
* @brief Dumps the result of all the clocks of a counter to a stream.
* @details This function returns an malloc'd string containing the dump of
* @details This function returns a malloc'd string containing the dump of
* all the valid clocks of @p counter.
* If @p counter is @c NULL, the functions exits
* immediately. Otherwise, the output is formatted like this:

2
src/lib/eina/eina_evlog.h
View File

@ -58,7 +58,7 @@ struct _Eina_Evlog_Buf
/**
* @brief Logs an event in our event log for profiling data.
*
* Log some interesting event inside of EFL, eg a wakeup (and why etc.).
* Log some interesting event inside of EFL, e.g. a wakeup (and why etc.).
* The @p event string must always be provided and be of the form:
*
* "+eventname"

4
src/lib/eina/eina_file.h
View File

@ -145,7 +145,7 @@ typedef enum {
EINA_FILE_WILLNEED, /**< Advise need for all the mapped memory */
EINA_FILE_POPULATE, /**< Request for all the mapped memory */
EINA_FILE_DONTNEED, /**< Indicate that the memory is no longer needed. This may result in the memory being removed from any caches if applicable. @since 1.8 */
EINA_FILE_REMOVE /**< This memory is to be released and any content will be lost. Subsequent accesses will succeed but return fresh memory as if accessed for the first time. This may not suceed if the filesystem does not support it. @since 1.8 */
EINA_FILE_REMOVE /**< This memory is to be released and any content will be lost. Subsequent accesses will succeed but return fresh memory as if accessed for the first time. This may not succeed if the filesystem does not support it. @since 1.8 */
} Eina_File_Populate;
/* Why do this? Well PATH_MAX may vary from when eina itself is compiled
@ -747,7 +747,7 @@ static inline size_t eina_file_path_join(char *dst,
* a file.
*
* @param pathname File name to unlink.
* @return #EINA_TRUE if the unlink was successfull, #EINA_FALSE otherwise..
* @return #EINA_TRUE if the unlink was successful, #EINA_FALSE otherwise..
*
* @since 1.19
*/

6
src/lib/eina/eina_file_common.h
View File

@ -176,7 +176,7 @@ struct _Eina_Lines_Iterator
/**
* @brief Determines if a path is relative or absolute.
* The implementation simply chekcs if the first char in the path is '/'. If it
* The implementation simply checks if the first char in the path is '/'. If it
* is not, the path is considered relative.
*
* @param path The path to check.
@ -267,7 +267,7 @@ extern int _eina_file_log_dom;
// Common function to handle virtual file
/**
* @brief Map the entire contents fo a virtual file to a buffer.
* @brief Map the entire contents of a virtual file to a buffer.
*
* @param file The virtual file to map in memory
*
@ -297,7 +297,7 @@ void eina_file_virtual_map_free(Eina_File *file, void *map);
// Common hash function
/**
* @brief Get the length of a map key.
* @warning This function is not yet implemented. At present it ony returns
* @warning This function is not yet implemented. At present it only returns
* @code sizeof (unsigned long int) * 2 @endcode
*
* @param key The key for which length will be calculated.

8
src/lib/eina/eina_freeq.h
View File

@ -71,7 +71,7 @@
*
* A queue of pointers to free in the future. You may create custom free
* queues of your own to defer freeing, use the main free queue where the
* mainloop will free thnigs as it iterates, or eina will free everything
* mainloop will free things as it iterates, or eina will free everything
* on shut down.
*
*/
@ -90,7 +90,7 @@ typedef enum _Eina_FreeQ_Type
* safety purposes only.
*
* As this type of free queue is thread-safe, the free functions used must
* also be thread-safe (eg. libc free()).
* also be thread-safe (e.g.. libc free()).
*
* @since 1.19
*/
@ -173,7 +173,7 @@ eina_freeq_main_get(void);
* called.
*
* @note Setting a maximum count on a postponed free queue leads to undefined
* behaviour.
* behavior.
*
* @since 1.19
*/
@ -206,7 +206,7 @@ eina_freeq_count_max_get(Eina_FreeQ *fq);
* memory used by items in the queue is below or at the limit.
*
* @note Setting a memory limit on a postponed free queue leads to undefined
* behaviour.
* behavior.
*
* @since 1.19
*/

2
src/lib/eina/eina_inarray.h
View File

@ -401,7 +401,7 @@ EAPI int eina_inarray_remove(Eina_Inarray *array,
* @brief Removes the last member of the array.
*
* @param[in] array The array object
* @return The data poped out of the array
* @return The data popped out of the array
*
* @note The data could be considered valid only until any other operation touched the Inarray.
*

2
src/lib/eina/eina_internal.h
View File

@ -74,7 +74,7 @@ EAPI void __eina_promise_cancel_all(void);
EAPI void __eina_promise_cancel_data(void *data);
/**
* Make the app specific paths accessable as virtual path
* Make the app specific paths accessible as virtual path
*
* This will create :
* - app.dir

2
src/lib/eina/eina_iterator.h
View File

@ -356,7 +356,7 @@ EAPI Eina_Iterator* eina_iterator_filter_new(Eina_Iterator *original, Eina_Each_
* @warning unless explicitly stated in functions returning iterators,
* do not modify the iterated object while you walk it, in this
* example using lists, do not remove list nodes or you might
* crash! This is not a limitiation of iterators themselves,
* crash! This is not a limitation of iterators themselves,
* rather in the iterators implementations to keep them as simple
* and fast as possible.
*/

2
src/lib/eina/eina_lalloc.h
View File

@ -91,7 +91,7 @@ EAPI void eina_lalloc_free(Eina_Lalloc *a) EINA_ARG_NONNULL(1);
/**
* @brief Adds several elements to a lazy allocator.
*
* @param a The lazy allocater to add items to.
* @param a The lazy allocator to add items to.
* @param num The number of elements to add.
*
* @return #EINA_TRUE on success, else #EINA_FALSE.

2
src/lib/eina/eina_list.h
View File

@ -265,7 +265,7 @@
* any future references to the list.
*
* Most functions have two versions that have the same effect but operate on
* different arguments, the @a plain functions operate over data(eg.:
* different arguments, the @a plain functions operate over data(e.g..:
* @ref eina_list_append_relative, @ref eina_list_remove,
* @ref eina_list_data_find), the @a list versions of these functions operate
* on @ref Eina_List nodes.

8
src/lib/eina/eina_lock.h
View File

@ -199,7 +199,7 @@ static inline Eina_Lock_Result eina_lock_release(Eina_Lock *mutex);
/**
* @brief Prints debug information about a lock.
* @details This function prints debug information for @p mutex. The information is
* platform dependant. On POSIX systems it prints the address of @p mutex,
* platform dependent. On POSIX systems it prints the address of @p mutex,
* lock state, thread number and a backtrace.
*
* @param[in] mutex The #Eina_Lock to print debug info for.
@ -221,7 +221,7 @@ EAPI void eina_lock_debug(const Eina_Lock *mutex);
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* Condition variables are used to coordinate actions between threads. See
* <a href="https://computing.llnl.gov/tutorials/pthreads/#ConVarOverview"> Condition Varable Overview </a>
* <a href="https://computing.llnl.gov/tutorials/pthreads/#ConVarOverview"> Condition Variable Overview </a>
* for an introduction to condition variables and their use.
*
* @see eina_condition_free()
@ -252,7 +252,7 @@ static inline void eina_condition_free(Eina_Condition *cond);
static inline Eina_Bool eina_condition_wait(Eina_Condition *cond);
/**
* @brief Causes a thread to wait until signalled by the condition or a
* @brief Causes a thread to wait until signaled by the condition or a
* timeout is reached.
* @details This function makes a thread block until either a signal is sent to it via
* @p cond or @p t seconds have passed.
@ -292,7 +292,7 @@ static inline Eina_Bool eina_condition_broadcast(Eina_Condition *cond);
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @note If there is more than one thread waiting on this condition, one of them is
* signalled, but which one is undefined.
* signaled, but which one is undefined.
*
* @see eina_condition_broadcast()
*/

8
src/lib/eina/eina_log.h
View File

@ -838,7 +838,7 @@ EAPI void eina_log_vprint(int domain,
* @param file The file which is logged.
* @param fnc The function which is logged.
* @param line The line which is logged.
* @param fmt The ouptut format to use.
* @param fmt The output format to use.
* @param data Not used.
* @param args The arguments needed by the format.
*
@ -873,7 +873,7 @@ EAPI void eina_log_print_cb_stdout(const Eina_Log_Domain *d,
* @param file The file which is logged.
* @param fnc The function which is logged.
* @param line The line which is logged.
* @param fmt The ouptut format to use.
* @param fmt The output format to use.
* @param data Not used.
* @param args The arguments needed by the format.
*
@ -915,7 +915,7 @@ EAPI void eina_log_print_cb_stderr(const Eina_Log_Domain *d,
* @param file The file which is logged.
* @param fnc The function which is logged.
* @param line The line which is logged.
* @param fmt The ouptut format to use.
* @param fmt The output format to use.
* @param data The file which will store the output (as a FILE *).
* @param args The arguments needed by the format.
*
@ -943,7 +943,7 @@ EAPI void eina_log_print_cb_file(const Eina_Log_Domain *d,
* @param file The file which is logged.
* @param fnc The function which is logged.
* @param line The line which is logged.
* @param fmt The ouptut format to use.
* @param fmt The output format to use.
* @param data The file which will store the output (as a FILE *).
* @param args The arguments needed by the format.
*

4
src/lib/eina/eina_main.h
View File

@ -94,13 +94,13 @@ EAPI extern Eina_Error EINA_ERROR_NOT_IMPLEMENTED;
*
* @li @c EINA_LOG_ABORT_LEVEL=LEVEL, where level is an integer such
* as 0 (critical) to 4 (debug). This will cause any messages at
* that level or less (ie: if 4, then messages at level 0 also
* that level or less (i.e.: if 4, then messages at level 0 also
* apply) to abort(3) the application if @c EINA_LOG_ABORT=1 was
* defined.
*
* @li @c EINA_LOG_BACKTRACE=LEVEL, where level is an integer such as
* 0 (critical) to 4 (debug). This will cause any messages at
* that level or less (ie: if 4, then messages at level 0 also
* that level or less (i.e.: if 4, then messages at level 0 also
* apply) to dump a backtrace. Note that if systemd-journal is
* used, it's going to the journal as well.
*

8
src/lib/eina/eina_matrix.h
View File

@ -286,7 +286,7 @@ EAPI void eina_matrix3_values_set(Eina_Matrix3 *m,
* @param[out] yz The sixth coefficient value.
* @param[out] zx The seventh coefficient value.
* @param[out] zy The eighth coefficient value.
* @param[out] zz The nineth coefficient value.
* @param[out] zz The ninth coefficient value.
*
* This function gets the values of the coefficients of the matrix
* @p m. No check is done on @p m.
@ -313,7 +313,7 @@ EAPI void eina_matrix3_values_get(const Eina_Matrix3 *m,
* @param[out] yz The sixth coefficient value.
* @param[out] zx The seventh coefficient value.
* @param[out] zy The eighth coefficient value.
* @param[out] zz The nineth coefficient value.
* @param[out] zz The nine-th coefficient value.
*
* This function gets the values of the coefficients of the matrix
* @p m. No check is done on @p m.
@ -729,7 +729,7 @@ EAPI Eina_Matrix_Type eina_matrix4_type_get(const Eina_Matrix4 *m);
* @param[in] yy The sixth coefficient value.
* @param[in] yz The seventh coefficient value.
* @param[in] yw The eighth coefficient value.
* @param[in] zx The nineth coefficient value.
* @param[in] zx The ninth coefficient value.
* @param[in] zy The tenth coefficient value.
* @param[in] zz The eleventh coefficient value.
* @param[in] zw The twelfth coefficient value.
@ -764,7 +764,7 @@ EAPI void eina_matrix4_values_set(Eina_Matrix4 *m,
* @param[out] yy The sixth coefficient value.
* @param[out] yz The seventh coefficient value.
* @param[out] yw The eighth coefficient value.
* @param[out] zx The nineth coefficient value.
* @param[out] zx The ninth coefficient value.
* @param[out] zy The tenth coefficient value.
* @param[out] zz The eleventh coefficient value.
* @param[out] zw The twelfth coefficient value.

2
src/lib/eina/eina_module.h
View File

@ -210,7 +210,7 @@ EAPI const char *
* @brief Defines if on module load we should expose all symbol
*
* @param module The module to turn off/on symbol to be exposed
* @param global @c ture to turn on symbol to be exposed, @c false otherwise
* @param global @c true to turn on symbol to be exposed, @c false otherwise
* @since 1.11
*/
EAPI void eina_module_symbol_global_set(Eina_Module *module, Eina_Bool global) EINA_ARG_NONNULL(1);

16
src/lib/eina/eina_prefix.h
View File

@ -44,14 +44,14 @@ typedef struct _Eina_Prefix Eina_Prefix;
* single shared library binaries, but also come with extra modules that they
* have to load, extra binary utilities they need to run, or have data files
* that they need to load. A very primitive application ASSUMES a fixed install
* location at compile-time, but this disallows the ability to re-locate
* location at compile-time, but this disallows the ability to relocate
* the application (or library) somewhere else after compilation (if you run
* out of space on a given disk, partition, etc. for example), or necessitate
* the need for having to maintain environment variables for every piece of
* software to let it know its location, or have to use large sets of
* symlinks pointing from the compiled location to the new one.
*
* Being re-locatable at runtime allows much easier distribution and
* Being relocatable at runtime allows much easier distribution and
* installation into places like the users own home directory, instead of
* on a system partition, if the developer wishes for easier distribution
* of pre-compiled binaries.
@ -121,7 +121,7 @@ typedef struct _Eina_Prefix Eina_Prefix;
* locale dir. Also note that the magicsharefile is optional for testing and
* ensuring that the prefix check is correct. This file must be installed
* in the application data dir (e.g. /usr/local/share/appname) and be referred
* to using a unix-style relative path from that dir, eg directory/filename.png)
* to using a unix-style relative path from that dir, e.g. directory/filename.png)
*
* @code
* #include <Eina.h>
@ -173,7 +173,7 @@ EAPI void eina_prefix_free(Eina_Prefix *pfx) EINA_ARG_NONNULL(1);
* @brief Gets the prefix base directory.
*
* @param[in] pfx The prefix object
* @return The base prefix (eg "/usr/local", "/usr", "/opt/appname" or
* @return The base prefix (e.g. "/usr/local", "/usr", "/opt/appname" or
* "/home/user/myapps/appname", etc.) that the software resides in at runtime
*
* @since 1.1.0
@ -184,7 +184,7 @@ EAPI const char *eina_prefix_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_WARN
* @brief Gets the binary installation directory.
*
* @param[in] pfx The prefix object
* @return The location of installed binaries (eg "/usr/local/bin",
* @return The location of installed binaries (e.g. "/usr/local/bin",
* "/usr/bin", "/opt/appname/bin", "/home/user/myapps/appname/bin" etc.)
*
* @since 1.1.0
@ -195,7 +195,7 @@ EAPI const char *eina_prefix_bin_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_
* @brief Gets the library installation directory.
*
* @param[in] pfx The prefix object
* @return The location of installed binaries (eg "/usr/local/lib",
* @return The location of installed binaries (e.g. "/usr/local/lib",
* "/usr/lib32", "/opt/appname/lib64", "/home/user/myapps/appname/lib" etc.)
*
* @since 1.1.0
@ -206,7 +206,7 @@ EAPI const char *eina_prefix_lib_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_
* @brief Gets the data installation directory.
*
* @param[in] pfx The prefix object
* @return The location of installed binaries (eg "/usr/local/share/appname",
* @return The location of installed binaries (e.g. "/usr/local/share/appname",
* "/usr/share/appname", "/opt/appname/share/appname", "/home/user/myapps/appname/share/appname" etc.)
*
* @since 1.1.0
@ -217,7 +217,7 @@ EAPI const char *eina_prefix_data_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA
* @brief Gets the locale installation directory.
*
* @param[in] pfx The prefix object
* @return The location of installed binaries (eg "/usr/local/share/locale",
* @return The location of installed binaries (e.g. "/usr/local/share/locale",
* "/usr/share/locale", "/opt/appname/share/locale", "/home/user/myapps/appname/share/locale" etc.)
*
* @since 1.1.0

56
src/lib/eina/eina_promise.h
View File

@ -465,14 +465,14 @@ struct _Eina_Future_Desc {
*
* A promise may be canceled directly by calling
* @c eina_future_cancel(eina_future_new(eina_promise_new(...)))
* that is, cancelling any future that is chained to receive the results.
* that is, canceling any future that is chained to receive the results.
*
* However promises can be canceled indirectly by other entities.
* These other entities will call `eina_future_cancel()` themselves,
* however you may not be aware of that. Some common sources
* of indirect cancellations:
*
* @li A subsystem was shutdown, cancelling all pending futures (ie: ecore_shutdown())
* @li A subsystem was shutdown, canceling all pending futures (i.e.: ecore_shutdown())
*
* @li An EO object was linked to the promise or future, then if the object dies (last reference
* is gone), then the pending promises and futures will be canceled.
@ -480,7 +480,7 @@ struct _Eina_Future_Desc {
* @li Some other entity (library provider or library user) chained and canceled his future,
* which will result in your future being canceled.
*
* Since a promise may be canceled indirectaly (by code sections that goes beyond your scope)
* Since a promise may be canceled indirectly (by code sections that goes beyond your scope)
* you should always provide a cancel callback, even if you think you'll not need it.
*
* Here's a typical example:
@ -553,14 +553,14 @@ EAPI Eina_Promise *eina_promise_new(Eina_Future_Scheduler *scheduler, Eina_Promi
*
* A promise may be canceled directly by calling
* @c eina_future_cancel(eina_future_new(eina_promise_new(...)))
* that is, cancelling any future that is chained to receive the results.
* that is, canceling any future that is chained to receive the results.
*
* However promises can be canceled indirectly by other entities.
* These other entities will call `eina_future_cancel()` themselves,
* however you may not be aware of that. Some common sources
* of indirect cancellations:
*
* @li A subsystem was shutdown, cancelling all pending futures (ie: ecore_shutdown())
* @li A subsystem was shutdown, canceling all pending futures (i.e.: ecore_shutdown())
*
* @li An EO object was linked to the promise or future, then if the object dies (last reference
* is gone), then the pending promises and futures will be canceled.
@ -568,7 +568,7 @@ EAPI Eina_Promise *eina_promise_new(Eina_Future_Scheduler *scheduler, Eina_Promi
* @li Some other entity (library provider or library user) chained and canceled his future,
* which will result in your future being canceled.
*
* Since a promise may be canceled indirectaly (by code sections that goes beyond your scope)
* Since a promise may be canceled indirectly (by code sections that goes beyond your scope)
* you should always provide a cancel callback, even if you think you'll not need it.
*
* Here's a typical example:
@ -800,7 +800,7 @@ EAPI Eina_Value eina_future_as_value(Eina_Future *f)EINA_ARG_NONNULL(1) EINA_WAR
* Creates a new future.
*
* This function creates a new future and can be used to report
* that an operation has succeded or failed using
* that an operation has succeeded or failed using
* eina_promise_resolve() or eina_promise_reject().
*
* Futures can also be canceled using eina_future_cancel(), which
@ -989,7 +989,7 @@ EAPI Eina_Future *eina_future_rejected(Eina_Future_Scheduler *scheduler, Eina_Er
* // This function is called if future result type does not match or another error occurred
* Eina_Value new_v;
* eina_value_setup(&new_v, EINA_VALUE_TYPE_ERROR);
* eina_valuse_set(&new_v, err);
* eina_value_set(&new_v, err);
* fprintf(stderr, "Error during future process. Reason: %s\n", eina_error_msg_get(err));
* // Pass the error to the next future in the chain..
* return new_v;
@ -1043,7 +1043,7 @@ EAPI Eina_Future *eina_future_then_from_desc(Eina_Future *prev, const Eina_Futur
* is returning. The returned value will be passed to the next future in the chain without
* modifications.
*
* There're some helper macros like eina_future_cb_log_dbg() which will automatically
* There are some helper macros like eina_future_cb_log_dbg() which will automatically
* fill the following fields:
*
* @li #Eina_Future_Cb_Log_Desc::file: The __FILE__ function will be used.
@ -1121,7 +1121,7 @@ EAPI Eina_Future *eina_future_chain_array(Eina_Future *prev, const Eina_Future_D
/**
* Wrappper around eina_future_chain_array() and eina_future_cb_easy_from_desc()
* Wrapper around eina_future_chain_array() and eina_future_cb_easy_from_desc()
*
* This functions makes it easier to use eina_future_chain_array() with eina_future_cb_easy_from_desc(),
* check the macro eina_future_chain_easy() for a syntax sugar.
@ -1148,7 +1148,7 @@ EAPI Eina_Future *eina_future_chain_easy_array(Eina_Future *prev, const Eina_Fut
* modifications.
*
* There's also a helper macro called eina_future_cb_console() which makes this
* fuction easier to use.
* function easier to use.
*
* Example:
*
@ -1210,7 +1210,7 @@ EAPI Eina_Future_Desc eina_future_cb_convert_to(const Eina_Value_Type *type);
/**
* Creates an #Eina_Future_Desc based on a #Eina_Future_Cb_Easy_Desc
*
* This function aims to be used in conjuction with eina_future_chain(),
* This function aims to be used in conjunction with eina_future_chain(),
* eina_future_then_from_desc() and friends and its main objective is to simplify
* error handling and Eina_Value type checks.
* It uses three callbacks to inform the user about the future's
@ -1596,7 +1596,7 @@ eina_future_race_array(Eina_Future *array[])
#define EINA_FUTURE_SENTINEL ((void *)(unsigned long)-1)
/**
* A syntatic sugar over eina_promise_race_array().
* A syntactic sugar over eina_promise_race_array().
* Usage:
* @code
* promise = eina_promise_race(future1, future2, future3, future4);
@ -1605,16 +1605,16 @@ eina_future_race_array(Eina_Future *array[])
*/
#define eina_promise_race(...) eina_promise_race_array((Eina_Future *[]){__VA_ARGS__, EINA_FUTURE_SENTINEL})
/**
* A syntatic sugar over eina_future_race_array().
* A syntactic sugar over eina_future_race_array().
* Usage:
* @code
* future = eina_future_race(future1, future2, future3, future4);
* @endcode
* @see eina_future_racec_array()
* @see eina_future_race_array()
*/
#define eina_future_race(...) eina_future_race_array((Eina_Future *[]){__VA_ARGS__, EINA_FUTURE_SENTINEL})
/**
* A syntatic sugar over eina_future_all_array().
* A syntactic sugar over eina_future_all_array().
* Usage:
* @code
* future = eina_future_all(future1, future2, future3, future4);
@ -1623,7 +1623,7 @@ eina_future_race_array(Eina_Future *array[])
*/
#define eina_future_all(...) eina_future_all_array((Eina_Future *[]){__VA_ARGS__, EINA_FUTURE_SENTINEL})
/**
* A syntatic sugar over eina_promise_all_array().
* A syntactic sugar over eina_promise_all_array().
* Usage:
* @code
* promise = eina_promise_all(future1, future2, future3, future4);
@ -1632,7 +1632,7 @@ eina_future_race_array(Eina_Future *array[])
*/
#define eina_promise_all(...) eina_promise_all_array((Eina_Future *[]){__VA_ARGS__, EINA_FUTURE_SENTINEL})
/**
* A syntatic sugar over eina_future_cb_easy_from_desc().
* A syntactic sugar over eina_future_cb_easy_from_desc().
* Usage:
* @code
* future_desc = eina_future_cb_easy(_success_cb, _error_cb, _free_cb, EINA_VALUE_TYPE_INT, my_data);
@ -1641,7 +1641,7 @@ eina_future_race_array(Eina_Future *array[])
*/
#define eina_future_cb_easy(...) eina_future_cb_easy_from_desc((Eina_Future_Cb_Easy_Desc){__VA_ARGS__})
/**
* A syntatic sugar over eina_future_chain_array().
* A syntactic sugar over eina_future_chain_array().
* Usage:
* @code
* future = eina_future_chain(future, {.cb = _my_cb, .data = my_data}, {.cb = _my_another_cb, .data = NULL});
@ -1650,7 +1650,7 @@ eina_future_race_array(Eina_Future *array[])
*/
#define eina_future_chain(_prev, ...) eina_future_chain_array(_prev, (Eina_Future_Desc[]){__VA_ARGS__, {.cb = NULL, .data = NULL}})
/**
* A syntatic sugar over eina_future_then_from_desc().
* A syntactic sugar over eina_future_then_from_desc().
* Usage:
* @code
* future = eina_future_then(future, _my_cb, my_data);
@ -1660,7 +1660,7 @@ eina_future_race_array(Eina_Future *array[])
*/
#define eina_future_then(_prev, ...) eina_future_then_from_desc(_prev, (Eina_Future_Desc){__VA_ARGS__})
/**
* A syntatic sugar over eina_future_cb_console_from_desc().
* A syntactic sugar over eina_future_cb_console_from_desc().
* Usage:
* @code
* desc = eina_future_cb_console(.prefix = "prefix", .suffix = "suffix");
@ -1670,7 +1670,7 @@ eina_future_race_array(Eina_Future *array[])
#define eina_future_cb_console(...) eina_future_cb_console_from_desc((Eina_Future_Cb_Console_Desc){__VA_ARGS__})
/**
* A syntatic sugar over eina_future_cb_log_from_desc().
* A syntactic sugar over eina_future_cb_log_from_desc().
*
* This macro will set the following fields of the #Eina_Future_Cb_Log_Desc:
*
@ -1691,7 +1691,7 @@ eina_future_race_array(Eina_Future *array[])
__FUNCTION__, EINA_LOG_LEVEL_DBG, EINA_LOG_DOMAIN_DEFAULT, __LINE__})
/**
* A syntatic sugar over eina_future_cb_log_from_desc().
* A syntactic sugar over eina_future_cb_log_from_desc().
*
* This macro will set the following fields of the #Eina_Future_Cb_Log_Desc:
*
@ -1712,7 +1712,7 @@ eina_future_race_array(Eina_Future *array[])
__FUNCTION__, EINA_LOG_LEVEL_CRITICAL, EINA_LOG_DOMAIN_DEFAULT, __LINE__})
/**
* A syntatic sugar over eina_future_cb_log_from_desc().
* A syntactic sugar over eina_future_cb_log_from_desc().
*
* This macro will set the following fields of the #Eina_Future_Cb_Log_Desc:
*
@ -1733,7 +1733,7 @@ eina_future_race_array(Eina_Future *array[])
__FUNCTION__, EINA_LOG_LEVEL_ERR, EINA_LOG_DOMAIN_DEFAULT, __LINE__})
/**
* A syntatic sugar over eina_future_cb_log_from_desc().
* A syntactic sugar over eina_future_cb_log_from_desc().
*
* This macro will set the following fields of the #Eina_Future_Cb_Log_Desc:
*
@ -1754,7 +1754,7 @@ eina_future_race_array(Eina_Future *array[])
__FUNCTION__, EINA_LOG_LEVEL_INFO, EINA_LOG_DOMAIN_DEFAULT, __LINE__})
/**
* A syntatic sugar over eina_future_cb_log_from_desc().
* A syntactic sugar over eina_future_cb_log_from_desc().
*
* This macro will set the following fields of the #Eina_Future_Cb_Log_Desc:
*
@ -1775,7 +1775,7 @@ eina_future_race_array(Eina_Future *array[])
__FUNCTION__, EINA_LOG_LEVEL_WARN, EINA_LOG_DOMAIN_DEFAULT, __LINE__})
/**
* A syntatic sugar over eina_future_then() and eina_future_cb_easy().
* A syntactic sugar over eina_future_then() and eina_future_cb_easy().
*
* Usage:
* @code
@ -1789,7 +1789,7 @@ eina_future_race_array(Eina_Future *array[])
#define eina_future_then_easy(_prev, ...) eina_future_then_from_desc(_prev, eina_future_cb_easy(__VA_ARGS__))
/**
* A syntatic sugar over eina_future_chain() and eina_future_cb_easy().
* A syntactic sugar over eina_future_chain() and eina_future_cb_easy().
*
* Usage:
* @code

2
src/lib/eina/eina_rectangle.h
View File

@ -287,7 +287,7 @@ static inline int eina_rectangle_max_x(Eina_Rectangle *rect) EINA_ARG_NO
* @return The maximum Y coordinate.
*
* This function calculates the maximum Y coordinate of the rectangle by summing
* the @p height with the current @p y coodinate of the rectangle.
* the @p height with the current @p y coordinate of the rectangle.
*/
static inline int eina_rectangle_max_y(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);

2
src/lib/eina/eina_safepointer.h
View File

@ -31,7 +31,7 @@
* index is always correct. Also once a pointer is unregistered the index
* won't be served back for 2^8 on 32 bits system and 2^28 on 64 bits system
* for that specific slot. Finally we guarantee that the lower 2 bits of the
* returned index are actually never used and completly ignored by our API.
* returned index are actually never used and completely ignored by our API.
* So you can safely store whatever information you want in it, we will ignore
* it and treat as if it wasn't there.
*

4
src/lib/eina/eina_slice.h
View File

@ -411,7 +411,7 @@ static inline char *eina_rw_slice_strdup(const Eina_Rw_Slice rw_slice);
* @def EINA_SLICE_STR_LITERAL(buf)
*
* Initializer for string literals (those declared as
* double-quoted). The size will @b NOT include the trainling
* double-quoted). The size will @b NOT include the trailing
* null-terminator.
*
* It is often useful for globals.
@ -458,7 +458,7 @@ static inline char *eina_rw_slice_strdup(const Eina_Rw_Slice rw_slice);
* @def EINA_SLICE_STR_FMT
*
* To be used in printf()-like statements, prints the slice as a
* string, its @c len is to be used, then it doesn need the null
* string, its @c len is to be used, then it doesn't need the null
* terminator.
*
* Use with EINA_SLICE_STR_PRINT()

2
src/lib/eina/eina_slstr.h
View File

@ -105,7 +105,7 @@ eina_slstr_tmpstr_new(Eina_Tmpstr *string);
/**
* @brief Create a new short lived string by taking ownership of a strbuf.
*
* @param string An existing strbuf, that will be released (ie. steal + free).
* @param string An existing strbuf, that will be released (i.e.. steal + free).
* @return A new Eina_Slstr or NULL if out of memory.
*
* Usage example:

2
src/lib/eina/eina_str.h
View File

@ -172,7 +172,7 @@ EAPI Eina_Bool eina_str_has_extension(const char *str, const char *ext) EI
* This function splits @p string into a maximum of @p max_tokens pieces,
* using the given delimiter @p delimiter. @p delimiter is not included in any
* of the resulting strings, unless @p max_tokens is reached. If
* @p max_tokens is less than @c 1, the string is splitted as many times as possible. If
* @p max_tokens is less than @c 1, the string is split as many times as possible. If
* @p max_tokens is reached, the last string in the returned string
* array contains the remainder of string. The returned value is a
* newly allocated NULL-terminated array of strings or @c NULL if it fails to

4
src/lib/eina/eina_strbuf.h
View File

@ -25,7 +25,7 @@
* @until strbuf_reset
* @until strbuf_reset
*
* Next we use the printf family of functions to create a formated string,
* Next we use the printf family of functions to create a formatted string,
* add, remove and replace some content:
* @until strbuf_string_get
* @until strbuf_string_get
@ -594,7 +594,7 @@ EAPI Eina_Bool eina_strbuf_replace(Eina_Strbuf *buf, const char *str, const char
/**
* @def eina_strbuf_replace_first(buf, str, with)
* @brief Replaces the first occurance of a substring with another string.
* @brief Replaces the first occurrence of a substring with another string.
*
* @param buf The string buffer.
* @param str The text to match.

4
src/lib/eina/eina_stringshare.h
View File

@ -29,9 +29,9 @@
*
* The above copyright notice and this permission notice shall be included in
* all copies of the Software and its Copyright notices. In addition publicly
* documented acknowledgement must be given that this software has been used if no
* documented acknowledgment must be given that this software has been used if no
* source code of this software is made available publicly. This includes
* acknowledgements in either Copyright notices, Manuals, Publicity and Marketing
* acknowledgments in either Copyright notices, Manuals, Publicity and Marketing
* documents or any documentation provided with any product containing this
* software. This License does not apply to any software that links to the
* libraries provided by this software (statically or dynamically), but only to

4
src/lib/eina/eina_thread.h
View File

@ -34,7 +34,7 @@
/**
* @defgroup Eina_Thread_Group Thread
*
* Abstracts platform threads, providing a uniform API. It's modelled
* Abstracts platform threads, providing a uniform API. It's modeled
* after POSIX THREADS (pthreads), on Linux they are almost 1:1
* mapping.
*
@ -152,7 +152,7 @@ EAPI Eina_Bool eina_thread_name_set(Eina_Thread t, const char *name);
*
* This function sends a cancellation request to the thread, however
* that request is only fulfilled if the thread is cancellable
* (eina_thread_cancellable_set() with EINA_TRUE as first paramter)
* (eina_thread_cancellable_set() with EINA_TRUE as first parameter)
* and it will wait for a cancellation point, be
* eina_thread_cancel_checkpoint() or some syscall as defined in
* man:pthreads(7).

2
src/lib/eina/eina_tiler.h
View File

@ -358,7 +358,7 @@ EAPI Eina_Tiler *eina_tiler_intersection(Eina_Tiler *t1, Eina_Tiler *t2);
*
* @param t1 The first tiler.
* @param t2 The second tiler.
* @return #EINA_TRUE is equal, #EINA_FALSE is inequal.
* @return #EINA_TRUE if equal, #EINA_FALSE if unequal.
*
* This function gets result of comparison for @p t1 and @p t2.
* It returns #EINA_TRUE if tilers are equal.

4
src/lib/eina/eina_tmpstr.h
View File

@ -135,7 +135,7 @@ typedef const char Eina_Tmpstr;
*
* If @p str is NULL, or no memory space exists to store the tmpstr, then
* NULL will be returned, otherwise a valid string pointer will be returned
* that you can treat as any other C string (eg strdup(tmpstr) or
* that you can treat as any other C string (e.g. strdup(tmpstr) or
* printf("%s\n", tmpstr) etc.). This string should be considered read-only
* and immutable, and when you are done with the string you should delete it
* with eina_tmpstr_del().
@ -180,7 +180,7 @@ EAPI Eina_Tmpstr *eina_tmpstr_add(const char *str) EINA_WARN_UNUSED_RESULT;
*
* If @p str is NULL, or no memory space exists to store the tmpstr, then
* NULL will be returned, otherwise a valid string pointer will be returned
* that you can treat as any other C string (eg strdup(tmpstr) or
* that you can treat as any other C string (e.g. strdup(tmpstr) or
* printf("%s\n", tmpstr) etc.). This string should be considered read-only
* and immutable, and when you are done with the string you should delete it
* with eina_tmpstr_del().

2
src/lib/eina/eina_unicode.h
View File

@ -68,7 +68,7 @@ EAPI Eina_Unicode *eina_unicode_strdup(const Eina_Unicode *text) EINA_WARN_UNUSE
* @param n The maximum size of the text to duplicate.
* @return The duplicated string.
*
* This function duplicates @p text. The resuting string is cut on @p
* This function duplicates @p text. The resulting string is cut on @p
* n. @p n is assumed to be lesser (<) than the length of @p
* text. When not needed anymore, the returned string must be freed.
*

2
src/lib/eina/eina_ustrbuf.h
View File

@ -166,7 +166,7 @@ EAPI Eina_Bool eina_ustrbuf_append_n(Eina_UStrbuf *buf, const Eina_Unicode *str,
* This function appends @p str to @p buf. @p str must be of size at
* most @p length. It is slightly faster than eina_ustrbuf_append() as
* it does not compute the size of @p str. It is useful when dealing
* with strings of known size, such as eina_strngshare.
* with strings of known size, such as eina_stringshare.
*
* @see eina_stringshare_length()
* @see eina_ustrbuf_append()

4
src/lib/eina/eina_ustringshare.h
View File

@ -29,9 +29,9 @@
*
* The above copyright notice and this permission notice shall be included in
* all copies of the Software and its Copyright notices. In addition publicly
* documented acknowledgement must be given that this software has been used if no
* documented acknowledgment must be given that this software has been used if no
* source code of this software is made available publicly. This includes
* acknowledgements in either Copyright notices, Manuals, Publicity and Marketing
* acknowledgments in either Copyright notices, Manuals, Publicity and Marketing
* documents or any documentation provided with any product containing this
* software. This License does not apply to any software that links to the
* libraries provided by this software (statically or dynamically), but only to

12
src/lib/eina/eina_util.h
View File

@ -30,7 +30,7 @@
/**
* @brief Returns the content of the environment referred by HOME on this system.
* @return A temporary string to the content refered by HOME on this system.
* @return A temporary string to the content referred by HOME on this system.
*
* @note The result of this call is highly system dependent and you better use
* it instead of the naive getenv("HOME").
@ -41,7 +41,7 @@ EAPI const char *eina_environment_home_get(void);
/**
* @brief Returns the content of the environment referred as TMPDIR on this system.
* @return A temporary string to the content refered by TMPDIR on this system.
* @return A temporary string to the content referred by TMPDIR on this system.
*
* @note The result of this call is highly system dependent and you better use
* it instead of the naive getenv("TMPDIR").
@ -72,8 +72,8 @@ static inline Eina_Bool eina_flt_exact(float a, float b);
/**
* @brief Safe comparison of float
* @param a First member to compar
* @param b Second member to compar
* @param a First member to compare
* @param b Second member to compare
* @since 1.19
*
* @return @c true if two floats match
@ -91,8 +91,8 @@ static inline Eina_Bool eina_flt_exact(float a, float b);
/**
* @brief Safe comparison of double
* @param a First member to compar
* @param b Second member to compar
* @param a First member to compare
* @param b Second member to compare
* @since 1.19
*
* @return @c true if two double match

4
src/lib/eina/eina_value.h
View File

@ -367,7 +367,7 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_ERROR;
* @var EINA_VALUE_TYPE_VALUE
* manages Eina_Value values.
* This value will hold an Eina_Value,
* which can be usefull for storing data
* which can be useful for storing data
* inside an #Eina_Value_Array.
*
* @since 1.21
@ -673,7 +673,7 @@ struct _Eina_Value
* the description specified by @a type.
*
* Some types may specify more operations:
* eg. #EINA_VALUE_TYPE_ARRAY uses eina_value_array_set(),
* e.g.. #EINA_VALUE_TYPE_ARRAY uses eina_value_array_set(),
* eina_value_array_get() and so on.
*
* On failure, @c NULL is returned.

6
src/lib/eina/eina_vector.h
View File

@ -141,7 +141,7 @@ static inline void eina_vector2_scale(Eina_Vector2 *out, const Eina_Vector2 *v,
* @brief Return the dot product of the two vectors.
*
* @param a The first member.
* @param b The secondt member.
* @param b The second member.
* @return The dot product.
*
* @since 1.17
@ -328,7 +328,7 @@ static inline void eina_vector3_multiply(Eina_Vector3 *out, const Eina_Vector3 *
* @brief Return the dot product of the two vectors.
*
* @param a The first member.
* @param b The secondt member.
* @param b The second member.
* @return The dot product.
*
* @since 1.18
@ -340,7 +340,7 @@ static inline double eina_vector3_dot_product(const Eina_Vector3 *a, const Eina_
*
* @param out The resulting vector.
* @param a The first member.
* @param b The secondt member.
* @param b The second member.
*
* @since 1.18
*/

8
src/lib/eina/eina_vpath.h
View File

@ -6,9 +6,9 @@
/**
* Eina vpath is a path that can be prefixed with a virtual path.
*
* A virutal path can either start with (:XXXXXXXX:) that indicates a virtual
* path with XXXXXXXX as the location, OR a normal path with / or a realative
* path like ./ or ../ or even shell common locatiors like ~/ or ~username/
* A virtual path can either start with (:XXXXXXXX:) that indicates a virtual
* path with XXXXXXXX as the location, OR a normal path with / or a relative
* path like ./ or ../ or even shell common locators like ~/ or ~username/
*
* The string between (: and :) is used as key to lookup the real value.
* The key has to be set by an interface before, otherwise you will get an
@ -55,7 +55,7 @@
* (:app.dir:) - /usr - (assuming app install PREFIX of /usr. may be /usr/local or others too)
* (:app.bin:) - /usr/bin - (almost always PREFIX/bin)
* (:app.lib:) - /usr/lib - (almost always PREFIX/lib)
* (:app.data:) - /usr/share/appname - (almost always PREIFX/share/appname)
* (:app.data:) - /usr/share/appname - (almost always PREFIX/share/appname)
* (:app.locale:) - /usr/share/locale - (almost always PREFIX/locale)
* (:app.config:) - ~/.config/appname
* (:app.local:) - ~/.local/share/appname

8
src/lib/eina/eina_xattr.h
View File

@ -36,7 +36,7 @@
* @since 1.1
*/
typedef enum {
EINA_XATTR_INSERT, /**< This is the default behaviour, it will either create or replace the extended attribute */
EINA_XATTR_INSERT, /**< This is the default behavior, it will either create or replace the extended attribute */
EINA_XATTR_REPLACE, /**< This will only succeed if the extended attribute previously existed */
EINA_XATTR_CREATED /**< This will only succeed if the extended attribute wasn't previously set */
} Eina_Xattr_Flags;
@ -44,10 +44,10 @@ typedef enum {
typedef struct _Eina_Xattr Eina_Xattr;
struct _Eina_Xattr
{
const char *name; /**< The eXtended attribute name @since 1.2 */
const char *value; /**< The eXtended attribute value @since 1.2 */
const char *name; /**< The extended attribute name @since 1.2 */
const char *value; /**< The extended attribute value @since 1.2 */
size_t length; /**< The length of the eXtended attribute value @since 1.2 */
size_t length; /**< The length of the extended attribute value @since 1.2 */
};
/**