* This function returns how many members @p list contains. If the
* list is @c NULL, 0 is returned.
*
- * NB: This is an order-1 operation and takes the same tiem regardless
+ * NB: This is an order-1 operation and takes the same time regardless
* of the length of the list.
*/
static inline unsigned int
* defaults to #EINA_LOG_DOMAIN_GLOBAL.
*
* @note One may like to redefine this in its code to avoid typing too
- * much. In this case the recomended way is:
+ * much. In this case the recommended way is:
*
* @code
* #include <Eina.h>
* @param with The replaceing string.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * This macro is calling eina_strbuf_replace() with the n-th occurence
+ * This macro is calling eina_strbuf_replace() with the n-th occurrence
* equal to @c 1. If @p buf can't replace it, #EINA_FALSE is returned,
* otherwise #EINA_TRUE is returned.
*/
* free(data);
* @endcode
*
- * @note this macro is usefull when you implement some memory pool.
+ * @note this macro is useful when you implement some memory pool.
*/
#define EINA_TRASH_CLEAN(trash, data) while ((data = eina_trash_pop(trash))
* element at position @p end. For Each element, the callback
* @p cb is called with the data @p fdata. If @p accessor is @c NULL
* or if @p start is greter or equal than @p end, the function returns
- * immediatly.
+ * immediately.
*/
EAPI void
eina_accessor_over(Eina_Accessor *accessor,
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* If the container of the @p accessor permit it, it will be locked.
- * If @p accessor is @c NULL or if a problem occured, #EINA_FALSE is
+ * If @p accessor is @c NULL or if a problem occurred, #EINA_FALSE is
* returned, otherwise #EINA_TRUE is returned. If the container
* is not lockable, it will return EINA_TRUE.
*/
*
* If the container of the @p accessor permit it and was previously
* locked, it will be unlocked. If @p accessor is @c NULL or if a
- * problem occured, #EINA_FALSE is returned, otherwise #EINA_TRUE
+ * problem occurred, #EINA_FALSE is returned, otherwise #EINA_TRUE
* is returned. If the container is not lockable, it will return
* EINA_TRUE.
*/
}
/**
- * @brief Returned a new iterator asociated to an array.
+ * @brief Returned a new iterator associated to an array.
*
* @param array The array.
* @return A new iterator.
}
/**
- * @brief Returned a new accessor asociated to an array.
+ * @brief Returned a new accessor associated to an array.
*
* @param array The array.
* @return A new accessor.
*
* This function removes all the benchmark tests that have been
* registered and frees @p bench. If @p bench is @c NULL, this
- * function returns immediatly.
+ * function returns immediately.
*/
EAPI void
eina_benchmark_free(Eina_Benchmark *bench)
* controlled by the parameters passed to eina_benchmark_register().
*
* If @p bench is @c NULL, this functions returns @c NULL
- * immediatly. Otherwise, it returns the list of the names of each
+ * immediately. Otherwise, it returns the list of the names of each
* test.
*/
EAPI Eina_Array *
* This function decreases the reference counter associated to @p obj
* if it exists. If that counter reaches 0, the memory associated to
* @p obj is freed. If @p obj is NULL, the function returns
- * immediatly.
+ * immediately.
*
* Note that if the given pointer is not shared or NULL, bad things
* will happen, likely a segmentation fault.
EAPI Eina_Error EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH = 0;
static const char EINA_ERROR_CONVERT_0X_NOT_FOUND_STR[] =
- "Error during string convertion to float, First '0x' was not found.";
+ "Error during string conversion to float, First '0x' was not found.";
static const char EINA_ERROR_CONVERT_P_NOT_FOUND_STR[] =
- "Error during string convertion to float, First 'p' was not found.";
+ "Error during string conversion to float, First 'p' was not found.";
static const char EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH_STR[] =
- "Error outrun string limit during convertion string convertion to float.";
+ "Error outrun string limit during conversion string conversion to float.";
/**
* @endcond
* wanted, eina_convert_xtoa() should be used. They all need a bufffer
* sufficiently large to store all the cyphers.
*
- * Here is an exemple of use:
+ * Here is an example of use:
*
* @code
* #include <stdlib.h>
* format. To obtain the double number from the mantiss and exponent,
* use ldexp().
*
- * Here is an exemple of use:
+ * Here is an example of use:
*
* @code
* #include <stdlib.h>
*
* This function returns a new counter. It is characterized by @p
* name. If @p name is @c NULL, the function returns @c NULL
- * immediatly. If memory allocation fails, @c NULL is returned and the
+ * immediately. If memory allocation fails, @c NULL is returned and the
* error is set to #EINA_ERROR_OUT_OF_MEMORY.
*
* Whe the new counter is not needed anymore, use eina_counter_free() to
* This function remove the clock of @p counter from the used clocks
* (see eina_counter_start()) and frees the memory allocated for
* @p counter. If @p counter is @c NULL, the function returns
- * immediatly.
+ * immediately.
*/
EAPI void
eina_counter_free(Eina_Counter *counter)
*
* This function specifies that the part of the code beginning just
* after its call is being to be timed, using @p counter. If
- * @p counter is @c NULL, this function returns immediatly.
+ * @p counter is @c NULL, this function returns immediately.
*
* This function adds the clock associated to @p counter in a list. If
* the memory needed by that clock can not be allocated, the function
* This function returns an malloc'd string containing the dump of
* all the valid clocks of @p counter.
* If @p counter @c NULL, the functions exits
- * immediatly. Otherwise, the output is formattted like that:
+ * immediately. Otherwise, the output is formattted like that:
*
* @verbatim
* \# specimen experiment time starting time ending time
*
* If @p cb or @p dir are @c NULL, or if @p dir is a string of size 0,
* or if @p dir can not be opened, this function returns #EINA_FALSE
- * immediatly. otherwise, it returns #EINA_TRUE.
+ * immediately. otherwise, it returns #EINA_TRUE.
*/
EAPI Eina_Bool
eina_file_dir_list(const char *dir,
* @param key_length Should be the length of @p key (don't forget to count '\\0' for string).
* @param key_hash The hash that will always match key.
* @param data Data to associate with the string given by @p key.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*/
EAPI Eina_Bool
* @param key_length Should be the length of @p key (don't forget to count '\\0' for string).
* @param key_hash The hash that will always match key.
* @param data Data to associate with the string given by @p key.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*/
EAPI Eina_Bool
* @param hash The given hash table. Can be @c NULL.
* @param key A unique key. Can be @c NULL.
* @param data Data to associate with the string given by @p key.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*/
EAPI Eina_Bool
* @param hash The given hash table. Can be @c NULL.
* @param key A unique key. Can be @c NULL.
* @param data Data to associate with the string given by @p key.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*/
EAPI Eina_Bool
* @param key The key. Cannot be @c NULL.
* @param key_length Should be the length of @p key (don't forget to count '\\0' for string).
* @param key_hash The hash that always match the key.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*
* @note if you don't have the key_hash, use eina_hash_del_by_key() instead.
*
* @param hash The given hash table.
* @param key The key. Cannot be @c NULL.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*
* @note if you already have the key_hash, use eina_hash_del_by_key_hash() instead.
*
* @param hash The given hash table.
* @param data The data value to search and remove.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*
* @note if you already have the key, use eina_hash_del_by_key() or eina_hash_del_by_key_hash() instead.
* @param key_hash The hash that always match the key. Ignored if @p key is @c NULL.
* @param data The data pointer to remove if @p key is @c NULL.
* Otherwise, not required and can be @c NULL.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*
* @note if you know you already have the key, use eina_hash_del_by_key_hash(),
* @param key The key. Can be @c NULL.
* @param data The data pointer to remove if @p key is @c NULL.
* Otherwise, not required and can be @c NULL.
- * @return Will return EINA_FALSE if an error occured, and EINA_TRUE if every
+ * @return Will return EINA_FALSE if an error occurred, and EINA_TRUE if every
* thing goes fine.
*
* @note if you know you already have the key, use
}
/**
- * @brief Returned a new iterator asociated to hash data.
+ * @brief Returned a new iterator associated to hash data.
*
* @param hash The hash.
* @return A new iterator.
}
/**
- * @brief Returned a new iterator asociated to hash keys.
+ * @brief Returned a new iterator associated to hash keys.
*
* @param hash The hash.
* @return A new iterator.
}
/**
- * @brief Returned a new iterator asociated to hash keys and data.
+ * @brief Returned a new iterator associated to hash keys and data.
*
* @param hash The hash.
* @return A new iterator.
}
/**
- * @brief Returned a new iterator asociated to a list.
+ * @brief Returned a new iterator associated to a list.
*
* @param list The list.
* @return A new iterator.
}
/**
- * @brief Returned a new accessor asociated to a list.
+ * @brief Returned a new accessor associated to a list.
*
* @param list The list.
* @return A new accessor.
*
* This function returns the value of the current element pointed by
* @p iterator in @p data, then goes to the next element. If @p
- * iterator is @c NULL or if a problem occured, #EINA_FALSE is
+ * iterator is @c NULL or if a problem occurred, #EINA_FALSE is
* returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool
* This function iterates over the elements pointed by @p iterator,
* beginning from the current element. For Each element, the callback
* @p cb is called with the data @p fdata. If @p iterator is @c NULL,
- * the function returns immediatly. Also, if @p cb returns @c
+ * the function returns immediately. Also, if @p cb returns @c
* EINA_FALSE, the iteration stops at that point.
*/
EAPI void
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* If the container of the @p iterator permit it, it will be locked.
- * If @p iterator is @c NULL or if a problem occured, #EINA_FALSE is
+ * If @p iterator is @c NULL or if a problem occurred, #EINA_FALSE is
* returned, otherwise #EINA_TRUE is returned. If the container
* is not lockable, it will return EINA_TRUE.
*/
*
* If the container of the @p iterator permit it and was previously
* locked, it will be unlocked. If @p iterator is @c NULL or if a
- * problem occured, #EINA_FALSE is returned, otherwise #EINA_TRUE
+ * problem occurred, #EINA_FALSE is returned, otherwise #EINA_TRUE
* is returned. If the container is not lockable, it will return
* EINA_TRUE.
*/
/**
- * @brief Returned a new iterator asociated to a list.
+ * @brief Returned a new iterator associated to a list.
*
* @param list The list.
* @return A new iterator.
}
/**
- * @brief Returned a new reversed iterator asociated to a list.
+ * @brief Returned a new reversed iterator associated to a list.
*
* @param list The list.
* @return A new iterator.
}
/**
- * @brief Returned a new accessor asociated to a list.
+ * @brief Returned a new accessor associated to a list.
*
* @param list The list.
* @return A new accessor.
* @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 ocurred.
+ * macros. A negative return value means an log occurred.
*
* @note MT: safe to call from any thread.
*/
* This function calls eina_module_unload() if @p m has been previously
* loaded and frees the allocated memory. On success this function
* returns EINA_TRUE and EINA_FALSE otherwise. If @p m is @c NULL, the
- * function returns immediatly.
+ * function returns immediately.
*/
EAPI Eina_Bool eina_module_free(Eina_Module *m)
{
* #EINA_ERROR_MODULE_INIT_FAILED is set and #EINA_FALSE is
* returned. If the module has already been loaded, it's refeence
* counter is increased by one and #EINA_TRUE is returned. If @p m is
- * @c NULL, the function returns immediatly #EINA_FALSE.
+ * @c NULL, the function returns immediately #EINA_FALSE.
*
* When the symbols of the shared file objetcts are not needed
* anymore, call eina_module_unload() to unload the module.
* shared object file is closed and if it is a internal Eina module, it
* is shutted down just before. In that case, #EINA_TRUE is
* returned. In all case, the reference counter is decreased. If @p m
- * is @c NULL, the function returns immediatly #EINA_FALSE.
+ * is @c NULL, the function returns immediately #EINA_FALSE.
*/
EAPI Eina_Bool eina_module_unload(Eina_Module *m)
{
* This function returns the data associated to @p symbol of @p m. @p
* m must have been loaded before with eina_module_load(). If @p m
* is @c NULL, or if it has not been correctly loaded before, the
- * function returns immediatly @c NULL.
+ * function returns immediately @c NULL.
*/
EAPI void *eina_module_symbol_get(const Eina_Module *m, const char *symbol)
{
* @return The file name.
*
* This function returns the file name passed in eina_module_new(). If
- * @p m is @c NULL, the function returns immediatly @c NULL. The
+ * @p m is @c NULL, the function returns immediately @c NULL. The
* returned value must no be freed.
*/
EAPI const char *eina_module_file_get(const Eina_Module *m)
*
* This function adds to @p array the module names found in @p path
* which match the cpu architecture @p arch. If @p path or @p arch is
- * @c NULL, the function returns immediatly @p array. @p array can be
+ * @c NULL, the function returns immediately @p array. @p array can be
* @c NULL. In that case, it is created with 4 elements.
*/
EAPI Eina_Array *eina_module_arch_list_get(Eina_Array *array,
* @p path. If @p recursive is #EINA_TRUE, then recursive search is
* done. The callback @p cb is called on each module found, and @p data
* is passed to @p cb. If @p path is @c NULL, the function returns
- * immediatly @p array. If the returned value of @p cb is 0, the
+ * immediately @p array. If the returned value of @p cb is 0, the
* module will not be added to the list, otherwise it will be added.
* @p array can be @c NULL. In that case, it is created with 4
* elements. @p cb can be @c NULL.
if (object->root->right)
goto end;
- /* The root is not usefull anymore... */
+ /* The root is not useful anymore... */
if (object->root->parent)
{
if (object->root->parent->left == object->root)
}
/**
- * @brief Returned a new prefix iterator asociated to a rbtree.
+ * @brief Returned a new prefix iterator associated to a rbtree.
*
* @param root The root of rbtree.
* @return A new iterator.
}
/**
- * @brief Returned a new prefix iterator asociated to a rbtree.
+ * @brief Returned a new prefix iterator associated to a rbtree.
*
* @param root The root of rbtree.
* @return A new iterator.
}
/**
- * @brief Returned a new prefix iterator asociated to a rbtree.
+ * @brief Returned a new prefix iterator associated to a rbtree.
*
* @param root The root of rbtree.
* @return A new iterator.
* @param pool The pool.
* @param w The returned width.
* @param h The returned height.
- * @return #EINA_TRUE on sucess, #EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function returns the width and height of @p pool and store
* them in respectively @p w and @p h if they are not @c NULL. If
* NUL-terminated string @p src to @p dst, NUL-terminating the result
* (unless @p siz is equal to 0). The returned value is the length of
* @p src. If the returned value is greater than @p siz, truncation
- * occured.
+ * occurred.
*/
EAPI size_t
eina_strlcpy(char *dst, const char *src, size_t siz)
* @param n The number of the fitting string.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * This function replaces the n-th occurence of @p str in @p buf with
+ * This function replaces the n-th occurrence of @p str in @p buf with
* @p with. It returns #EINA_FALSE on failure, #EINA_TRUE otherwise.
*/
EAPI Eina_Bool
* @param with The replaceing string.
* @return How often the string was replaced.
*
- * This function replaces all the occurences of @p str in @ buf with
+ * This function replaces all the occurrences of @p str in @ buf with
* the string @p with. This function returns the number of times @p str
* has been replaced. On failure, it returns 0.
*/
* This function decreases the reference counter associated to @p str
* if it exists. If that counter reaches 0, the memory associated to
* @p str is freed. If @p str is NULL, the function returns
- * immediatly.
+ * immediately.
*
* Note that if the given pointer is not shared or NULL, bad things
* will happen, likely a segmentation fault.
* This function decreases the reference counter associated to @p str
* if it exists. If that counter reaches 0, the memory associated to
* @p str is freed. If @p str is NULL, the function returns
- * immediatly.
+ * immediately.
*
* Note that if the given pointer is not shared or NULL, bad things
* will happen, likely a segmentation fault.
* This is a naive 'buddy' allocator following Knuth's documentation.
* The main difference is that we dont store the block information
* on the block memory itself but on another malloc'd area.
- * This is useful for managing memory which isnt as fast as the main
+ * This is useful for managing memory which isn't as fast as the main
* memory like the video memory
* The algorithm uses an area to store the linked list of blocks.
* Each block size is equal to the minimum allocatable block size for
pool->name);
if (pool->over > 0)
- INF("Bad news we are loosing track of pointer from mempool [%s]\n",
+ INF("Bad news we are losing track of pointer from mempool [%s]\n",
pool->name);
#endif
* hash tale pointed to by @p hash. Any entries in the table that the program
* has no more pointers for elsewhere may now be lost, so this should only be
* called if the program has lready freed any allocated data in the hash table
- * or has the pointers for data in teh table stored elswehere as well.
+ * or has the pointers for data in the table stored elswehere as well.
*
* Example:
* @code
}
/**
- * Prepend a data pointer to a linked list before the memeber specified
+ * Prepend a data pointer to a linked list before the member specified
* @param list The list handle to prepend @p data too
* @param data The data pointer to prepend to list @p list before @p relative
* @param relative The data pointer before which to insert @p data
* This function returns how many members in the specified list: @p list. If
* the list is empty (NULL), 0 is returned.
*
- * NB: This is an order-1 operation and takes the same tiem regardless of the
+ * NB: This is an order-1 operation and takes the same time regardless of the
* length of the list.
*
* Example:
strings[1841] = str->add(strings[1841]);
strings[1712] = str->add(strings[1712]);
strings[3710] = str->add("0.16.999.043");
-strings[3711] = str->add("Copyright © 1999-2008, by the Enlightenment Development Team.<br><br>We hope you enjoy using this software as much as we enjoyed writing it.<br><br>This software is provided as-is with no explicit or implied warranty. This software is governed by licensing conditions, so please see the COPYING and COPYING-PLAIN licence files installed on your system.<br><br>Enlightenment is under <hilight>HEAVY DEVELOPMENT</hilight> and it is not stable. Many features are incomplete or even non-existant yet and may have many bugs. You have been <hilight>WARNED!</hilight>");
+strings[3711] = str->add("Copyright © 1999-2008, by the Enlightenment Development Team.<br><br>We hope you enjoy using this software as much as we enjoyed writing it.<br><br>This software is provided as-is with no explicit or implied warranty. This software is governed by licensing conditions, so please see the COPYING and COPYING-PLAIN licence files installed on your system.<br><br>Enlightenment is under <hilight>HEAVY DEVELOPMENT</hilight> and it is not stable. Many features are incomplete or even non-existent yet and may have many bugs. You have been <hilight>WARNED!</hilight>");
strings[3712] = str->add("e,action,close");
strings[3713] = str->add("<title>The Team</title>The Rasterman (Carsten Haitzler) <br>Ibukun Olumuyiwa <br>Sebastian Dransfeld <br>HandyAndE (Andrew Williams) <br>CodeWarrior (Hisham Mardam Bey) <br>dj2 (Dan Sinclair) <br>Tilman Sauerbeck <br>Aleksej Struk <br>Brian Mattern <br>devilhorns (Christopher Michael) <br>/dev/urandom (Viktor Kojouharov) <br>ilLogict <br>Stafford Horne <br>Cedric Bail <br>onefang (David Seikel) <br>Stephen Houston <br>Byron Hillis <br>Ravenlock (Eric Schuele) <br>ManoWarrior (Luchezar Petkov) <br>morlenxus (Brian Miculcy) <br>");
strings[3714] = str->add("font");
projects / framework / uifw / eina.git / commitdiff