enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

eet: update callback API documentation. 

Adding some documentation on callbacks typedefs for :
- Eet_Descriptor
- Eet_Dump
This commit is contained in:
Philippe Caseiro 2014-10-16 16:38:31 +02:00 committed by Cedric BAIL
parent 4c0b383dc4
commit 5bb7034774
1 changed files with 168 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
src/lib/eet/Eet.h
View File

@ -137,7 +137,15 @@ extern "C" {
*
*/
/**
* @def EET_VERSION_MAJOR
* The major number of eet version
*/
#define EET_VERSION_MAJOR EFL_VERSION_MAJOR
/**
* @def EET_VERSION_MINOR
* The minor number of eet version
*/
#define EET_VERSION_MINOR EFL_VERSION_MINOR
/**
* @typedef Eet_Version
@ -210,7 +218,7 @@ typedef enum _Eet_Error
/**
* @}
*/
/**
* @defgroup Eet_Compression Eet Compression Levels
* @ingroup Eet
@ -233,14 +241,14 @@ typedef enum _Eet_Compression
EET_COMPRESSION_HI = 9, /**< Slow but high compression level (Zlib) @since 1.7 */
EET_COMPRESSION_VERYFAST = 10, /**< Very fast, but lower compression ratio (LZ4HC) @since 1.7 */
EET_COMPRESSION_SUPERFAST = 11, /**< Very fast, but lower compression ratio (faster to compress than EET_COMPRESSION_VERYFAST) (LZ4) @since 1.7 */
EET_COMPRESSION_LOW2 = 3, /**< Space filler for compatibility. Don't use it @since 1.7 */
EET_COMPRESSION_MED1 = 4, /**< Space filler for compatibility. Don't use it @since 1.7 */
EET_COMPRESSION_MED2 = 5, /**< Space filler for compatibility. Don't use it @since 1.7 */
EET_COMPRESSION_HI1 = 7, /**< Space filler for compatibility. Don't use it @since 1.7 */
EET_COMPRESSION_HI2 = 8 /**< Space filler for compatibility. Don't use it @since 1.7 */
} Eet_Compression; /**< Eet compression modes @since 1.7 */
/**
* @}
*/
@ -1457,6 +1465,7 @@ eet_data_image_header_read_cipher(Eet_File *ef,
*
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param cipher_key The key to use as cipher.
* @param cspaces Returned pointer by Eet to a list of possible decoding colorspace finished by @c EET_COLORSPACE_ARGB8888. If @c NULL, only EET_COLORSPACE_ARGB8888 is supported.
* @return 1 on successful get, 0 otherwise.
*
@ -1591,7 +1600,7 @@ eet_data_image_read_to_surface_cipher(Eet_File *ef,
* @param row_stride The length of a pixels line in the destination surface.
* @param cspace The color space of the pixels bsurface.
* @param alpha A pointer to the int to hold the alpha flag.
* @param compress A pointer to the int to hold the compression amount.
* @param comp A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
* @return 1 on success, 0 otherwise.
@ -1653,7 +1662,7 @@ eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef,
* @param row_stride The length of a pixels line in the destination surface.
* @param cspace The color space of the pixel surface
* @param alpha A pointer to the int to hold the alpha flag.
* @param compress A pointer to the int to hold the compression amount.
* @param comp A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
* @return 1 on success, 0 otherwise.
@ -2606,24 +2615,168 @@ typedef struct _Eet_Data_Descriptor Eet_Data_Descriptor;
*/
typedef struct _Eet_Data_Descriptor_Class Eet_Data_Descriptor_Class;
/**
* @typedef (*Eet_Descriptor_Hash_Foreach_Callback_Callback)
*
* Callback prototype for Eet_Descriptor_Hash_Foreach_Callback
* @param h the hash
* @param k the key
* @param dt the data
* @param fdt the data passed to the callback
* @return an integer
*/
typedef int (*Eet_Descriptor_Hash_Foreach_Callback_Callback)(void *h, const char *k, void *dt, void *fdt);
/**
* @typedef (*Eet_Descriptor_Mem_Alloc_Callback)
*
* Callback prototype for Eet_Descriptor_Mem_Alloc
* @param size is the size of memory to alloc on call of the callback
*/
typedef void * (*Eet_Descriptor_Mem_Alloc_Callback)(size_t size);
/**
* @typedef (*Eet_Descriptor_Mem_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Mem_Alloc
* @param mem must be a pointer to free on call of the callback
*/
typedef void (*Eet_Descriptor_Mem_Free_Callback)(void *mem);
/**
* @typedef (*Eet_Descriptor_Str_Alloc_Callback)
*
* Callback prototype for Eet_Descriptor_Str_Alloc
* @param str must be the string to alloc
* @return have must be an allocated char * for the given string
*/
typedef char * (*Eet_Descriptor_Str_Alloc_Callback)(const char *str);
/**
* @typedef (*Eet_Descriptor_Str_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Str_Free
* @param str must be an allocated string to free
*/
typedef void (*Eet_Descriptor_Str_Free_Callback)(const char *str);
/**
* @typedef (*Eet_Descriptor_List_Next_Callback)
*
* Callback prototype for Eet_Descriptor_List_Next
* @param l must be a pointer to the list
* @return must be a pointer to the list
*/
typedef void * (*Eet_Descriptor_List_Next_Callback)(void *l);
/**
* @typedef (*Eet_Descriptor_List_Append_Callback)
*
* Callback prototype for Eet_Descriptor_List_Append
* @param l must be a pointer to the list
* @param d the data to append to the list
* @return must be a pointer to the list
*/
typedef void * (*Eet_Descriptor_List_Append_Callback)(void *l, void *d);
/**
* @typedef (*Eet_Descriptor_List_Data_Callback)
*
* Callback prototype for Eet_Descriptor_List_Data
* @param l must be a pointer to the list
* @return must be a pointer to the list
*/
typedef void * (*Eet_Descriptor_List_Data_Callback)(void *l);
/**
* @typedef (*Eet_Descriptor_List_Free_Callback)
*
* Callback prototype for Eet_Descriptor_List_Free
* @param l must be a pointer to the list to free
*/
typedef void * (*Eet_Descriptor_List_Free_Callback)(void *l);
/**
* @typedef (*Eet_Descriptor_Hash_Foreach_Callback)
*
* Callback for Eet_Descriptor_Hash_Foreach
* @param h the hash
* @param func the function callback to call on each iteration
* @param fdt the data to pass to the callbac setted in param func
*/
typedef void (*Eet_Descriptor_Hash_Foreach_Callback)(void *h, Eet_Descriptor_Hash_Foreach_Callback_Callback func, void *fdt);
/**
* @typedef (*Eet_Descriptor_Hash_Add_Callback)
*
* Callback prototype for Eet_Descriptor_Hash_Add
* @param h the hash
* @param k the key
* @param d the data to associate with the 'k' key
*/
typedef void * (*Eet_Descriptor_Hash_Add_Callback)(void *h, const char *k, void *d);
/**
* @typedef (*Eet_Descriptor_Hash_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Hash_Free
* @param h the hash to free
*/
typedef void (*Eet_Descriptor_Hash_Free_Callback)(void *h);
/**
* @typedef (*Eet_Descriptor_Str_Alloc_Callback)
*
* Callback prototype for Eet_Descriptor_Str_Alloc
* @param str the string to allocate
* @return an allocated pointer to the string
*/
typedef char * (*Eet_Descriptor_Str_Direct_Alloc_Callback)(const char *str);
/**
* @typedef (*Eet_Descriptor_Str_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Str_Free
* @param str the string to free
*/
typedef void (*Eet_Descriptor_Str_Direct_Free_Callback)(const char *str);
/**
* @typedef (*Eet_Descriptor_Type_Get_Callback)
*
* Callback prototype for Eet_Descriptor_Type_Get
* @param data data to pass to the callback
* @param unknow Eina_Bool __FIXME__
*/
typedef const char * (*Eet_Descriptor_Type_Get_Callback)(const void *data, Eina_Bool *unknow);
/**
* @typedef (*Eet_Descriptor_Type_Set_Callback)
*
* Callback prototype for Eet_Descriptor_Type_Set
* @param type the type to set
* @param data to pass to the callback
* @param unknow Eina_Bool __FIXME__
*/
typedef Eina_Bool (*Eet_Descriptor_Type_Set_Callback)(const char *type, void *data, Eina_Bool unknow);
/**
* @typedef (*Eet_Descriptor_Array_Alloc_Callback)
*
* Callback prototype for Eet_Descriptor_Array_Alloc
* @param size The size of the array
*/
typedef void * (*Eet_Descriptor_Array_Alloc_Callback)(size_t size);
/**
* @typedef (*Eet_Descriptor_Array_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Array_Free
* @param size The size of the array
*/
typedef void (*Eet_Descriptor_Array_Free_Callback)(void *mem);
/**
* @struct _Eet_Data_Descriptor_Class
@ -3006,6 +3159,15 @@ eet_data_write(Eet_File *ef,
const void *data,
int compress);
/**
* @typedef Eet_Data_Descriptor_Class
*
* Callback protoype for Eet_Dump
*
* @param data to passe to the callback
* @param str the string to dump
*
*/
typedef void (*Eet_Dump_Callback)(void *data, const char *str);
/**
@ -4260,7 +4422,7 @@ EAPI Eet_Node *
eet_node_parent_get(Eet_Node *node);
/**
* TODO FIX ME
* @brief Append a "list" node TODO FIX ME
* @ingroup Eet_Node_Group
*/
EAPI void