cedric pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=d7600d6b559f02d8aff410761487617a59587805
commit d7600d6b559f02d8aff410761487617a59587805
Author: Chidambar Zinnoury <chidambar.zinno...@zefla.fr>
Date: Fri Oct 17 17:08:26 2014 +0200
edje: documentation for edje_convert.h.
---
src/lib/edje/edje_convert.h | 208 ++++++++++++++++++++++++++------------------
1 file changed, 123 insertions(+), 85 deletions(-)
diff --git a/src/lib/edje/edje_convert.h b/src/lib/edje/edje_convert.h
index 4d0248a..c37afd7 100644
--- a/src/lib/edje/edje_convert.h
+++ b/src/lib/edje/edje_convert.h
@@ -1,72 +1,98 @@
#ifndef EDJE_CONVERT_H__
# define EDJE_CONVERT_H__
-typedef struct _Old_Edje_Image_Directory Old_Edje_Image_Directory;
-typedef struct _Old_Edje_Font_Directory Old_Edje_Font_Directory;
-typedef struct _Old_Edje_External_Directory Old_Edje_External_Directory;
-typedef struct _Old_Edje_Part Old_Edje_Part;
-typedef struct _Old_Edje_Part_Collection Old_Edje_Part_Collection;
-typedef struct _Old_Edje_Part_Description Old_Edje_Part_Description;
-typedef struct _Old_Edje_Part_Description_Spec_Image
Old_Edje_Part_Description_Spec_Image;
-typedef struct _Edje_Data Edje_Data;
+typedef struct _Old_Edje_Image_Directory Old_Edje_Image_Directory; /**<
An old Edje image directory */
+typedef struct _Old_Edje_Font_Directory Old_Edje_Font_Directory; /**<
An old Edje font directory */
+typedef struct _Old_Edje_External_Directory Old_Edje_External_Directory;
/**< An old Edje external directory */
+typedef struct _Old_Edje_Part Old_Edje_Part; /**< An old Edje
part */
+typedef struct _Old_Edje_Part_Collection Old_Edje_Part_Collection; /**<
An old Edje part collection */
+typedef struct _Old_Edje_Part_Description Old_Edje_Part_Description;
/**< An old Edje part description */
+typedef struct _Old_Edje_Part_Description_Spec_Image
Old_Edje_Part_Description_Spec_Image; /**< An old Edje part description image */
+typedef struct _Edje_Data Edje_Data; /**< A key/value
tuple */
+
+/**
+ * @struct _Edje_Data
+ * @brief A structure that stores a key/value tuple.
+ */
struct _Edje_Data
{
- const char *key;
- char *value;
+ const char *key; /**< key name */
+ char *value; /**< contents value */
};
/*----------*/
+/**
+ * @struct _Old_Edje_Font_Directory
+ * @brief A structure that stores old font directory entries.
+ */
struct _Old_Edje_Font_Directory
{
- Eina_List *entries; /* a list of Edje_Font_Directory_Entry */
+ Eina_List *entries; /**< a list of Edje_Font_Directory_Entry */
};
+/**
+ * @struct _Old_Edje_Image_Directory
+ * @brief A structure that stores old image directory entries.
+ */
struct _Old_Edje_Image_Directory
{
- Eina_List *entries; /* a list of Edje_Image_Directory_Entry */
- Eina_List *sets; /* a list of Edje_Image_Directory_Set */
+ Eina_List *entries; /**< a list of Edje_Image_Directory_Entry */
+ Eina_List *sets; /**< a list of Edje_Image_Directory_Set */
};
+/**
+ * @struct _Old_Edje_External_Directory
+ * @brief A structure that stores old external directory entries.
+ */
struct _Old_Edje_External_Directory
{
- Eina_List *entries; /* a list of Edje_External_Directory_Entry */
+ Eina_List *entries; /**< a list of Edje_External_Directory_Entry */
};
+/**
+ * @struct _Old_Edje_File
+ * @brief A structure that stores old Edje files information.
+ */
struct _Old_Edje_File
{
- const char *path;
- time_t mtime;
-
- Old_Edje_External_Directory *external_dir;
- Old_Edje_Font_Directory *font_dir;
- Old_Edje_Image_Directory *image_dir;
- Edje_Part_Collection_Directory *collection_dir;
- Eina_List *data;
- Eina_List *styles;
- Eina_List *color_classes;
-
- const char *compiler;
- int version;
- int feature_ver;
+ const char *path; /**< path */
+ time_t mtime; /**< modification time */
+
+ Old_Edje_External_Directory *external_dir; /**< external directory */
+ Old_Edje_Font_Directory *font_dir; /**< fonts directory */
+ Old_Edje_Image_Directory *image_dir; /**< images directory */
+ Edje_Part_Collection_Directory *collection_dir; /**< collection directory */
+ Eina_List *data; /**< list of Edje_Data */
+ Eina_List *styles; /**< list of Edje_Style */
+ Eina_List *color_classes; /**< list of
Edje_Color_Class */
+
+ const char *compiler; /**< compiler name */
+ int version; /**< Edje version */
+ int feature_ver; /**< features version */
};
+/**
+ * @struct _Old_Edje_Part_Collection
+ * @brief A structure that stores old Edje part collection information.
+ */
struct _Old_Edje_Part_Collection
{
- Eina_List *programs; /* a list of Edje_Program */
- Eina_List *parts; /* a list of Edje_Part */
- Eina_List *data;
+ Eina_List *programs; /**< a list of Edje_Program */
+ Eina_List *parts; /**< a list of Edje_Part */
+ Eina_List *data; /**< a list of Edje_Data */
- int id; /* the collection id */
+ int id; /**< the collection id */
- Eina_Hash *alias; /* aliasing part*/
+ Eina_Hash *alias; /**< aliasing part*/
struct {
- Edje_Size min, max;
+ Edje_Size min; /**< minimum size */
+ Edje_Size max; /**< maximum size */
} prop;
- int references;
+ int references; /**< references count */
#ifdef EDJE_PROGRAM_CACHE
struct {
Eina_Hash *no_matches;
@@ -74,86 +100,98 @@ struct _Old_Edje_Part_Collection
} prog_cache;
#endif
- Embryo_Program *script; /* all the embryo script code for this group */
- const char *part;
+ Embryo_Program *script; /**< all the embryo script code for this group */
+ const char *part; /**< part name */
- unsigned char script_only;
+ unsigned char script_only; /**< script only */
- unsigned char lua_script_only;
+ unsigned char lua_script_only; /** LUA script only */
- unsigned char checked : 1;
+ unsigned char checked : 1; /**< contents checked and registered */
};
+/**
+ * @struct _Old_Edje_Part
+ * @brief A structure that stores old Edje part information.
+ */
struct _Old_Edje_Part
{
- const char *name; /* the name if any of the part */
- Old_Edje_Part_Description *default_desc; /* the part descriptor for default
*/
- Eina_List *other_desc; /* other possible descriptors */
+ const char *name; /**< the name if any of the part */
+ Old_Edje_Part_Description *default_desc; /**< the part descriptor for
default */
+ Eina_List *other_desc; /**< other possible descriptors */
const char *source, *source2, *source3, *source4, *source5,
*source6;
- int id; /* its id number */
- int clip_to_id; /* the part id to clip this one to */
- Edje_Part_Dragable dragable;
- Eina_List *items; /* packed items for box and table */
- unsigned char type; /* what type (image, rect, text) */
- unsigned char effect; /* 0 = plain... */
- unsigned char mouse_events; /* it will affect/respond to mouse
events */
- unsigned char repeat_events; /* it will repeat events to objects
below */
- Evas_Event_Flags ignore_flags;
- unsigned char scale; /* should certain properties scale with edje
scale factor? */
- unsigned char precise_is_inside;
- unsigned char use_alternate_font_metrics;
- unsigned char pointer_mode;
- unsigned char entry_mode;
- unsigned char select_mode;
- unsigned char multiline;
- Edje_Part_Api api;
+ int id; /**< its id number */
+ int clip_to_id; /**< the part id to clip this one to */
+ Edje_Part_Dragable dragable; /**< dragable part */
+ Eina_List *items; /**< packed items for box and table */
+ unsigned char type; /**< what type (image, rect, text) */
+ unsigned char effect; /**< 0 = plain... */
+ unsigned char mouse_events; /**< it will affect/respond to mouse
events */
+ unsigned char repeat_events; /**< it will repeat events to objects
below */
+ Evas_Event_Flags ignore_flags; /**< ignore flags */
+ unsigned char scale; /**< should certain properties scale with
edje scale factor? */
+ unsigned char precise_is_inside; /**< whether is precisely inside
*/
+ unsigned char use_alternate_font_metrics; /**< use alternate font
metrics */
+ unsigned char pointer_mode; /**< pointer mode */
+ unsigned char entry_mode; /**< entry mode */
+ unsigned char select_mode; /**< entry selection mode */
+ unsigned char multiline; /**< multiline enabled */
+ Edje_Part_Api api; /**< part API */
};
+/**
+ * @struct _Old_Edje_Part_Description_Spec_Image
+ * @brief A structure that stores old Edje part description image information.
+ */
struct _Old_Edje_Part_Description_Spec_Image
{
- Eina_List *tween_list; /* list of Edje_Part_Image_Id */
- int id; /* the image id to use */
- int scale_hint; /* evas scale hint */
- Eina_Bool set; /* if image condition it's content */
+ Eina_List *tween_list; /**< list of Edje_Part_Image_Id */
+ int id; /**< the image id to use */
+ int scale_hint; /**< evas scale hint */
+ Eina_Bool set; /**< if image condition it's content */
- Edje_Part_Description_Spec_Border border;
- Edje_Part_Description_Spec_Fill fill;
+ Edje_Part_Description_Spec_Border border; /**< border settings */
+ Edje_Part_Description_Spec_Fill fill; /**< fill settings */
};
+/**
+ * @struct _Old_Edje_Part_Description
+ * @brief A structure that stores old Edje part description information.
+ */
struct _Old_Edje_Part_Description
{
- Edje_Part_Description_Common common;
- Old_Edje_Part_Description_Spec_Image image;
- Edje_Part_Description_Spec_Text text;
- Edje_Part_Description_Spec_Box box;
- Edje_Part_Description_Spec_Table table;
+ Edje_Part_Description_Common common; /**< common part description */
+ Old_Edje_Part_Description_Spec_Image image; /**< image part description */
+ Edje_Part_Description_Spec_Text text; /**< text part description */
+ Edje_Part_Description_Spec_Box box; /**< box part description */
+ Edje_Part_Description_Spec_Table table; /**< table part description */
- Eina_List *external_params; /* parameters for external objects */
+ Eina_List *external_params; /**< list of Edje_External_Param */
};
/**
- * Convert old edje files into new edje files
+ * Convert old Edje files into new Edje files.
*
- * @param file an Eet_File to write the new edje file
- * @param oedf the old edje file
+ * @param file an Eet_File to write the new Edje file to
+ * @param oedf the old Edje file
*
- * @return An Edje_File pointer to the converted file
+ * @return an Edje_File pointer to the converted file
*/
Edje_File *_edje_file_convert(Eet_File *file, Old_Edje_File *oedf);
/**
- * Convert old edje part collection into the new edje file
+ * Convert old edje part collection into the new Edje file.
*
- * @param file an Eet_File to write the new edje file
- * @param oedc The old edje part collection
+ * @param file an Eet_File to write the new Edje file to
+ * @param oedc The Old edje part collection
*
- * @return a new edje parte collection
+ * @return a new Edje part collection
*/
Edje_Part_Collection *_edje_collection_convert(Edje_File *file,
Old_Edje_Part_Collection *oedc);
/**
- * Convert old edje part descripton into new format
+ * Convert old Edje part descripton into new format.
*
* @param type The edje par description common type
* @param ce an edje collection directory entry
@@ -166,16 +204,16 @@ Edje_Part_Description_Common
*_edje_description_convert(int type,
Old_Edje_Part_Description *oed);
/**
- * Get the current edje file
+ * Get the current Edje file.
*
- * @return the current edje file
+ * @return the current Edje file
*/
const Edje_File *_edje_file_get(void);
/**
- * Set the current edje file
+ * Set the current Edje file.
*
- * @param edf the edje file to set
+ * @param edf the Edje file to set
*
*/
void _edje_file_set(const Edje_File *edf);
--
