summaryrefslogtreecommitdiff
path: root/legacy/eet/src
diff options
context:
space:
mode:
authorJihoon Kim <imfine98@gmail.com>2012-04-05 04:12:10 +0000
committerJihoon Kim <imfine98@gmail.com>2012-04-05 04:12:10 +0000
commite720fc2b3c623a1acb310398072c6e599b108dc7 (patch)
tree1eacf47d5179145b89fb38d9fab770f8e204d345 /legacy/eet/src
parentb577922464580c0a2d24b0d39ac1dd05d2215911 (diff)
Eet.h: fix typos
SVN revision: 69926
Diffstat (limited to 'legacy/eet/src')
-rw-r--r--legacy/eet/src/lib/Eet.h38
1 files changed, 19 insertions, 19 deletions
diff --git a/legacy/eet/src/lib/Eet.h b/legacy/eet/src/lib/Eet.h
index 187ac2959a..38b40a7cc9 100644
--- a/legacy/eet/src/lib/Eet.h
+++ b/legacy/eet/src/lib/Eet.h
@@ -217,7 +217,7 @@ typedef struct _Eet_Version
217 int major; /** < major (binary or source incompatible changes) */ 217 int major; /** < major (binary or source incompatible changes) */
218 int minor; /** < minor (new features, bugfixes, major improvements version) */ 218 int minor; /** < minor (new features, bugfixes, major improvements version) */
219 int micro; /** < micro (bugfix, internal improvements, no new features version) */ 219 int micro; /** < micro (bugfix, internal improvements, no new features version) */
220 int revision; /** < svn revision (0 if a proper rlease or the svn revsion number Eet is built from) */ 220 int revision; /** < svn revision (0 if a proper release or the svn revision number Eet is built from) */
221} Eet_Version; 221} Eet_Version;
222 222
223EAPI extern Eet_Version *eet_version; 223EAPI extern Eet_Version *eet_version;
@@ -264,8 +264,8 @@ typedef enum _Eet_Error
264 * Initialize the EET library. 264 * Initialize the EET library.
265 * 265 *
266 * The first time this function is called, it will perform all the internal 266 * The first time this function is called, it will perform all the internal
267 * initialization required for the library to function properly and incrememnt 267 * initialization required for the library to function properly and increment
268 * the initializiation counter. Any subsequent call only increment this counter 268 * the initialization counter. Any subsequent call only increment this counter
269 * and return its new value, so it's safe to call this function more than once. 269 * and return its new value, so it's safe to call this function more than once.
270 * 270 *
271 * @return The new init count. Will be 0 if initialization failed. 271 * @return The new init count. Will be 0 if initialization failed.
@@ -357,7 +357,7 @@ eet_clearcache(void);
357 * 357 *
358 * Next, we copy into our buffer our set of strings, including their null 358 * Next, we copy into our buffer our set of strings, including their null
359 * terminators and write them into the file. No error checking for the sake 359 * terminators and write them into the file. No error checking for the sake
360 * of brevitiy. And a call to eet_sync() to make sure all out data is 360 * of brevity. And a call to eet_sync() to make sure all out data is
361 * properly written down to disk, even though we haven't yet closed the file. 361 * properly written down to disk, even though we haven't yet closed the file.
362 * @until eet_sync 362 * @until eet_sync
363 * 363 *
@@ -488,7 +488,7 @@ typedef enum _Eet_File_Mode
488 * 488 *
489 * This handle will be returned by the functions eet_open() and 489 * This handle will be returned by the functions eet_open() and
490 * eet_memopen_read() and is used by every other function that affects the 490 * eet_memopen_read() and is used by every other function that affects the
491 * file in any way. When you are done with it, call eet_close() to clsoe it 491 * file in any way. When you are done with it, call eet_close() to close it
492 * and, if the file was open for writing, write down to disk any changes made 492 * and, if the file was open for writing, write down to disk any changes made
493 * to it. 493 * to it.
494 * 494 *
@@ -622,7 +622,7 @@ eet_sync(Eet_File *ef);
622 * 622 *
623 * @see eet_dictionary_string_check() to know if given string came 623 * @see eet_dictionary_string_check() to know if given string came
624 * from the dictionary or it was dynamically allocated using 624 * from the dictionary or it was dynamically allocated using
625 * the #Eet_Data_Descriptor_Class instructrions. 625 * the #Eet_Data_Descriptor_Class instructions.
626 * 626 *
627 * @since 1.0.0 627 * @since 1.0.0
628 * @ingroup Eet_File_Group 628 * @ingroup Eet_File_Group
@@ -696,7 +696,7 @@ eet_read(Eet_File *ef,
696 * This function finds an entry in the eet file that is stored under the 696 * This function finds an entry in the eet file that is stored under the
697 * name specified, and returns that data if not compressed and successful. 697 * name specified, and returns that data if not compressed and successful.
698 * NULL is returned if the lookup fails or if memory errors are 698 * NULL is returned if the lookup fails or if memory errors are
699 * encountered or if the data is comrpessed. The calling program must never 699 * encountered or if the data is compressed. The calling program must never
700 * call free() on the returned data. The number of bytes in the returned 700 * call free() on the returned data. The number of bytes in the returned
701 * data chunk are placed in size_ret. 701 * data chunk are placed in size_ret.
702 * 702 *
@@ -1791,7 +1791,7 @@ eet_identity_open(const char *certificate_file,
1791 Eet_Key_Password_Callback cb); 1791 Eet_Key_Password_Callback cb);
1792 1792
1793/** 1793/**
1794 * Close and release all ressource used by an Eet_Key. An 1794 * Close and release all resource used by an Eet_Key. An
1795 * reference counter prevent it from being freed until all file 1795 * reference counter prevent it from being freed until all file
1796 * using it are also closed. 1796 * using it are also closed.
1797 * 1797 *
@@ -2005,7 +2005,7 @@ eet_identity_certificate_print(const unsigned char *certificate,
2005 * use it to load older configuration files and update them as needed. 2005 * use it to load older configuration files and update them as needed.
2006 * @until } 2006 * @until }
2007 * 2007 *
2008 * Finally, clsoe the file and return the newly loaded config data. 2008 * Finally, close the file and return the newly loaded config data.
2009 * @until } 2009 * @until }
2010 * 2010 *
2011 * Saving data is just as easy. The full version of the following function 2011 * Saving data is just as easy. The full version of the following function
@@ -2090,7 +2090,7 @@ eet_identity_certificate_print(const unsigned char *certificate,
2090 * We won't ignore the headers this time to show how easy it is to use Eina 2090 * We won't ignore the headers this time to show how easy it is to use Eina
2091 * data types with Eet, but we'll still skip most of the code that is not 2091 * data types with Eet, but we'll still skip most of the code that is not
2092 * pertinent to what we want to show now, but as usual, you can get it full 2092 * pertinent to what we want to show now, but as usual, you can get it full
2093 * by follwing @ref eet-data-nested.c "this link". 2093 * by following @ref eet-data-nested.c "this link".
2094 * 2094 *
2095 * @dontinclude eet-data-nested.c 2095 * @dontinclude eet-data-nested.c
2096 * @skipline Eina.h 2096 * @skipline Eina.h
@@ -2405,7 +2405,7 @@ typedef void (*Eet_Descriptor_Array_Free_Callback)(vo
2405 * Instructs Eet about memory management for different needs under 2405 * Instructs Eet about memory management for different needs under
2406 * serialization and parse process. 2406 * serialization and parse process.
2407 * 2407 *
2408 * The list and hash methods match the Eina API, so for a more detalied 2408 * The list and hash methods match the Eina API, so for a more detailed
2409 * reference on them, look at the Eina_List and Eina_Hash documentation, 2409 * reference on them, look at the Eina_List and Eina_Hash documentation,
2410 * respectively. 2410 * respectively.
2411 * For the most part these will be used with the standard Eina functions, 2411 * For the most part these will be used with the standard Eina functions,
@@ -2459,7 +2459,7 @@ struct _Eet_Data_Descriptor_Class
2459 * @param func_hash_free The function to free an entire hash table. 2459 * @param func_hash_free The function to free an entire hash table.
2460 * @return A new empty data descriptor. 2460 * @return A new empty data descriptor.
2461 * 2461 *
2462 * This function creates a new data descriptore and returns a handle to the 2462 * This function creates a new data descriptor and returns a handle to the
2463 * new data descriptor. On creation it will be empty, containing no contents 2463 * new data descriptor. On creation it will be empty, containing no contents
2464 * describing anything other than the shell of the data structure. 2464 * describing anything other than the shell of the data structure.
2465 * 2465 *
@@ -2544,7 +2544,7 @@ eet_data_descriptor_stream_new(const Eet_Data_Descriptor_Class *eddc);
2544 * adding to the description. 2544 * adding to the description.
2545 * 2545 *
2546 * Once you have described all the members of a struct you want loaded or 2546 * Once you have described all the members of a struct you want loaded or
2547 * savedi, eet can load and save those members for you, encode them into 2547 * saved, eet can load and save those members for you, encode them into
2548 * endian-independent serialised data chunks for transmission across a 2548 * endian-independent serialised data chunks for transmission across a
2549 * a network or more. 2549 * a network or more.
2550 * 2550 *
@@ -2691,7 +2691,7 @@ eet_data_descriptor_free(Eet_Data_Descriptor *edd);
2691 * #EET_T_INT. If #EET_T_UNKNOW, then it is considered to be a 2691 * #EET_T_INT. If #EET_T_UNKNOW, then it is considered to be a
2692 * group, list or hash. 2692 * group, list or hash.
2693 * @param group_type If element type is #EET_T_UNKNOW, then the @p 2693 * @param group_type If element type is #EET_T_UNKNOW, then the @p
2694 * group_type will speficy if it is a list (#EET_G_LIST), 2694 * group_type will specify if it is a list (#EET_G_LIST),
2695 * array (#EET_G_ARRAY) and so on. If #EET_G_UNKNOWN, then 2695 * array (#EET_G_ARRAY) and so on. If #EET_G_UNKNOWN, then
2696 * the member is a subtype (pointer to another type defined by 2696 * the member is a subtype (pointer to another type defined by
2697 * another #Eet_Data_Descriptor). 2697 * another #Eet_Data_Descriptor).
@@ -2751,7 +2751,7 @@ eet_data_read(Eet_File *ef,
2751 * @param ef The eet file handle to write to. 2751 * @param ef The eet file handle to write to.
2752 * @param edd The data descriptor to use when encoding. 2752 * @param edd The data descriptor to use when encoding.
2753 * @param name The key to store the data under in the eet file. 2753 * @param name The key to store the data under in the eet file.
2754 * @param data A pointer to the data structure to ssave and encode. 2754 * @param data A pointer to the data structure to save and encode.
2755 * @param compress Compression flags for storage. 2755 * @param compress Compression flags for storage.
2756 * @return bytes written on successful write, 0 on failure. 2756 * @return bytes written on successful write, 0 on failure.
2757 * 2757 *
@@ -2952,7 +2952,7 @@ eet_data_descriptor_decode(Eet_Data_Descriptor *edd,
2952 * serialised chunk of data that can be decoded again by 2952 * serialised chunk of data that can be decoded again by
2953 * eet_data_descriptor_decode(). This is useful for being able to transmit 2953 * eet_data_descriptor_decode(). This is useful for being able to transmit
2954 * data structures across sockets, pipes, IPC or shared file mechanisms, 2954 * data structures across sockets, pipes, IPC or shared file mechanisms,
2955 * without having to worry about memory space, machine type, endianess etc. 2955 * without having to worry about memory space, machine type, endianness etc.
2956 * 2956 *
2957 * The parameter @p edd must point to a valid data descriptor, and 2957 * The parameter @p edd must point to a valid data descriptor, and
2958 * @p data_in must point to the right data structure to encode. If not, the 2958 * @p data_in must point to the right data structure to encode. If not, the
@@ -3453,7 +3453,7 @@ eet_data_xattr_cipher_get(const char *filename,
3453 * @param edd The data descriptor to use when encoding. 3453 * @param edd The data descriptor to use when encoding.
3454 * @param name The key to store the data under in the eet file. 3454 * @param name The key to store the data under in the eet file.
3455 * @param cipher_key The key to use as cipher. 3455 * @param cipher_key The key to use as cipher.
3456 * @param data A pointer to the data structure to ssave and encode. 3456 * @param data A pointer to the data structure to save and encode.
3457 * @param compress Compression flags for storage. 3457 * @param compress Compression flags for storage.
3458 * @return bytes written on successful write, 0 on failure. 3458 * @return bytes written on successful write, 0 on failure.
3459 * 3459 *
@@ -3478,7 +3478,7 @@ eet_data_write_cipher(Eet_File *ef,
3478 * @param attribute The attribute to store the data to. 3478 * @param attribute The attribute to store the data to.
3479 * @param edd The data descriptor to use when encoding. 3479 * @param edd The data descriptor to use when encoding.
3480 * @param cipher_key The key to use as cipher. 3480 * @param cipher_key The key to use as cipher.
3481 * @param data A pointer to the data structure to ssave and encode. 3481 * @param data A pointer to the data structure to save and encode.
3482 * @param flags The policy to use when setting the data. 3482 * @param flags The policy to use when setting the data.
3483 * @return EINA_TRUE on success, EINA_FALSE on failure. 3483 * @return EINA_TRUE on success, EINA_FALSE on failure.
3484 * 3484 *
@@ -4102,7 +4102,7 @@ typedef struct _Eet_Connection Eet_Connection;
4102 4102
4103/** 4103/**
4104 * @typedef Eet_Read_Cb 4104 * @typedef Eet_Read_Cb
4105 * Called back when an @ref Eet_Data_Group has been received completly and could be used. 4105 * Called back when an @ref Eet_Data_Group has been received completely and could be used.
4106 * 4106 *
4107 * @ingroup Eet_Connection_Group 4107 * @ingroup Eet_Connection_Group
4108 */ 4108 */