Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/engrave
Dir : e17/libs/engrave/src/lib
Modified Files:
Engrave.h engrave_data.c engrave_data.h engrave_file.c
engrave_file.h engrave_font.c engrave_font.h engrave_group.c
engrave_group.h engrave_image.c engrave_image.h engrave_load.c
engrave_load.h engrave_out.c engrave_out.h engrave_part.c
engrave_part.h engrave_program.c engrave_program.h
Log Message:
- shuffle the file and defgroup blocks around to allow the typedefs and
structs to be doc'd
- doc the structs and typedefs
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/Engrave.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- Engrave.h 24 Oct 2004 06:28:37 -0000 1.6
+++ Engrave.h 24 Oct 2004 07:06:37 -0000 1.7
@@ -59,6 +59,13 @@
*
* gcc -o engrave_test `engrave-config --cflags --libs` engrave_test.c
*
+ * @section Conclusion
+ * Engrave has been designed to make it easy to open and maniuplate Edje
+ * files, be they EET or EDC.
+ *
+ * If you have any questions or comments about Engrave please email
+ * dj2 <[EMAIL PROTECTED]> or Rephorm <[EMAIL PROTECTED]>
+ *
*/
#ifdef __cplusplus
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_data.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_data.c 24 Oct 2004 06:28:37 -0000 1.2
+++ engrave_data.c 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,17 +1,6 @@
#include <Engrave.h>
/**
- * @file engrave_data.h Engrave_Data block object
- * @brief Contains all of the functions to manipulate Engrave_Data objects.
- */
-
-/**
- * @defgroup Engrave_Data Engrave_Data: Functions to work with data blocks
- *
- * @{
- */
-
-/**
* engrave_data_new - create a new data block
* @param key: the key to access the block
* @param value: the value to store in the block
@@ -31,7 +20,3 @@
return data;
}
-/**
- * @}
- */
-
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_data.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- engrave_data.h 21 Oct 2004 06:56:38 -0000 1.1
+++ engrave_data.h 24 Oct 2004 07:06:37 -0000 1.2
@@ -1,15 +1,37 @@
#ifndef ENGRAVE_DATA_H
#define ENGRAVE_DATA_H
+/**
+ * @file engrave_data.h Engrave_Data block object
+ * @brief Contains all of the functions to manipulate Engrave_Data objects.
+ */
+
+/**
+ * @defgroup Engrave_Data Engrave_Data: Functions to work with data blocks
+ *
+ * @{
+ */
+
+/**
+ * The Engrave_Data typedef.
+ */
typedef struct _Engrave_Data Engrave_Data;
+
+/**
+ * Stores the information for the data object
+ */
struct _Engrave_Data
{
- char *key;
- char *value;
- int int_value;
+ char *key; /**< The data key */
+ char *value; /**< The data string value */
+ int int_value; /**< The data int value */
};
Engrave_Data * engrave_data_new(char *key, char *value);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_file.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- engrave_file.c 24 Oct 2004 06:28:37 -0000 1.3
+++ engrave_file.c 24 Oct 2004 07:06:37 -0000 1.4
@@ -1,17 +1,6 @@
#include <Engrave.h>
/**
- * @file engrave_file.h Engrave_File object functions.
- * @brief Contains all of the functions related to the Engrave file object
- */
-
-/**
- * @defgroup Engrave_File Engrave_File: Functions to work with the Engrave file object
- *
- * @{
- */
-
-/**
* engrave_file_new - create a new Engrave_File object
*
* @return Returns a pointer to a newly allocated file object on success, NULL on
@@ -115,7 +104,3 @@
return NULL;
}
-/**
- * @}
- */
-
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_file.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_file.h 22 Oct 2004 01:43:14 -0000 1.2
+++ engrave_file.h 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,13 +1,31 @@
#ifndef ENGRAVE_FILE_H
#define ENGRAVE_FILE_H
+/**
+ * @file engrave_file.h Engrave_File object functions.
+ * @brief Contains all of the functions related to the Engrave file object
+ */
+
+/**
+ * @defgroup Engrave_File Engrave_File: Functions to work with the Engrave file object
+ *
+ * @{
+ */
+
+/**
+ * The Engrave_File typedef.
+ */
typedef struct _Engrave_File Engrave_File;
+
+/**
+ * Structure to hold the file information.
+ */
struct _Engrave_File
{
- Evas_List *images;
- Evas_List *fonts;
- Evas_List *data;
- Evas_List *groups;
+ Evas_List *images; /**< The list of images in the file */
+ Evas_List *fonts; /**< The list of fonts in the file */
+ Evas_List *data; /**< The list of data items in the file */
+ Evas_List *groups; /**< The list of groups in the file */
};
Engrave_File *engrave_file_new(void);
@@ -21,5 +39,9 @@
Engrave_Image * engrave_file_image_by_name_find(Engrave_File *ef,
char *name);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_font.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_font.c 24 Oct 2004 06:28:37 -0000 1.2
+++ engrave_font.c 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,17 +1,6 @@
#include <Engrave.h>
/**
- * @file engrave_font.h Engrave_Font block
- * @brief Contains all of the functions to maniuplate Engrave_Font blocks
- */
-
-/**
- * @defgroup Engrave_Font Engrave_Font: Functions to work with engrave font objects
- *
- * @{
- */
-
-/**
* engrave_font_new - create a new Engrave_Font object.
* @param path: The path to the font
* @param name: The name for the font
@@ -31,7 +20,3 @@
return ef;
}
-/**
- * @}
- */
-
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_font.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- engrave_font.h 21 Oct 2004 06:56:38 -0000 1.1
+++ engrave_font.h 24 Oct 2004 07:06:37 -0000 1.2
@@ -1,15 +1,37 @@
#ifndef ENGRAVE_FONT_H
#define ENGRAVE_FONT_H
+/**
+ * @file engrave_font.h Engrave_Font block
+ * @brief Contains all of the functions to maniuplate Engrave_Font blocks
+ */
+
+/**
+ * @defgroup Engrave_Font Engrave_Font: Functions to work with engrave font objects
+ *
+ * @{
+ */
+
+/**
+ * The Engrave_Font typedef
+ */
typedef struct _Engrave_Font Engrave_Font;
+
+/**
+ * Stores the needed font information.
+ */
struct _Engrave_Font
{
- char *name; /* alias */
- char *file; /* basename */
- char *path; /* dir path */
+ char *name; /**< The font alias */
+ char *file; /**< The font name */
+ char *path; /**< The font path */
};
Engrave_Font * engrave_font_new(char *path, char *name);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_group.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- engrave_group.c 24 Oct 2004 06:28:37 -0000 1.3
+++ engrave_group.c 24 Oct 2004 07:06:37 -0000 1.4
@@ -1,17 +1,6 @@
#include <Engrave.h>
/**
- * @file engrave_group.h Engrave_Group functions
- * @brief Contains all of the functions to maniuplate Engrave_Group objects.
- */
-
-/**
- * @defgroup Engrave_Group Engrave_Group: Functions to work with an Engrave_Group.
- *
- * @{
- */
-
-/**
* engrave_group_new - create a new Engrave_Group object.
*
* @return Returns a pointer to a newly allocated Engrave_Group object on success or
@@ -148,8 +137,4 @@
return evas_list_data(evas_list_last(eg->programs));
}
-/**
- * @}
- */
-
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_group.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_group.h 22 Oct 2004 01:43:14 -0000 1.2
+++ engrave_group.h 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,20 +1,42 @@
#ifndef ENGRAVE_GROUP_H
#define ENGRAVE_GROUP_H
+/**
+ * @file engrave_group.h Engrave_Group functions
+ * @brief Contains all of the functions to maniuplate Engrave_Group objects.
+ */
+
+/**
+ * @defgroup Engrave_Group Engrave_Group: Functions to work with an Engrave_Group.
+ *
+ * @{
+ */
+
+/**
+ * The Engrave_Group typedef
+ */
typedef struct _Engrave_Group Engrave_Group;
+
+/**
+ * Stores the needed group information.
+ */
struct _Engrave_Group
{
- char *name;
+ char *name; /**< The group name */
+ /**
+ * The max/min size values for the group
+ */
struct
{
- int w, h;
+ int w; /**< The width */
+ int h; /**< The height */
} min, max;
- Evas_List *parts;
- Evas_List *programs;
- Evas_List *data;
+ Evas_List *parts; /**< The list of parts in this group */
+ Evas_List *programs; /**< The list of programs in this group */
+ Evas_List *data; /**< The list of data used in this group */
- char *script;
+ char *script; /**< The script attached to this group */
};
Engrave_Group *engrave_group_new(void);
@@ -28,5 +50,9 @@
Engrave_Part * engrave_group_part_last_get(Engrave_Group *eg);
Engrave_Program * engrave_group_program_last_get(Engrave_Group *eg);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_image.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_image.c 24 Oct 2004 06:28:37 -0000 1.2
+++ engrave_image.c 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,17 +1,6 @@
#include <Engrave.h>
/**
- * @file engrave_image.h Engrave_Image object functions.
- * @brief Contains all of the functions to manipulate Engrave_Image objects.
- */
-
-/**
- * @defgroup Engrave_Image Engrave_Image: Functions to work with Engrave_Image blocks.
- *
- * @{
- */
-
-/**
* engrave_image_new - create a new Engrave_Image object.
* @param name: The name of the given image
* @param type: The Engrave_Image_Type of the given image.
@@ -34,7 +23,3 @@
return image;
}
-/**
- * @}
- */
-
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_image.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- engrave_image.h 21 Oct 2004 06:56:38 -0000 1.1
+++ engrave_image.h 24 Oct 2004 07:06:37 -0000 1.2
@@ -1,17 +1,39 @@
#ifndef ENGRAVE_IMAGE_H
#define ENGRAVE_IMAGE_H
+/**
+ * @file engrave_image.h Engrave_Image object functions.
+ * @brief Contains all of the functions to manipulate Engrave_Image objects.
+ */
+
+/**
+ * @defgroup Engrave_Image Engrave_Image: Functions to work with Engrave_Image blocks.
+ *
+ * @{
+ */
+
+/**
+ * The Engrave_Image typedef
+ */
typedef struct _Engrave_Image Engrave_Image;
+
+/**
+ * Contains the needed image values
+ */
struct _Engrave_Image
{
- char *name; /* basename */
- char *path; /* dir path */
- Engrave_Image_Type type;
- double value;
+ char *name; /**< The image basename */
+ char *path; /**< The image dir path */
+ Engrave_Image_Type type; /**< The image storage type */
+ double value; /**< Compression value for image */
};
Engrave_Image * engrave_image_new(char *name,
Engrave_Image_Type type, double value);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_load.c,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- engrave_load.c 24 Oct 2004 06:28:37 -0000 1.6
+++ engrave_load.c 24 Oct 2004 07:06:37 -0000 1.7
@@ -3,18 +3,6 @@
#include "Engrave.h"
#include "engrave_parse.h"
-/**
- * @file engrave_load.h Engrave loading functions
- * @brief Contains the functions to load either an EDC or EET into Engrave.
- */
-
-/**
- * @defgroup Engrave_Load Engrave_Load: Contains the functions to load EDC
- * and EET files into Engrave.
- *
- * @{
- */
-
#define MAIN_EDC_NAME "main_edje_source.edc"
char *engrave_filename = NULL;
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_load.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- engrave_load.h 21 Oct 2004 06:56:38 -0000 1.1
+++ engrave_load.h 24 Oct 2004 07:06:37 -0000 1.2
@@ -1,8 +1,24 @@
#ifndef ENGRAVE_LOAD_H
#define ENGRAVE_LOAD_H
+/**
+ * @file engrave_load.h Engrave loading functions
+ * @brief Contains the functions to load either an EDC or EET into Engrave.
+ */
+
+/**
+ * @defgroup Engrave_Load Engrave_Load: Contains the functions to load EDC
+ * and EET files into Engrave.
+ *
+ * @{
+ */
+
Engrave_File *engrave_load_edc(char *file, char *imdir, char *fontdir);
Engrave_File *engrave_load_eet(char *filename);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_out.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- engrave_out.c 24 Oct 2004 06:28:37 -0000 1.7
+++ engrave_out.c 24 Oct 2004 07:06:37 -0000 1.8
@@ -3,18 +3,6 @@
#include <stdarg.h>
#include "Engrave.h"
-/**
- * @file engrave_out.h Functions to faciliate outputing the Engrave information.
- * @brief Provided the needed functions to output the Engrave information into
various formats.
- */
-
-/**
- * @defgroup Engrave_Out Functions needed to output the Engrave data into
- * different file formats.
- *
- * @{
- */
-
static void _engrave_output_group(Engrave_Group *group, FILE *out);
static void _engrave_output_part(Engrave_Part *part, FILE *out);
static void _engrave_output_program(Engrave_Program *program, FILE *out);
@@ -563,8 +551,4 @@
engrave_out_end(out);
}
-/**
- * @}
- */
-
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_out.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_out.h 24 Oct 2004 06:28:37 -0000 1.2
+++ engrave_out.h 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,8 +1,24 @@
#ifndef ENGRAVE_OUT_H
#define ENGRAVE_OUT_H
+/**
+ * @file engrave_out.h Functions to faciliate outputing the Engrave information.
+ * @brief Provided the needed functions to output the Engrave information into
various formats.
+ */
+
+/**
+ * @defgroup Engrave_Out Functions needed to output the Engrave data into
+ * different file formats.
+ *
+ * @{
+ */
+
int engrave_eet_output(Engrave_File *engrave_file, char *path);
int engrave_edc_output(Engrave_File *engrave_file, char *path);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_part.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- engrave_part.c 24 Oct 2004 06:28:37 -0000 1.3
+++ engrave_part.c 24 Oct 2004 07:06:37 -0000 1.4
@@ -1,17 +1,6 @@
#include <Engrave.h>
/**
- * @file engrave_part.h Engrave_Part object functions.
- * @brief Contains all functions to maniuplate the Engrave_Part object.
- */
-
-/**
- * @defgroup Engrave_Part Engrave_Part: Functions to work with part objects
- *
- * @{
- */
-
-/**
* engrave_part_new - create a new part object.
* @param type: The Engrave_Part_Type for the part.
*
@@ -194,7 +183,3 @@
ep->states = evas_list_append(ep->states, eps);
}
-/**
- * @}
- */
-
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_part.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_part.h 22 Oct 2004 01:43:14 -0000 1.2
+++ engrave_part.h 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,28 +1,55 @@
#ifndef ENGRAVE_PART_H
#define ENGRAVE_PART_H
+/**
+ * @file engrave_part.h Engrave_Part object functions.
+ * @brief Contains all functions to maniuplate the Engrave_Part object.
+ */
+
+/**
+ * @defgroup Engrave_Part Engrave_Part: Functions to work with part objects
+ *
+ * @{
+ */
+
+/**
+ * The Engrave_Part typedef
+ */
typedef struct _Engrave_Part Engrave_Part;
+
+/**
+ * All values needed to define a part
+ */
struct _Engrave_Part
{
- char *name;
- Engrave_Part_Type type;
- Engrave_Text_Effect effect;
- int mouse_events;
- int repeat_events;
- char *clip_to;
-
+ char *name; /**< The part name */
+ Engrave_Part_Type type; /**< The part type */
+ Engrave_Text_Effect effect; /**< The parts text effect */
+ int mouse_events; /**< The mouse events flag */
+ int repeat_events; /**< The repeat events flag */
+ char *clip_to; /**< The part to clip too */
+
+ /**
+ * The dragable settings for the part
+ */
struct
{
- signed char x, y; /* can drag in x/y, and which dir to count in */
+ signed char x; /**< Can drag in x direction */
+ signed char y; /**< Can drag in y direction */
+
+ /**
+ * The step and count values for the dragable
+ */
struct
{
- int x, y;
+ int x; /**< The x value */
+ int y; /**< The y value */
} step, count;
- char *confine;
+ char *confine; /**< The confine setting for the dragable */
} dragable;
- Evas_List *states;
+ Evas_List *states; /**< The list of states assocated with the part */
};
Engrave_Part * engrave_part_new(Engrave_Part_Type type);
@@ -40,5 +67,9 @@
void engrave_part_dragable_confine_set(Engrave_Part *ep, char *confine);
void engrave_part_state_add(Engrave_Part *ep, Engrave_Part_State *eps);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_program.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_program.c 24 Oct 2004 06:28:37 -0000 1.2
+++ engrave_program.c 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,17 +1,6 @@
#include <Engrave.h>
/**
- * @file engrave_program.h Engrave_Program object functions.
- * @brief Contains all of the functions to mainuplulate Engrave_Program objects.
- */
-
-/**
- * @defgroup Engrave_Program Engrave_Program: Functions to work with Engrave_Program
objects.
- *
- * @{
- */
-
-/**
* engrave_program_new - create a new Engrave_Program object.
*
* @return Returns a pointer to the newly allocated Engrave_Program object
@@ -172,8 +161,4 @@
ep->transition = trans;
ep->duration = duration;
}
-
-/**
- * @}
- */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/engrave/src/lib/engrave_program.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- engrave_program.h 22 Oct 2004 01:43:14 -0000 1.2
+++ engrave_program.h 24 Oct 2004 07:06:37 -0000 1.3
@@ -1,27 +1,51 @@
#ifndef ENGRAVE_PROGRAM_H
#define ENGRAVE_PROGRAM_H
+/**
+ * @file engrave_program.h Engrave_Program object functions.
+ * @brief Contains all of the functions to mainuplulate Engrave_Program objects.
+ */
+
+/**
+ * @defgroup Engrave_Program Engrave_Program: Functions to work with Engrave_Program
objects.
+ *
+ * @{
+ */
+
+/**
+ * The Engrave_Program typedef.
+ */
typedef struct _Engrave_Program Engrave_Program;
+
+/**
+ * Contains all the info to define a program
+ */
struct _Engrave_Program
{
- char *name;
- char *signal;
- char *source;
- Evas_List *targets;
- Evas_List *afters;
+ char *name; /**< The program name */
+ char *signal; /**< The signal to act on */
+ char *source; /**< The souce to act on */
+ Evas_List *targets; /**< The list of targets */
+ Evas_List *afters; /**< The list of afters */
+ /**
+ * Stores the in settings for the program
+ */
struct {
- double from, range;
+ double from; /**< The from in setting */
+ double range; /**< The range in setting */
} in;
- Engrave_Action action;
- char *state, *state2;
- double value, value2;
+ Engrave_Action action; /**< The action assocated with the program */
+ char *state; /**< The state setting for the action */
+ char *state2; /**< The state2 setting for the action */
+ double value; /**< The value setting for the action */
+ double value2; /**< The value2 setting for the action */
- Engrave_Transition transition;
- double duration;
+ Engrave_Transition transition; /**< The transition type of the program */
+ double duration; /**< The duration of the transition */
- char *script;
+ char *script; /**< The script associated with the program */
};
Engrave_Program *engrave_program_new(void);
@@ -38,5 +62,9 @@
void engrave_program_transition_set(Engrave_Program *ep,
Engrave_Transition trans, double duration);
+/**
+ * @}
+ */
+
#endif
-------------------------------------------------------
This SF.net email is sponsored by: IT Product Guide on ITManagersJournal
Use IT products in your business? Tell us what you think of them. Give us
Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more
http://productguide.itmanagersjournal.com/guidepromo.tmpl
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
