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

eina: fix typos in doc 

SVN revision: 69927
This commit is contained in:
Jihoon Kim 2012-04-05 04:24:36 +00:00
parent e720fc2b3c
commit 7eace88750
6 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
legacy/eina/src/include/eina_convert.h
View File

@ -38,7 +38,7 @@
* *
* To convert an integer to a string in the decimal base, * To convert an integer to a string in the decimal base,
* eina_convert_itoa() should be used. If the hexadecimal base is * eina_convert_itoa() should be used. If the hexadecimal base is
* wanted, eina_convert_xtoa() should be used. They all need a bufffer * wanted, eina_convert_xtoa() should be used. They all need a buffer
* sufficiently large to store all the cyphers. * sufficiently large to store all the cyphers.
* *
* Here is an example of use: * Here is an example of use:

8
legacy/eina/src/include/eina_file.h
View File

@ -271,7 +271,7 @@ EAPI Eina_Iterator *eina_file_ls(const char *dir) EINA_WARN_UNUSED_RESULT EINA_A
* *
* @note The container for the iterator is of type DIR*. * @note The container for the iterator is of type DIR*.
* @note The iterator will walk over '.' and '..' without returning them. * @note The iterator will walk over '.' and '..' without returning them.
* @note The difference between this function ahd eina_file_direct_ls() is that * @note The difference between this function and eina_file_direct_ls() is that
* it guarantees the file type information will be correct incurring a * it guarantees the file type information will be correct incurring a
* possible performance penalty. * possible performance penalty.
* *
@ -320,7 +320,7 @@ EAPI int eina_file_statat(void *container, Eina_File_Direct_Info *info, Eina_Sta
* *
* @note The container for the iterator is of type DIR*. * @note The container for the iterator is of type DIR*.
* @note The iterator will walk over '.' and '..' without returning them. * @note The iterator will walk over '.' and '..' without returning them.
* @note The difference between this function ahd eina_file_stat_ls() is that * @note The difference between this function and eina_file_stat_ls() is that
* it may not get the file type information however it is likely to be * it may not get the file type information however it is likely to be
* faster. * faster.
* *
@ -363,7 +363,7 @@ EAPI Eina_File *eina_file_open(const char *name, Eina_Bool shared) EINA_WARN_UNU
* *
* @param file File handler to unref. * @param file File handler to unref.
* *
* Decremente file's refcount and if it reaches zero close it. * Decrement file's refcount and if it reaches zero close it.
* *
* @since 1.1 * @since 1.1
*/ */
@ -467,7 +467,7 @@ EAPI void eina_file_map_free(Eina_File *file, void *map);
* @brief Tell if their was an IO error during the life of a mmaped file * @brief Tell if their was an IO error during the life of a mmaped file
* *
* @param file The file handler to the mmaped file. * @param file The file handler to the mmaped file.
* @param map Memory map to check if an error occured on it. * @param map Memory map to check if an error occurred on it.
* @return #EINA_TRUE if there was an IO error, #EINA_FALSE otherwise. * @return #EINA_TRUE if there was an IO error, #EINA_FALSE otherwise.
* *
* @since 1.2 * @since 1.2

2
legacy/eina/src/include/eina_mmap.h
View File

@ -18,7 +18,7 @@
* @return #EINA_TRUE on success, #EINA_FALSE on failure. * @return #EINA_TRUE on success, #EINA_FALSE on failure.
* *
* This enables (if possible on your platform) a signal handler for * This enables (if possible on your platform) a signal handler for
* SIGBUS, that replaces the "bad page" with a pzge of 0's (from /dev/zero) * SIGBUS, that replaces the "bad page" with a page of 0's (from /dev/zero)
* if a SIGBUS occurs. This allows for safe mmap() of files that may truncate * if a SIGBUS occurs. This allows for safe mmap() of files that may truncate
* or from files on devices with IO errors. Normally these cases will result * or from files on devices with IO errors. Normally these cases will result
* in a SIGBUS being delivered (and termination of your process), but * in a SIGBUS being delivered (and termination of your process), but

10
legacy/eina/src/include/eina_module.h
View File

@ -50,7 +50,7 @@
* *
* The loaded shared objects may have two visible functions that will * The loaded shared objects may have two visible functions that will
* be called and might provide initialization and shutdown * be called and might provide initialization and shutdown
* proceedures. The symbols are @c __eina_module_init and * procedures. The symbols are @c __eina_module_init and
* @c __eina_module_shutdown and will be defined by the macros * @c __eina_module_shutdown and will be defined by the macros
* EINA_MODULE_INIT() and EINA_MODULE_SHUTDOWN(). * EINA_MODULE_INIT() and EINA_MODULE_SHUTDOWN().
* *
@ -162,11 +162,11 @@ EAPI Eina_Bool
* #EINA_FALSE is returned. If it is a internal Eina module and the * #EINA_FALSE is returned. If it is a internal Eina module and the
* module can not be initialized, the error * module can not be initialized, the error
* #EINA_ERROR_MODULE_INIT_FAILED is set and #EINA_FALSE is * #EINA_ERROR_MODULE_INIT_FAILED is set and #EINA_FALSE is
* returned. If the module has already been loaded, it's refeence * returned. If the module has already been loaded, it's reference
* counter is increased by one and #EINA_TRUE is returned. If @p module is * counter is increased by one and #EINA_TRUE is returned. If @p module is
* @c NULL, the function returns immediately #EINA_FALSE. * @c NULL, the function returns immediately #EINA_FALSE.
* *
* When the symbols of the shared file objetcts are not needed * When the symbols of the shared file objects are not needed
* anymore, call eina_module_unload() to unload the module. * anymore, call eina_module_unload() to unload the module.
*/ */
EAPI Eina_Bool EAPI Eina_Bool
@ -190,7 +190,7 @@ EAPI Eina_Bool
eina_module_unload(Eina_Module *module) EINA_ARG_NONNULL(1); eina_module_unload(Eina_Module *module) EINA_ARG_NONNULL(1);
/** /**
* @brief Retrive the data associated to a symbol. * @brief Retrieve the data associated to a symbol.
* *
* @param module The module. * @param module The module.
* @param symbol The symbol. * @param symbol The symbol.
@ -236,7 +236,7 @@ EAPI char *
eina_module_symbol_path_get(const void *symbol, const char *sub_dir) EINA_PURE EINA_MALLOC EINA_ARG_NONNULL(1, 2); eina_module_symbol_path_get(const void *symbol, const char *sub_dir) EINA_PURE EINA_MALLOC EINA_ARG_NONNULL(1, 2);
/** /**
* @brief Return the path built from the value of an environment varialbe and a * @brief Return the path built from the value of an environment variable and a
* given sub directory. * given sub directory.
* *
* @param env The environment variable to expand. * @param env The environment variable to expand.

4
legacy/eina/src/include/eina_prefix.h
View File

@ -38,9 +38,9 @@ typedef struct _Eina_Prefix Eina_Prefix;
* @return The prefix handle, or NULL on failure * @return The prefix handle, or NULL on failure
* *
* Applications and libraries are most often not just single executables nor * Applications and libraries are most often not just single executables nor
* single shared library binares, but also come with extra modules they * single shared library binaries, but also come with extra modules they
* have to load, extra binary utilities they need to run, or have data files * have to load, extra binary utilities they need to run, or have data files
* they need to load. A very primitve application ASSUMES a fixed install * 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 re-locate
* the application (or library) somewhere else after compilation (if you run * the application (or library) somewhere else after compilation (if you run
* out of space on a given disk, partition etc. for example), or necessitate * out of space on a given disk, partition etc. for example), or necessitate

6
legacy/eina/src/include/eina_tiler.h
View File

@ -118,8 +118,8 @@
* @section grid_slicer Grid Slicer * @section grid_slicer Grid Slicer
* *
* Grid slicer and Eina_Tiler are usually used together, that is however @b not * Grid slicer and Eina_Tiler are usually used together, that is however @b not
* nescessary, they can be used independently. Grid slicer provides an easy API * necessary, they can be used independently. Grid slicer provides an easy API
* to divide an area in tiles which is usefull in certain applications to divide * to divide an area in tiles which is useful in certain applications to divide
* the area that will be rendered into tiles. It's customary to, then create one * the area that will be rendered into tiles. It's customary to, then create one
* Eina_Tiler for each tile. * Eina_Tiler for each tile.
* *
@ -257,7 +257,7 @@ EAPI Eina_Iterator *eina_tiler_iterator_new(const Eina_Tiler *t);
* iterate over every tile in the grid having as its data a * iterate over every tile in the grid having as its data a
* #Eina_Tile_Grid_Info. * #Eina_Tile_Grid_Info.
* *
* @note This is a convinience function, iterating over the returned iterator is * @note This is a convenience function, iterating over the returned iterator is
* equivalent to calling eina_tile_grid_slicer_setup() and calling * equivalent to calling eina_tile_grid_slicer_setup() and calling
* eina_tile_grid_slicer_next() untill it returns EINA_FALSE. * eina_tile_grid_slicer_next() untill it returns EINA_FALSE.
*/ */