Enlightenment CVS committal Author : raster Project : e17 Module : libs/edje
Dir : e17/libs/edje/src/lib Modified Files: edje_container.c edje_container.h edje_private.h edje_program.c edje_smart.c edje_util.c Log Message: fix typos in edje docs patch from martin :) =================================================================== RCS file: /cvsroot/enlightenment/e17/libs/edje/src/lib/edje_container.c,v retrieving revision 1.8 retrieving revision 1.9 diff -u -3 -r1.8 -r1.9 --- edje_container.c 25 Aug 2004 00:53:44 -0000 1.8 +++ edje_container.c 21 Sep 2005 03:11:31 -0000 1.9 @@ -257,7 +257,7 @@ return ei->object; } -/* optionally you can manage each column's object yourself OR let edje do it */ +/* optionally you can manage each column's object yourself OR let Edje do it */ void edje_item_object_column_set(Edje_Item *ei, int col, Evas_Object *obj) { =================================================================== RCS file: /cvsroot/enlightenment/e17/libs/edje/src/lib/edje_container.h,v retrieving revision 1.2 retrieving revision 1.3 diff -u -3 -r1.2 -r1.3 --- edje_container.h 24 Aug 2004 01:48:19 -0000 1.2 +++ edje_container.h 21 Sep 2005 03:11:31 -0000 1.3 @@ -144,18 +144,18 @@ * +-----------------------------+ +-------+ +----------------+ * * spacer object: - * 1 edje object goes inbetween each row as a spacer object (opt) - * 1 edje object goes inbetween each column as a spacer object (opt) + * 1 Edje object goes in-between each row as a spacer object (opt) + * 1 Edje object goes in-between each column as a spacer object (opt) * * surround object: - * 1 edje object goes around each item - item swallowed into "item" part (opt) + * 1 Edje object goes around each item - item swallowed into "item" part (opt) * if no "item" part then just underlay it * on select send "select" "" signal * on unselect send "unselect" "" signal * on focus send "focus" "" signal * on unfocus send "unfocus" signal * - * if any list item/cell is an edje object emit this to them too. + * if any list item/cell is an Edje object emit this to them too. * * also call callbacks. * if a surround object emits such a signal itself then call callbacks too =================================================================== RCS file: /cvsroot/enlightenment/e17/libs/edje/src/lib/edje_private.h,v retrieving revision 1.91 retrieving revision 1.92 diff -u -3 -r1.91 -r1.92 --- edje_private.h 19 Sep 2005 06:51:49 -0000 1.91 +++ edje_private.h 21 Sep 2005 03:11:31 -0000 1.92 @@ -50,19 +50,19 @@ /* FIXME: * - * more example edje files + * More example Edje files * * ? programs can do multiple actions from one signal * ? add containering (hbox, vbox, table, wrapping multi-line hbox & vbox) * ? text entry widget (single line only) * ? reduce linked list walking and list_nth calls * - * ? recursions, unsafe callbacks outside edje etc. with freeze, ref/unref and block/unblock and break_programs needs to be redesigned & fixed + * ? recursions, unsafe callbacks outside Edje etc. with freeze, ref/unref and block/unblock and break_programs needs to be redesigned & fixed * ? all unsafe calls that may result in callbacks must be marked and dealt with */ -/* Cache result of program glob matches - this uses up extra ram withthe gain +/* Cache result of program glob matches - this uses up extra ram with the gain * of faster program matching if a part has LOTS of programs. #define EDJE_PROGRAM_CACHE */ @@ -355,7 +355,7 @@ } align; struct { - unsigned char w, h; /* width or height si fixed in side (cannot expand with edje object size) */ + unsigned char w, h; /* width or height is fixed in side (cannot expand with Edje object size) */ } fixed; struct { @@ -411,7 +411,7 @@ struct { char *text; /* if "" or NULL, then leave text unchanged */ char *text_class; /* how to apply/modify the font */ - char *style; /* the text style if a tectblock */ + char *style; /* the text style if a textblock */ char *font; /* if a specific font is asked for */ int size; /* 0 = use user set size */ @@ -475,9 +475,9 @@ unsigned short block_break : 1; unsigned short delete_me : 1; double paused_at; - Evas *evas; /* the evas this edje belongs to */ + Evas *evas; /* the Evas this Edje belongs to */ Evas_Object *obj; /* the smart object */ - Evas_Object *clipper; /* a big rect to clip this edje to */ + Evas_Object *clipper; /* a big rect to clip this Edje to */ Edje_File *file; /* the file the data comes form */ Edje_Part_Collection *collection; /* the description being used */ Evas_List *parts; /* private list of parts */ @@ -490,7 +490,7 @@ int block; int load_error; int freeze; - /* variable pool for edje embryo scripts */ + /* variable pool for Edje Embryo scripts */ Edje_Var_Pool *var_pool; /* for faster lookups to avoid nth list walks */ int table_parts_size; =================================================================== RCS file: /cvsroot/enlightenment/e17/libs/edje/src/lib/edje_program.c,v retrieving revision 1.42 retrieving revision 1.43 diff -u -3 -r1.42 -r1.43 --- edje_program.c 21 Nov 2004 03:52:28 -0000 1.42 +++ edje_program.c 21 Sep 2005 03:11:31 -0000 1.43 @@ -121,7 +121,8 @@ * @param emission The signal * @param source The signal source * - * This sends a signal to the edje. These are defined in the programs section of an edc. + * This sends a signal to the edje. These are defined in the programs + * section of an edc. */ void edje_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) @@ -137,10 +138,11 @@ /* FIXDOC: Verify/Expand */ /** Set the Edje to play or pause - * @param obj A vaild Evas_Object handle + * @param obj A valid Evas_Object handle * @param play Play instruction (1 to play, 0 to pause) * - * This sets the Edje to play or pause depending on the parameter. This has no effect if the Edje is already in that state. + * This sets the Edje to play or pause depending on the parameter. + * This has no effect if the Edje is already in that state. */ void edje_object_play_set(Evas_Object *obj, int play) =================================================================== RCS file: /cvsroot/enlightenment/e17/libs/edje/src/lib/edje_smart.c,v retrieving revision 1.19 retrieving revision 1.20 diff -u -3 -r1.19 -r1.20 --- edje_smart.c 26 Aug 2005 06:53:37 -0000 1.19 +++ edje_smart.c 21 Sep 2005 03:11:31 -0000 1.20 @@ -25,11 +25,11 @@ /************************** API Routines **************************/ /* FIXDOC: Verify/Expand */ -/** Contructs the edje object +/** Constructs the Edje object * @param evas A valid Evas handle * @return The Evas_Object pointer. * - * Creates the edje smart object, returning the Evas_Object handle. + * Creates the Edje smart object, returning the Evas_Object handle. */ Evas_Object * edje_object_add(Evas *evas) =================================================================== RCS file: /cvsroot/enlightenment/e17/libs/edje/src/lib/edje_util.c,v retrieving revision 1.61 retrieving revision 1.62 diff -u -3 -r1.61 -r1.62 --- edje_util.c 20 Sep 2005 05:49:22 -0000 1.61 +++ edje_util.c 21 Sep 2005 03:11:31 -0000 1.62 @@ -29,7 +29,7 @@ } /* FIXDOC: Expand */ -/** Thaw all objects in Edje +/** Thaw all objects in Edje. */ void edje_thaw(void) @@ -89,7 +89,8 @@ * @return The frozen state\n * 0 on Error * - * This puts all changes on hold. Successive freezes will nest, requiring an equal number of thaws. + * This puts all changes on hold. Successive freezes will nest, + * requiring an equal number of thaws. */ int edje_object_freeze(Evas_Object *obj) @@ -220,7 +221,8 @@ * @param b3 Shadow Blue value * @param a3 Shadow Alpha value * - * Applys the color class to the object, where the first color is the object, the second is the outline, and the third is the shadow. + * Applies the color class to the object, where the first color is the + * object, the second is the outline, and the third is the shadow. */ void edje_object_color_class_set(Evas_Object *obj, const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3) @@ -360,7 +362,7 @@ } /** Sets Edje text class - * @param obj A vaild Evas_Object handle + * @param obj A valid Evas_Object handle * @param text_class The text class name * @param font Font name * @param size Font Size @@ -541,7 +543,9 @@ * @param part The part name * @param obj_swallow The object to swallow * - * Swallows the object into the edje part so that all geometry changes for the part affect the swallowed object. (e.g. resize, move, show, raise/lower, etc.) + * Swallows the object into the edje part so that all geometry changes + * for the part affect the swallowed object. (e.g. resize, move, show, + * raise/lower, etc.). */ void edje_object_part_swallow(Evas_Object *obj, const char *part, Evas_Object *obj_swallow) @@ -647,7 +651,7 @@ } /** Set the object maximum size - * @param obj A vaild Evas_Object handle + * @param obj A valid Evas_Object handle * @param maxw The maximum width * @param maxh The maximum height * @@ -731,7 +735,8 @@ * @param minw Minimum width pointer * @param minh Minimum height pointer * - * Gets the object's minimum size values from the Edje. These are set to zero if no Edje is connected to the Evas Object. + * Gets the object's minimum size values from the Edje. These are set + * to zero if no Edje is connected to the Evas Object. */ void edje_object_size_min_get(Evas_Object *obj, Evas_Coord *minw, Evas_Coord *minh) @@ -754,7 +759,8 @@ * @param maxw Maximum width pointer * @param maxh Maximum height pointer * - * Gets the object's maximum size values from the Edje. These are set to zero if no Edje is connected to the Evas Object. + * Gets the object's maximum size values from the Edje. These are set + * to zero if no Edje is connected to the Evas Object. */ void edje_object_size_max_get(Evas_Object *obj, Evas_Coord *maxw, Evas_Coord *maxh) @@ -786,10 +792,11 @@ } } -/** Force a Size/Geometry Calc +/** Force a Size/Geometry calculation * @param obj A valid Evas_Object handle * - * Forces the object @p obj to recalc layout regardless of freeze/thaw + * Forces the object @p obj to recalculation layout regardless of + * freeze/thaw. */ void edje_object_calc_force(Evas_Object *obj) @@ -904,7 +911,7 @@ "part not marked as fixed size in one dimension. This needs\n" "to be fixed in the source .edc by adding:\n" " fixed: 1 1;\n" - "to the part that cannot expand in size if the edje object does.\n", + "to the part that cannot expand in size if the Edje object does.\n", ed->path, ed->part); if (pep) printf("The part suspected causing this problem is:\n" @@ -931,7 +938,7 @@ ed->calc_only = 0; } -/** Returns the state of the edje part +/** Returns the state of the Edje part * @param obj A valid Evas_Objectart handle * @param part The part name * @param val_ret @@ -1049,6 +1056,7 @@ _edje_dragable_pos_set(ed, rp, dx, dy); _edje_emit(ed, "drag,set", rp->part->name); } + /** Get the dragable object location * @param obj A valid Evas_Object handle * @param part The part name @@ -1093,7 +1101,7 @@ * @param dw The drag width * @param dh The drag height * - * Sets the size of the dragable object + * Sets the size of the dragable object. */ void edje_object_part_drag_size_set(Evas_Object *obj, const char *part, double dw, double dh) @@ -1290,7 +1298,8 @@ * @param dx The x step * @param dy The y step * - * Steps x,y where the step increment is the ammount set by edje_object_part_drag_step_set. + * Steps x,y where the step increment is the amount set by + * edje_object_part_drag_step_set. */ void edje_object_part_drag_step(Evas_Object *obj, const char *part, double dx, double dy) ------------------------------------------------------- SF.Net email is sponsored by: Tame your development challenges with Apache's Geronimo App Server. Download it for free - -and be entered to win a 42" plasma tv or your very own Sony(tm)PSP. Click here to play: http://sourceforge.net/geronimo.php _______________________________________________ enlightenment-cvs mailing list enlightenment-cvs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs