Re: [E-devel] Edje documentation patch

2010-02-26 Thread Gustavo Sverzut Barbieri
On Fri, Feb 26, 2010 at 1:07 AM, Eduardo Felipe
eduardofelip...@gmail.com wrote:
 On Thu, Feb 25, 2010 at 9:08 PM, Gustavo Sverzut Barbieri
 barbi...@profusion.mobi wrote:
 On Wed, Feb 24, 2010 at 2:28 AM, Eduardo Felipe
 eduardofelip...@gmail.com wrote:
 Hi folks!

 Since the adding of map capabilities to Edje, it's EDC Reference
 documentation has been broken due to the inclusion of tags out of
 proper order. That can be easily verified by going to
 http://docs.enlightenment.org/auto/edje/edcref.html and looking at the
 bottom part.

 So, I created this patch that contains no code change and just changes
 the already existing documentation to be in order so Doxygen is nice
 and produce the desired output. I also fixed a couple of spelling
 errors, and some documentation error on an internal header (There's no
 need to confuse new devs)

 well this fails in no code change:


  static void
 -st_collections_group_parts_part_description_map_rotation_center(void)
 +st_collections_group_parts_part_description_map_on(void)
  {
    Edje_Part_Collection *pc;
    Edje_Part *ep;
 @@ -5805,37 +5801,24 @@

    ed = ep-default_desc;
    if (ep-other_desc) ed = 
 eina_list_data_get(eina_list_last(ep-other_desc));
 -     {
 -       char *name;
 -
 -       name = parse_str(0);
 -       data_queue_part_lookup(pc, name, (ed-map.rot.id_center));
 -       free(name);
 -     }
 +   ed-map.on = parse_bool(0);
  }

 Unfortunately diffs do not track part moves. I changed a few functions
 around so that the documentation could be built in the correct order.
 The type of table based docs that EDC uses cares about order, so
 that's why I changed it. If you apply the patch and view under a diff
 tool you'll notice the move.

 Should I not change the order of the functions, then the documentation
 will be broken again as tags will appear under the wrong descriptor.

 What do you suggest?

2 patches, one adding/fixing the docs, another one moving.

-- 
Gustavo Sverzut Barbieri
http://profusion.mobi embedded systems
--
MSN: barbi...@gmail.com
Skype: gsbarbieri
Mobile: +55 (19) 9225-2202

--
Download Intel#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
___
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel


Re: [E-devel] Edje documentation patch

2010-02-26 Thread Eduardo Felipe
On Thu, Feb 25, 2010 at 9:08 PM, Gustavo Sverzut Barbieri
barbi...@profusion.mobi wrote:
 On Wed, Feb 24, 2010 at 2:28 AM, Eduardo Felipe
 eduardofelip...@gmail.com wrote:
 Hi folks!

 Since the adding of map capabilities to Edje, it's EDC Reference
 documentation has been broken due to the inclusion of tags out of
 proper order. That can be easily verified by going to
 http://docs.enlightenment.org/auto/edje/edcref.html and looking at the
 bottom part.

 So, I created this patch that contains no code change and just changes
 the already existing documentation to be in order so Doxygen is nice
 and produce the desired output. I also fixed a couple of spelling
 errors, and some documentation error on an internal header (There's no
 need to confuse new devs)

 well this fails in no code change:


  static void
 -st_collections_group_parts_part_description_map_rotation_center(void)
 +st_collections_group_parts_part_description_map_on(void)
  {
    Edje_Part_Collection *pc;
    Edje_Part *ep;
 @@ -5805,37 +5801,24 @@

    ed = ep-default_desc;
    if (ep-other_desc) ed = 
 eina_list_data_get(eina_list_last(ep-other_desc));
 -     {
 -       char *name;
 -
 -       name = parse_str(0);
 -       data_queue_part_lookup(pc, name, (ed-map.rot.id_center));
 -       free(name);
 -     }
 +   ed-map.on = parse_bool(0);
  }

Unfortunately diffs do not track part moves. I changed a few functions
around so that the documentation could be built in the correct order.
The type of table based docs that EDC uses cares about order, so
that's why I changed it. If you apply the patch and view under a diff
tool you'll notice the move.

Should I not change the order of the functions, then the documentation
will be broken again as tags will appear under the wrong descriptor.

What do you suggest?


[]s

Eduardo Felipe.

 Please do a new patch with just documentation. The current version is
 quite confusing with things like that :-(



 --
 Gustavo Sverzut Barbieri
 http://profusion.mobi embedded systems
 --
 MSN: barbi...@gmail.com
 Skype: gsbarbieri
 Mobile: +55 (19) 9225-2202


--
Download Intel#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
___
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel


Re: [E-devel] Edje documentation patch

2010-02-26 Thread Eduardo Felipe
Ok. Edje has moved forward, and so did this patch.
Now it's in sync with SVN again.

Thanks!

Eduardo.

On Wed, Feb 24, 2010 at 2:28 AM, Eduardo Felipe
eduardofelip...@gmail.com wrote:
 Hi folks!

 Since the adding of map capabilities to Edje, it's EDC Reference
 documentation has been broken due to the inclusion of tags out of
 proper order. That can be easily verified by going to
 http://docs.enlightenment.org/auto/edje/edcref.html and looking at the
 bottom part.

 So, I created this patch that contains no code change and just changes
 the already existing documentation to be in order so Doxygen is nice
 and produce the desired output. I also fixed a couple of spelling
 errors, and some documentation error on an internal header (There's no
 need to confuse new devs)

 If anything is wrong, please feel free to change. It was created with r46394.

 Cheers,

 Eduardo Felipe.

--
Download Intel#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev___
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel


Re: [E-devel] Edje documentation patch

2010-02-26 Thread Gustavo Sverzut Barbieri
On Fri, Feb 26, 2010 at 4:26 PM, Eduardo Felipe
eduardofelip...@gmail.com wrote:
 There you go. The doc_move_patch.txt must be applied over the doc_patch.txt.

all in svn! thanks!


-- 
Gustavo Sverzut Barbieri
http://profusion.mobi embedded systems
--
MSN: barbi...@gmail.com
Skype: gsbarbieri
Mobile: +55 (19) 9225-2202

--
Download Intel#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
___
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel


Re: [E-devel] Edje documentation patch

2010-02-25 Thread Gustavo Sverzut Barbieri
On Wed, Feb 24, 2010 at 2:28 AM, Eduardo Felipe
eduardofelip...@gmail.com wrote:
 Hi folks!

 Since the adding of map capabilities to Edje, it's EDC Reference
 documentation has been broken due to the inclusion of tags out of
 proper order. That can be easily verified by going to
 http://docs.enlightenment.org/auto/edje/edcref.html and looking at the
 bottom part.

 So, I created this patch that contains no code change and just changes
 the already existing documentation to be in order so Doxygen is nice
 and produce the desired output. I also fixed a couple of spelling
 errors, and some documentation error on an internal header (There's no
 need to confuse new devs)

well this fails in no code change:


 static void
-st_collections_group_parts_part_description_map_rotation_center(void)
+st_collections_group_parts_part_description_map_on(void)
 {
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -5805,37 +5801,24 @@

ed = ep-default_desc;
if (ep-other_desc) ed = eina_list_data_get(eina_list_last(ep-other_desc));
- {
-   char *name;
-
-   name = parse_str(0);
-   data_queue_part_lookup(pc, name, (ed-map.rot.id_center));
-   free(name);
- }
+   ed-map.on = parse_bool(0);
 }


Please do a new patch with just documentation. The current version is
quite confusing with things like that :-(



-- 
Gustavo Sverzut Barbieri
http://profusion.mobi embedded systems
--
MSN: barbi...@gmail.com
Skype: gsbarbieri
Mobile: +55 (19) 9225-2202

--
Download Intel#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
___
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel


[E-devel] Edje documentation patch

2010-02-24 Thread Eduardo Felipe
Hi folks!

Since the adding of map capabilities to Edje, it's EDC Reference
documentation has been broken due to the inclusion of tags out of
proper order. That can be easily verified by going to
http://docs.enlightenment.org/auto/edje/edcref.html and looking at the
bottom part.

So, I created this patch that contains no code change and just changes
the already existing documentation to be in order so Doxygen is nice
and produce the desired output. I also fixed a couple of spelling
errors, and some documentation error on an internal header (There's no
need to confuse new devs)

If anything is wrong, please feel free to change. It was created with r46394.

Cheers,

Eduardo Felipe.
Index: src/lib/edje_private.h
===
--- src/lib/edje_private.h  (revision 46421)
+++ src/lib/edje_private.h  (working copy)
@@ -417,8 +417,8 @@
const char *source; /* if part that emitted this (name) matches this glob */
 
struct {
-  const char *part;
-  const char *state; /* if state is not set, we will try with source */
+  const char *part; /* if part is not set, we will try with event source 
as part name */
+  const char *state; /* if state is not set the filter is ignored */
} filter; /* the part filter.part should be in state filter.state for 
signal to be accepted */
 
struct {
Index: src/bin/edje_cc_handlers.c
===
--- src/bin/edje_cc_handlers.c  (revision 46421)
+++ src/bin/edje_cc_handlers.c  (working copy)
@@ -704,6 +704,8 @@
 external
 @parameters
 [external filename]
+@effect
+Used to add a file to the externals list.
 @endproperty
  */
 static void
@@ -1962,7 +1964,6 @@
 signals emitted, even outside the object, until the button is
 released.
 @li NOGRAB, the effect will be limited to the part's container.
-container.
 @endproperty
 */
 static void
@@ -2275,12 +2276,13 @@
 @property
 entry_mode
 @parameters
+[MODE]
+@effect
 Sets the edit mode for a textblock part to one of:
 @li NONE
 @li PLAIN
 @li EDITABLE
 @li PASSWORD
-@effect
 It causes the part be editable if the edje object has the keyboard
 focus AND the part has the edje focus (or selectable always
 regardless of focus) and in the event of password mode, not
@@ -2311,10 +2313,11 @@
 @property
 select_mode
 @parameters
+[MODE]
+@effect
 Sets the selection mode for a textblock part to one of:
 @li DEFAULT
 @li EXPLICIT
-@effect
 DEFAULT selection mode is what you would expect on any desktop. Press
 mouse, drag and release to end. EXPLICIT mode requires the application
 controlling the edje object has to explicitly begin and end selection
@@ -2342,7 +2345,7 @@
 @property
 multiline
 @parameters
-0 or 1 (boolean) off/on
+[1 or 0]
 @effect
 It causes a textblock that is editable to allow multiple lines for
 editing.
@@ -2394,7 +2397,7 @@
 used to enable (1 or -1) and disable (0) dragging along the axis. When
 enabled, 1 will set the starting point at 0.0 and -1 at 1.0. The second
 parameter takes any integer and will limit movement to values
-divisibles by it, causing the part to jump from position to position.
+divisible by it, causing the part to jump from position to position.
 The third parameter, (question from the author: What is count for?).
 @endproperty
 */
@@ -4165,8 +4168,8 @@
 @parameters
 0, NONE, DYNAMIC, STATIC
 @effect
-  Sets the evas image scale hint letting the engine more efectively save
-  cached copies of the scaled image if it maks sense
+Sets the evas image scale hint letting the engine more effectively save
+cached copies of the scaled image if it makes sense
 @endproperty
 */
 static void
@@ -4304,7 +4307,7 @@
 [angle]
 @effect
 The angle of rotation of a GRADIENT part. It is invalid in any other
-part type. The angle is espressed as an int, in the range 0 - 360.
+part type. The angle is expressed as an int, in the range 0 - 360.
 @endproperty
 */
 static void
@@ -5672,16 +5675,32 @@
 
 /**
 @page edcref
-@property
-perspective
+@block
+map
 @context
-description {
-..
-map {
-perspective: name;
+description {
+..
+map {
+perspective: name;
+light: name;
+on: 1;
+smooth: 1;
+perspective_on: 1;
+backface_cull: 1;
+alpha: 1;
+
+rotation {
+..
 }
-..
 }
+..
+}
+