summaryrefslogtreecommitdiff
path: root/legacy/evas/src/lib/canvas
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2010-03-18 04:57:40 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2010-03-18 04:57:40 +0000
commitfd2659c57275248abca559d22c1a478586373e7f (patch)
tree912388ef90b62cf5182e45d0be469dd82d81b1e2 /legacy/evas/src/lib/canvas
parent57036495671e54704744387cc201636602dcfe8a (diff)
evas: mega documentation improving commit.
This commit moves Evas.h contents a lot, but it should not change code (some conts were added, some function attributes were changed). The purpose of such is to define the order that doxygen show modules in its documentation. I also splitted documentation a bit more, and added a src/examples to list useful example code. Right now it is just a pure-evas draw-and-save using buffer engine. NOTE: there is lots to document, and the @todo list is quite long but I guess lots of things there were done already. Raster, could you review this list? SVN revision: 47308
Diffstat (limited to 'legacy/evas/src/lib/canvas')
-rw-r--r--legacy/evas/src/lib/canvas/evas_async_events.c3
-rw-r--r--legacy/evas/src/lib/canvas/evas_callbacks.c165
-rw-r--r--legacy/evas/src/lib/canvas/evas_clip.c2
-rw-r--r--legacy/evas/src/lib/canvas/evas_data.c2
-rw-r--r--legacy/evas/src/lib/canvas/evas_events.c38
-rw-r--r--legacy/evas/src/lib/canvas/evas_focus.c10
-rw-r--r--legacy/evas/src/lib/canvas/evas_layer.c3
-rw-r--r--legacy/evas/src/lib/canvas/evas_main.c109
-rw-r--r--legacy/evas/src/lib/canvas/evas_map.c19
-rw-r--r--legacy/evas/src/lib/canvas/evas_name.c11
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_box.c1
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_gradient.c22
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_gradient2.c9
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_image.c94
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_intercept.c9
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_line.c6
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_main.c83
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_polygon.c7
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_rectangle.c6
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_smart.c14
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_smart_clipped.c2
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_text.c80
-rw-r--r--legacy/evas/src/lib/canvas/evas_object_textblock.c20
-rw-r--r--legacy/evas/src/lib/canvas/evas_render.c15
-rw-r--r--legacy/evas/src/lib/canvas/evas_smart.c7
-rw-r--r--legacy/evas/src/lib/canvas/evas_stack.c34
-rw-r--r--legacy/evas/src/lib/canvas/evas_stats.c38
-rw-r--r--legacy/evas/src/lib/canvas/evas_transform.c45
28 files changed, 499 insertions, 355 deletions
diff --git a/legacy/evas/src/lib/canvas/evas_async_events.c b/legacy/evas/src/lib/canvas/evas_async_events.c
index 45cbf3f..76a3787 100644
--- a/legacy/evas/src/lib/canvas/evas_async_events.c
+++ b/legacy/evas/src/lib/canvas/evas_async_events.c
@@ -81,6 +81,7 @@ evas_async_events_shutdown(void)
81 * asynchronous events of the canvas. Naturally, other mainloops, 81 * asynchronous events of the canvas. Naturally, other mainloops,
82 * apart from ecore, may make use of it. 82 * apart from ecore, may make use of it.
83 * 83 *
84 * @ingroup Evas_Group
84 */ 85 */
85EAPI int 86EAPI int
86evas_async_events_fd_get(void) 87evas_async_events_fd_get(void)
@@ -103,6 +104,7 @@ evas_async_events_fd_get(void)
103 * together with other event parameters, when queued, get called (with 104 * together with other event parameters, when queued, get called (with
104 * those parameters), in that order. 105 * those parameters), in that order.
105 * 106 *
107 * @ingroup Evas_Group
106 */ 108 */
107EAPI int 109EAPI int
108evas_async_events_process(void) 110evas_async_events_process(void)
@@ -156,6 +158,7 @@ evas_async_events_process(void)
156 * whose call is to happen after evas_async_events_process() is 158 * whose call is to happen after evas_async_events_process() is
157 * called. 159 * called.
158 * 160 *
161 * @ingroup Evas_Group
159 */ 162 */
160EAPI Eina_Bool 163EAPI Eina_Bool
161evas_async_events_put(const void *target, Evas_Callback_Type type, void *event_info, void (*func)(void *target, Evas_Callback_Type type, void *event_info)) 164evas_async_events_put(const void *target, Evas_Callback_Type type, void *event_info, void (*func)(void *target, Evas_Callback_Type type, void *event_info))
diff --git a/legacy/evas/src/lib/canvas/evas_callbacks.c b/legacy/evas/src/lib/canvas/evas_callbacks.c
index c61d73c..c67c67b 100644
--- a/legacy/evas/src/lib/canvas/evas_callbacks.c
+++ b/legacy/evas/src/lib/canvas/evas_callbacks.c
@@ -184,7 +184,7 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
184 184
185 185
186/** 186/**
187 * @addtogroup Evas_Object_Group 187 * @addtogroup Evas_Object_Group_Events
188 * @{ 188 * @{
189 */ 189 */
190 190
@@ -221,18 +221,18 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
221 * that triggered the callback. 221 * that triggered the callback.
222 * 222 *
223 * The event type @p type to trigger the function may be one of 223 * The event type @p type to trigger the function may be one of
224 * EVAS_CALLBACK_MOUSE_IN, EVAS_CALLBACK_MOUSE_OUT, 224 * #EVAS_CALLBACK_MOUSE_IN, #EVAS_CALLBACK_MOUSE_OUT,
225 * EVAS_CALLBACK_MOUSE_DOWN, EVAS_CALLBACK_MOUSE_UP, 225 * #EVAS_CALLBACK_MOUSE_DOWN, #EVAS_CALLBACK_MOUSE_UP,
226 * EVAS_CALLBACK_MOUSE_MOVE, EVAS_CALLBACK_MOUSE_WHEEL, 226 * #EVAS_CALLBACK_MOUSE_MOVE, #EVAS_CALLBACK_MOUSE_WHEEL,
227 * EVAS_CALLBACK_FREE, EVAS_CALLBACK_KEY_DOWN, EVAS_CALLBACK_KEY_UP, 227 * #EVAS_CALLBACK_FREE, #EVAS_CALLBACK_KEY_DOWN, #EVAS_CALLBACK_KEY_UP,
228 * EVAS_CALLBACK_FOCUS_IN, EVAS_CALLBACK_FOCUS_OUT, 228 * #EVAS_CALLBACK_FOCUS_IN, #EVAS_CALLBACK_FOCUS_OUT,
229 * EVAS_CALLBACK_SHOW, EVAS_CALLBACK_HIDE, EVAS_CALLBACK_MOVE, 229 * #EVAS_CALLBACK_SHOW, #EVAS_CALLBACK_HIDE, #EVAS_CALLBACK_MOVE,
230 * EVAS_CALLBACK_RESIZE or EVAS_CALLBACK_RESTACK. 230 * #EVAS_CALLBACK_RESIZE or #EVAS_CALLBACK_RESTACK.
231 * This determines the kind of event that will trigger the callback to 231 * This determines the kind of event that will trigger the callback to
232 * be called. The @p event_info pointer passed to the callback will 232 * be called. The @p event_info pointer passed to the callback will
233 * be one of the following, depending on the event triggering it: 233 * be one of the following, depending on the event triggering it:
234 * 234 *
235 * EVAS_CALLBACK_MOUSE_IN: event_info = pointer to Evas_Event_Mouse_In 235 * #EVAS_CALLBACK_MOUSE_IN: event_info = pointer to Evas_Event_Mouse_In
236 * 236 *
237 * This event is triggered when the mouse pointer enters the region of 237 * This event is triggered when the mouse pointer enters the region of
238 * the object @p obj. This may occur by the mouse pointer being moved 238 * the object @p obj. This may occur by the mouse pointer being moved
@@ -241,9 +241,9 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
241 * shown, raised, moved, resized, or other objects being moved out of 241 * shown, raised, moved, resized, or other objects being moved out of
242 * the way, hidden, lowered or moved out of the way. 242 * the way, hidden, lowered or moved out of the way.
243 * 243 *
244 * EVAS_CALLBACK_MOUSE_OUT: event_info = pointer to Evas_Event_Mouse_Out 244 * #EVAS_CALLBACK_MOUSE_OUT: event_info = pointer to Evas_Event_Mouse_Out
245 * 245 *
246 * This event is triggered exactly like EVAS_CALLBACK_MOUSE_IN is, but 246 * This event is triggered exactly like #EVAS_CALLBACK_MOUSE_IN is, but
247 * occurs when the mouse pointer exits an object. Note that no out 247 * occurs when the mouse pointer exits an object. Note that no out
248 * events will be reported if the mouse pointer is implicitly grabbed 248 * events will be reported if the mouse pointer is implicitly grabbed
249 * to an object (the mouse buttons are down at all and any were 249 * to an object (the mouse buttons are down at all and any were
@@ -252,7 +252,7 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
252 * depressed). Out events will be reported once all buttons are 252 * depressed). Out events will be reported once all buttons are
253 * released, if the mouse has left the object. 253 * released, if the mouse has left the object.
254 * 254 *
255 * EVAS_CALLBACK_MOUSE_DOWN: event_info = pointer to 255 * #EVAS_CALLBACK_MOUSE_DOWN: event_info = pointer to
256 * Evas_Event_Mouse_Down 256 * Evas_Event_Mouse_Down
257 * 257 *
258 * This event is triggered by a mouse button being depressed while 258 * This event is triggered by a mouse button being depressed while
@@ -265,25 +265,25 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
265 * presses. When all buttons are released, event propagation occurs as 265 * presses. When all buttons are released, event propagation occurs as
266 * normal. 266 * normal.
267 * 267 *
268 * EVAS_CALLBACK_MOUSE_UP: event_info = pointer to Evas_Event_Mouse_Up 268 * #EVAS_CALLBACK_MOUSE_UP: event_info = pointer to Evas_Event_Mouse_Up
269 * 269 *
270 * This event is triggered by a mouse button being released while over 270 * This event is triggered by a mouse button being released while over
271 * an object or when passively grabbed to an object. If this is the 271 * an object or when passively grabbed to an object. If this is the
272 * last mouse button to be raised on an object then the passive grab 272 * last mouse button to be raised on an object then the passive grab
273 * is released and event processing will continue as normal. 273 * is released and event processing will continue as normal.
274 * 274 *
275 * EVAS_CALLBACK_MOUSE_MOVE: event_info = pointer to Evas_Event_Mouse_Move 275 * #EVAS_CALLBACK_MOUSE_MOVE: event_info = pointer to Evas_Event_Mouse_Move
276 * 276 *
277 * This event is triggered by the mouse pointer moving while over an 277 * This event is triggered by the mouse pointer moving while over an
278 * object or passively grabbed to an object. 278 * object or passively grabbed to an object.
279 * 279 *
280 * EVAS_CALLBACK_MOUSE_WHEEL: event_info = pointer to 280 * #EVAS_CALLBACK_MOUSE_WHEEL: event_info = pointer to
281 * Evas_Event_Mouse_Wheel 281 * Evas_Event_Mouse_Wheel
282 * 282 *
283 * This event is triggered by the mouse wheel being rolled while over 283 * This event is triggered by the mouse wheel being rolled while over
284 * an object or passively grabbed to an object. 284 * an object or passively grabbed to an object.
285 * 285 *
286 * EVAS_CALLBACK_FREE: event_info = NULL 286 * #EVAS_CALLBACK_FREE: event_info = NULL
287 * 287 *
288 * This event is triggered just before Evas is about to free all 288 * This event is triggered just before Evas is about to free all
289 * memory used by an object and remove all references to it. This is 289 * memory used by an object and remove all references to it. This is
@@ -292,48 +292,48 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
292 * valid when this callback is called, but after this callback 292 * valid when this callback is called, but after this callback
293 * returns, there is no guarantee on the object's validity. 293 * returns, there is no guarantee on the object's validity.
294 * 294 *
295 * EVAS_CALLBACK_KEY_DOWN: event_info = pointer to Evas_Event_Key_Down 295 * #EVAS_CALLBACK_KEY_DOWN: event_info = pointer to Evas_Event_Key_Down
296 * 296 *
297 * This callback is called when a key is pressed and the focus is on 297 * This callback is called when a key is pressed and the focus is on
298 * the object, or a key has been grabbed to a particular object which 298 * the object, or a key has been grabbed to a particular object which
299 * wants to intercept the key press regardless of what object has the 299 * wants to intercept the key press regardless of what object has the
300 * focus. 300 * focus.
301 * 301 *
302 * EVAS_CALLBACK_KEY_UP: event_info = pointer to Evas_Event_Key_Up 302 * #EVAS_CALLBACK_KEY_UP: event_info = pointer to Evas_Event_Key_Up
303 * 303 *
304 * This callback is called when a key is released and the focus is on 304 * This callback is called when a key is released and the focus is on
305 * the object, or a key has been grabbed to a particular object which 305 * the object, or a key has been grabbed to a particular object which
306 * wants to intercept the key release regardless of what object has 306 * wants to intercept the key release regardless of what object has
307 * the focus. 307 * the focus.
308 * 308 *
309 * EVAS_CALLBACK_FOCUS_IN: event_info = NULL 309 * #EVAS_CALLBACK_FOCUS_IN: event_info = NULL
310 * 310 *
311 * This event is called when an object gains the focus. When the 311 * This event is called when an object gains the focus. When the
312 * callback is called the object has already gained the focus. 312 * callback is called the object has already gained the focus.
313 * 313 *
314 * EVAS_CALLBACK_FOCUS_OUT: event_info = NULL 314 * #EVAS_CALLBACK_FOCUS_OUT: event_info = NULL
315 * 315 *
316 * This event is triggered by an object losing the focus. When the 316 * This event is triggered by an object losing the focus. When the
317 * callback is called the object has already lost the focus. 317 * callback is called the object has already lost the focus.
318 * 318 *
319 * EVAS_CALLBACK_SHOW: event_info = NULL 319 * #EVAS_CALLBACK_SHOW: event_info = NULL
320 * 320 *
321 * This event is triggered by the object being shown by 321 * This event is triggered by the object being shown by
322 * evas_object_show(). 322 * evas_object_show().
323 * 323 *
324 * EVAS_CALLBACK_HIDE: event_info = NULL 324 * #EVAS_CALLBACK_HIDE: event_info = NULL
325 * 325 *
326 * This event is triggered by an object being hidden by 326 * This event is triggered by an object being hidden by
327 * evas_object_hide(). 327 * evas_object_hide().
328 * 328 *
329 * EVAS_CALLBACK_MOVE: event_info = NULL 329 * #EVAS_CALLBACK_MOVE: event_info = NULL
330 * 330 *
331 * This event is triggered by an object being 331 * This event is triggered by an object being
332 * moved. evas_object_move() can trigger this, as can any 332 * moved. evas_object_move() can trigger this, as can any
333 * object-specific manipulations that would mean the object's origin 333 * object-specific manipulations that would mean the object's origin
334 * could move. 334 * could move.
335 * 335 *
336 * EVAS_CALLBACK_RESIZE: event_info = NULL 336 * #EVAS_CALLBACK_RESIZE: event_info = NULL
337 * 337 *
338 * This event is triggered by an object being resized. Resizes can be 338 * This event is triggered by an object being resized. Resizes can be
339 * triggered by evas_object_resize() or by any object-specific calls 339 * triggered by evas_object_resize() or by any object-specific calls
@@ -501,6 +501,73 @@ evas_object_event_callback_del_full(Evas_Object *obj, Evas_Callback_Type type, E
501 return NULL; 501 return NULL;
502} 502}
503 503
504/**
505 * @}
506 */
507
508/**
509 * @addtogroup Evas_Canvas_Events
510 * @{
511 */
512
513/**
514 * Add a callback function to the canvas.
515 *
516 * @param e Canvas to attach a callback to
517 * @param type The type of event that will trigger the callback
518 * @param func The function to be called when the event is triggered
519 * @param data The data pointer to be passed to @p func
520 *
521 * This function adds a function callback to the canvas when the event
522 * of type @p type occurs on canvas @p e. The function is @p func.
523 *
524 * In the event of a memory allocation error during addition of the
525 * callback to the canvas, evas_alloc_error() should be used to
526 * determine the nature of the error, if any, and the program should
527 * sensibly try and recover.
528 *
529 * The function will be passed the pointer @p data when it is
530 * called. A callback function must look like this:
531 *
532 * @code
533 * void callback (void *data, Evas *e, void *event_info);
534 * @endcode
535 *
536 * The first parameter @p data in this function will be the same value
537 * passed to evas_event_callback_add() as the @p data parameter. The
538 * second parameter @p e is the canvas handle on which the event
539 * occured. The third parameter @p event_info is a pointer to a data
540 * structure that may or may not be passed to the callback, depending
541 * on the event type that triggered the callback.
542 *
543 * The event type @p type to trigger the function may be one of
544 * #EVAS_CALLBACK_RENDER_FLUSH_PRE, #EVAS_CALLBACK_RENDER_FLUSH_POST,
545 * #EVAS_CALLBACK_CANVAS_FOCUS_IN, #EVAS_CALLBACK_CANVAS_FOCUS_OUT.
546 * This determines the kind of event that will trigger the callback to
547 * be called. So far none of the event types provide useful data, so
548 * in all of them @p event_info pointer is @c NULL.
549 *
550 * Example:
551 * @code
552 * extern Evas *e;
553 * extern void *my_data;
554 * void focus_in_callback(void *data, Evas *e, void *event_info);
555 * void focus_out_callback(void *data, Evas *e, void *event_info);
556 *
557 * evas_event_callback_add(e, EVAS_CALLBACK_CANVAS_FOCUS_IN, focus_in_callback, my_data);
558 * if (evas_alloc_error() != EVAS_ALLOC_ERROR_NONE)
559 * {
560 * fprintf(stderr, "ERROR: Callback registering failed! Abort!\n");
561 * exit(-1);
562 * }
563 * evas_event_callback_add(e, EVAS_CALLBACK_CANVAS_FOCUS_OUT, focus_out_callback, my_data);
564 * if (evas_alloc_error() != EVAS_ALLOC_ERROR_NONE)
565 * {
566 * fprintf(stderr, "ERROR: Callback registering failed! Abort!\n");
567 * exit(-1);
568 * }
569 * @endcode
570 */
504EAPI void 571EAPI void
505evas_event_callback_add(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data) 572evas_event_callback_add(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data)
506{ 573{
@@ -530,6 +597,30 @@ evas_event_callback_add(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, co
530 eina_inlist_prepend(e->callbacks->callbacks, EINA_INLIST_GET(fn)); 597 eina_inlist_prepend(e->callbacks->callbacks, EINA_INLIST_GET(fn));
531} 598}
532 599
600/**
601 * Delete a callback function from the canvas.
602 *
603 * @param e Canvas to remove a callback from
604 * @param type The type of event that was triggering the callback
605 * @param func The function that was to be called when the event was triggered
606 * @return The data pointer that was to be passed to the callback
607 *
608 * This function removes the most recently added callback from the
609 * canvas @p e which was triggered by the event type @p type and was
610 * calling the function @p func when triggered. If the removal is
611 * successful it will also return the data pointer that was passed to
612 * evas_event_callback_add() when the callback was added to the
613 * canvas. If not successful NULL will be returned.
614 *
615 * Example:
616 * @code
617 * extern Evas *e;
618 * void *my_data;
619 * void focus_in_callback(void *data, Evas *e, void *event_info);
620 *
621 * my_data = evas_event_callback_del(ebject, EVAS_CALLBACK_CANVAS_FOCUS_IN, focus_in_callback);
622 * @endcode
623 */
533EAPI void * 624EAPI void *
534evas_event_callback_del(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func) 625evas_event_callback_del(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func)
535{ 626{
@@ -559,6 +650,32 @@ evas_event_callback_del(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func)
559 return NULL; 650 return NULL;
560} 651}
561 652
653/**
654 * Delete a callback function from the canvas.
655 *
656 * @param e Canvas to remove a callback from
657 * @param type The type of event that was triggering the callback
658 * @param func The function that was to be called when the event was triggered
659 * @param data The data pointer that was to be passed to the callback
660 * @return The data pointer that was to be passed to the callback
661 *
662 * This function removes the most recently added callback from the
663 * canvas @p e which was triggered by the event type @p type and was
664 * calling the function @p func with data @p data when triggered. If
665 * the removal is successful it will also return the data pointer that
666 * was passed to evas_event_callback_add() (that will be the same as
667 * the parameter) when the callback was added to the canvas. If not
668 * successful NULL will be returned.
669 *
670 * Example:
671 * @code
672 * extern Evas *e;
673 * void *my_data;
674 * void focus_in_callback(void *data, Evas *e, void *event_info);
675 *
676 * my_data = evas_event_callback_del_full(ebject, EVAS_CALLBACK_CANVAS_FOCUS_IN, focus_in_callback, my_data);
677 * @endcode
678 */
562EAPI void * 679EAPI void *
563evas_event_callback_del_full(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data) 680evas_event_callback_del_full(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data)
564{ 681{
diff --git a/legacy/evas/src/lib/canvas/evas_clip.c b/legacy/evas/src/lib/canvas/evas_clip.c
index fa2951a..1f9ce4d 100644
--- a/legacy/evas/src/lib/canvas/evas_clip.c
+++ b/legacy/evas/src/lib/canvas/evas_clip.c
@@ -41,7 +41,7 @@ evas_object_clippers_was_visible(Evas_Object *obj)
41/* public functions */ 41/* public functions */
42 42
43/** 43/**
44 * @addtogroup Evas_Object_Group 44 * @addtogroup Evas_Object_Group_Basic
45 * @{ 45 * @{
46 */ 46 */
47 47
diff --git a/legacy/evas/src/lib/canvas/evas_data.c b/legacy/evas/src/lib/canvas/evas_data.c
index e8b6d20..a3ddc7f 100644
--- a/legacy/evas/src/lib/canvas/evas_data.c
+++ b/legacy/evas/src/lib/canvas/evas_data.c
@@ -2,7 +2,7 @@
2#include "evas_private.h" 2#include "evas_private.h"
3 3
4/** 4/**
5 * @addtogroup Evas_Object_Group 5 * @addtogroup Evas_Object_Group_Extras
6 * @{ 6 * @{
7 */ 7 */
8 8
diff --git a/legacy/evas/src/lib/canvas/evas_events.c b/legacy/evas/src/lib/canvas/evas_events.c
index 5b03acd..21648e1 100644
--- a/legacy/evas/src/lib/canvas/evas_events.c
+++ b/legacy/evas/src/lib/canvas/evas_events.c
@@ -158,10 +158,8 @@ evas_event_list_copy(Eina_List *list)
158/* public functions */ 158/* public functions */
159 159
160/** 160/**
161 * @defgroup Evas_Event_Freezing_Group Evas Event Freezing Functions 161 * @addtogroup Evas_Event_Freezing_Group
162 * 162 * @{
163 * Functions that deal with the freezing of event processing of an
164 * evas.
165 */ 163 */
166 164
167/** 165/**
@@ -183,7 +181,6 @@ evas_event_list_copy(Eina_List *list)
183 * evas_object_resize(object, 200, 200); 181 * evas_object_resize(object, 200, 200);
184 * evas_event_thaw(evas); 182 * evas_event_thaw(evas);
185 * @endcode 183 * @endcode
186 * @ingroup Evas_Event_Freezing_Group
187 */ 184 */
188EAPI void 185EAPI void
189evas_event_freeze(Evas *e) 186evas_event_freeze(Evas *e)
@@ -205,7 +202,6 @@ evas_event_freeze(Evas *e)
205 * invole any "missed" events to be evaluated. 202 * invole any "missed" events to be evaluated.
206 * 203 *
207 * See evas_event_freeze() for an example. 204 * See evas_event_freeze() for an example.
208 * @ingroup Evas_Event_Freezing_Group
209 */ 205 */
210EAPI void 206EAPI void
211evas_event_thaw(Evas *e) 207evas_event_thaw(Evas *e)
@@ -234,6 +230,15 @@ evas_event_thaw(Evas *e)
234} 230}
235 231
236/** 232/**
233 * @}
234 */
235
236/**
237 * @addtogroup Evas_Event_Feeding_Group
238 * @{
239 */
240
241/**
237 * Return the freeze count of a given canvas. 242 * Return the freeze count of a given canvas.
238 * @param e The canvas to fetch the freeze count from. 243 * @param e The canvas to fetch the freeze count from.
239 * 244 *
@@ -250,7 +255,7 @@ evas_event_thaw(Evas *e)
250 * 255 *
251 * while (evas_event_freeze_get(evas) > 0) evas_event_thaw(evas); 256 * while (evas_event_freeze_get(evas) > 0) evas_event_thaw(evas);
252 * @endcode 257 * @endcode
253 * @ingroup Evas_Event_Freezing_Group 258 *
254 */ 259 */
255EAPI int 260EAPI int
256evas_event_freeze_get(const Evas *e) 261evas_event_freeze_get(const Evas *e)
@@ -1466,9 +1471,12 @@ evas_event_feed_hold(Evas *e, int hold, unsigned int timestamp, const void *data
1466 _evas_unwalk(e); 1471 _evas_unwalk(e);
1467} 1472}
1468 1473
1474/**
1475 * @}
1476 */
1469 1477
1470/** 1478/**
1471 * @addtogroup Evas_Object_Group 1479 * @addtogroup Evas_Object_Group_Events
1472 * @{ 1480 * @{
1473 */ 1481 */
1474 1482
@@ -1482,8 +1490,6 @@ evas_event_feed_hold(Evas *e, int hold, unsigned int timestamp, const void *data
1482 * pass events) instead. 1490 * pass events) instead.
1483 * 1491 *
1484 * If @p pass is false, events will be processed as normal. 1492 * If @p pass is false, events will be processed as normal.
1485 *
1486 * @ingroup Evas_Object_Event_Flags_Group
1487 */ 1493 */
1488EAPI void 1494EAPI void
1489evas_object_pass_events_set(Evas_Object *obj, Eina_Bool pass) 1495evas_object_pass_events_set(Evas_Object *obj, Eina_Bool pass)
@@ -1511,8 +1517,6 @@ evas_object_pass_events_set(Evas_Object *obj, Eina_Bool pass)
1511 * Determine whether an object is set to pass events. 1517 * Determine whether an object is set to pass events.
1512 * @param obj 1518 * @param obj
1513 * @return pass events state 1519 * @return pass events state
1514 *
1515 * @ingroup Evas_Object_Event_Flags_Group
1516 */ 1520 */
1517EAPI Eina_Bool 1521EAPI Eina_Bool
1518evas_object_pass_events_get(const Evas_Object *obj) 1522evas_object_pass_events_get(const Evas_Object *obj)
@@ -1534,8 +1538,6 @@ evas_object_pass_events_get(const Evas_Object *obj)
1534 * 1538 *
1535 * If @p repeat is false, events occuring on @p obj will be processed 1539 * If @p repeat is false, events occuring on @p obj will be processed
1536 * normally. 1540 * normally.
1537 *
1538 * @ingroup Evas_Object_Event_Flags_Group
1539 */ 1541 */
1540EAPI void 1542EAPI void
1541evas_object_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) 1543evas_object_repeat_events_set(Evas_Object *obj, Eina_Bool repeat)
@@ -1562,8 +1564,6 @@ evas_object_repeat_events_set(Evas_Object *obj, Eina_Bool repeat)
1562 * Determine whether an object is set to repeat events. 1564 * Determine whether an object is set to repeat events.
1563 * @param obj 1565 * @param obj
1564 * @return repeat events state 1566 * @return repeat events state
1565 *
1566 * @ingroup Evas_Object_Event_Flags_Group
1567 */ 1567 */
1568EAPI Eina_Bool 1568EAPI Eina_Bool
1569evas_object_repeat_events_get(const Evas_Object *obj) 1569evas_object_repeat_events_get(const Evas_Object *obj)
@@ -1591,7 +1591,6 @@ evas_object_repeat_events_get(const Evas_Object *obj)
1591 * object, @p obj, will not be passed on to the parent smart object. 1591 * object, @p obj, will not be passed on to the parent smart object.
1592 * 1592 *
1593 * The default value is true. 1593 * The default value is true.
1594 * @ingroup Evas_Object_Event_Flags_Group
1595 */ 1594 */
1596EAPI void 1595EAPI void
1597evas_object_propagate_events_set(Evas_Object *obj, Eina_Bool prop) 1596evas_object_propagate_events_set(Evas_Object *obj, Eina_Bool prop)
@@ -1606,8 +1605,6 @@ evas_object_propagate_events_set(Evas_Object *obj, Eina_Bool prop)
1606 * Determine whether an object is set to propagate events. 1605 * Determine whether an object is set to propagate events.
1607 * @param obj 1606 * @param obj
1608 * @return propogate events state 1607 * @return propogate events state
1609 *
1610 * @ingroup Evas_Object_Event_Flags_Group
1611 */ 1608 */
1612EAPI Eina_Bool 1609EAPI Eina_Bool
1613evas_object_propagate_events_get(const Evas_Object *obj) 1610evas_object_propagate_events_get(const Evas_Object *obj)
@@ -1640,6 +1637,8 @@ evas_object_propagate_events_get(const Evas_Object *obj)
1640 * be emitted just when inside this object area. 1637 * be emitted just when inside this object area.
1641 * 1638 *
1642 * The default value is EVAS_OBJECT_POINTER_MODE_AUTOGRAB. 1639 * The default value is EVAS_OBJECT_POINTER_MODE_AUTOGRAB.
1640 *
1641 * @ingroup Evas_Object_Group_Extras
1643 */ 1642 */
1644EAPI void 1643EAPI void
1645evas_object_pointer_mode_set(Evas_Object *obj, Evas_Object_Pointer_Mode setting) 1644evas_object_pointer_mode_set(Evas_Object *obj, Evas_Object_Pointer_Mode setting)
@@ -1654,6 +1653,7 @@ evas_object_pointer_mode_set(Evas_Object *obj, Evas_Object_Pointer_Mode setting)
1654 * Determine how pointer will behave. 1653 * Determine how pointer will behave.
1655 * @param obj 1654 * @param obj
1656 * @return pointer behavior. 1655 * @return pointer behavior.
1656 * @ingroup Evas_Object_Group_Extras
1657 */ 1657 */
1658EAPI Evas_Object_Pointer_Mode 1658EAPI Evas_Object_Pointer_Mode
1659evas_object_pointer_mode_get(const Evas_Object *obj) 1659evas_object_pointer_mode_get(const Evas_Object *obj)
diff --git a/legacy/evas/src/lib/canvas/evas_focus.c b/legacy/evas/src/lib/canvas/evas_focus.c
index 9ce9cd8..6e2ec5b 100644
--- a/legacy/evas/src/lib/canvas/evas_focus.c
+++ b/legacy/evas/src/lib/canvas/evas_focus.c
@@ -8,6 +8,10 @@
8/* public calls */ 8/* public calls */
9 9
10/** 10/**
11 * @addtogroup Evas_Object_Group_Basic
12 * @{
13 */
14/**
11 * Sets focus to the given object. 15 * Sets focus to the given object.
12 * 16 *
13 * @param obj The object to be focused or unfocused. 17 * @param obj The object to be focused or unfocused.
@@ -76,6 +80,10 @@ evas_object_focus_get(const Evas_Object *obj)
76} 80}
77 81
78/** 82/**
83 * @}
84 */
85
86/**
79 * Retrieve the object that currently has focus. 87 * Retrieve the object that currently has focus.
80 * 88 *
81 * @param e The @c Evas canvas to query focus on. 89 * @param e The @c Evas canvas to query focus on.
@@ -88,6 +96,8 @@ evas_object_focus_get(const Evas_Object *obj)
88 * @see evas_object_key_ungrab 96 * @see evas_object_key_ungrab
89 * 97 *
90 * @return The object that has focus or NULL is there is not one. 98 * @return The object that has focus or NULL is there is not one.
99 *
100 * @ingroup Evas_Object_Group_Find
91 */ 101 */
92EAPI Evas_Object * 102EAPI Evas_Object *
93evas_focus_get(const Evas *e) 103evas_focus_get(const Evas *e)
diff --git a/legacy/evas/src/lib/canvas/evas_layer.c b/legacy/evas/src/lib/canvas/evas_layer.c
index 9f0041d..a3e5f5b 100644
--- a/legacy/evas/src/lib/canvas/evas_layer.c
+++ b/legacy/evas/src/lib/canvas/evas_layer.c
@@ -136,7 +136,7 @@ evas_layer_del(Evas_Layer *lay)
136/* public functions */ 136/* public functions */
137 137
138/** 138/**
139 * @addtogroup Evas_Object_Group 139 * @addtogroup Evas_Object_Group_Basic
140 * @{ 140 * @{
141 */ 141 */
142 142
@@ -147,6 +147,7 @@ evas_layer_del(Evas_Layer *lay)
147 * 147 *
148 * @param obj The given evas object. 148 * @param obj The given evas object.
149 * @param l The number of the layer to place the object on. 149 * @param l The number of the layer to place the object on.
150 * Between #EVAS_LAYER_MIN and #EVAS_LAYER_MAX.
150 */ 151 */
151EAPI void 152EAPI void
152evas_object_layer_set(Evas_Object *obj, short l) 153evas_object_layer_set(Evas_Object *obj, short l)
diff --git a/legacy/evas/src/lib/canvas/evas_main.c b/legacy/evas/src/lib/canvas/evas_main.c
index 666afab..00b692b 100644
--- a/legacy/evas/src/lib/canvas/evas_main.c
+++ b/legacy/evas/src/lib/canvas/evas_main.c
@@ -14,6 +14,7 @@ int _evas_log_dom_global = -1;
14 * 14 *
15 * @see evas_shutdown(). 15 * @see evas_shutdown().
16 * 16 *
17 * @ingroup Evas_Group
17 */ 18 */
18EAPI int 19EAPI int
19evas_init(void) 20evas_init(void)
@@ -75,8 +76,8 @@ evas_init(void)
75 * 76 *
76 * @see evas_init(). 77 * @see evas_init().
77 * 78 *
79 * @ingroup Evas_Group
78 */ 80 */
79
80EAPI int 81EAPI int
81evas_shutdown(void) 82evas_shutdown(void)
82{ 83{
@@ -104,14 +105,6 @@ evas_shutdown(void)
104 return _evas_init_count; 105 return _evas_init_count;
105} 106}
106 107
107/**
108 * @defgroup Evas_Canvas Evas Canvas functions
109 *
110 * Functions that deal with the basic evas object. They are the
111 * functions you need to use at a minimum to get a working evas, and
112 * to destroy it.
113 *
114 */
115 108
116/** 109/**
117 * Creates a new empty evas. 110 * Creates a new empty evas.
@@ -123,7 +116,15 @@ evas_shutdown(void)
123 * @li Ensure that the render engine is given the correct settings 116 * @li Ensure that the render engine is given the correct settings
124 * with @ref evas_engine_info_set . 117 * with @ref evas_engine_info_set .
125 * 118 *
126 * This function should only fail if the memory allocation fails. 119 * This function should only fail if the memory allocation fails
120 *
121 * @note this function is very low level. Instead of using it
122 * directly, consider using the high level functions in
123 * Ecore_Evas such as @c ecore_evas_new(). See
124 * http://docs.enlightenment.org/auto/ecore/.
125 *
126 * @attention it is recommended that one calls evas_init() before
127 * creating new canvas.
127 * 128 *
128 * @return A new uninitialised Evas canvas on success. Otherwise, @c 129 * @return A new uninitialised Evas canvas on success. Otherwise, @c
129 * NULL. 130 * NULL.
@@ -164,6 +165,7 @@ evas_new(void)
164 * in this function. 165 * in this function.
165 * 166 *
166 * @param e The given evas. 167 * @param e The given evas.
168 *
167 * @ingroup Evas_Canvas 169 * @ingroup Evas_Canvas
168 */ 170 */
169EAPI void 171EAPI void
@@ -269,40 +271,15 @@ evas_free(Evas *e)
269} 271}
270 272
271/** 273/**
272 * @defgroup Evas_Output_Method Evas Render Engine Functions
273 *
274 * Functions that are used to set the render engine for a given
275 * function, and then get that engine working.
276 *
277 * The following code snippet shows how they can be used to
278 * initialise an evas that uses the X11 software engine:
279 * @code
280 * Evas *evas;
281 * Evas_Engine_Info_Software_X11 *einfo;
282 * extern Display *display;
283 * extern Window win;
284 *
285 * evas = evas_new();
286 * evas_output_method_set(evas, evas_render_method_lookup("software_x11"));
287 * evas_output_size_set(evas, 640, 480);
288 * evas_output_viewport_set(evas, 0, 0, 640, 480);
289 * einfo = (Evas_Engine_Info_Software_X11 *)evas_engine_info_get(evas);
290 * einfo->info.display = display;
291 * einfo->info.visual = DefaultVisual(display, DefaultScreen(display));
292 * einfo->info.colormap = DefaultColormap(display, DefaultScreen(display));
293 * einfo->info.drawable = win;
294 * einfo->info.depth = DefaultDepth(display, DefaultScreen(display));
295 * evas_engine_info_set(evas, (Evas_Engine_Info *)einfo);
296 * @endcode
297 */
298
299/**
300 * Sets the output engine for the given evas. 274 * Sets the output engine for the given evas.
301 * 275 *
302 * Once the output engine for an evas is set, any attempt to change it 276 * Once the output engine for an evas is set, any attempt to change it
303 * will be ignored. The value for @p render_method can be found using 277 * will be ignored. The value for @p render_method can be found using
304 * @ref evas_render_method_lookup . 278 * @ref evas_render_method_lookup .
305 * 279 *
280 * @attention it is mandatory that one calls evas_init() before
281 * setting the output method.
282 *
306 * @param e The given evas. 283 * @param e The given evas.
307 * @param render_method The numeric engine value to use. 284 * @param render_method The numeric engine value to use.
308 * @ingroup Evas_Output_Method 285 * @ingroup Evas_Output_Method
@@ -400,8 +377,6 @@ evas_engine_info_get(const Evas *e)
400 * 377 *
401 * Once called, the @p info pointer should be considered invalid. 378 * Once called, the @p info pointer should be considered invalid.
402 * 379 *
403 * Example:
404 *
405 * @param e The pointer to the Evas Canvas 380 * @param e The pointer to the Evas Canvas
406 * @param info The pointer to the Engine Info to use 381 * @param info The pointer to the Engine Info to use
407 * @return 1 if no error occured, 0 otherwise 382 * @return 1 if no error occured, 0 otherwise
@@ -420,14 +395,6 @@ evas_engine_info_set(Evas *e, Evas_Engine_Info *info)
420} 395}
421 396
422/** 397/**
423 * @defgroup Evas_Output_Size Evas Output and Viewport Resizing
424 * Functions
425 *
426 * Functions that set and retrieve the output and viewport size of an
427 * evas.
428 */
429
430/**
431 * Sets the output size of the render engine of the given evas. 398 * Sets the output size of the render engine of the given evas.
432 * 399 *
433 * The evas will render to a rectangle of the given size once this 400 * The evas will render to a rectangle of the given size once this
@@ -573,14 +540,6 @@ evas_output_viewport_get(const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord
573} 540}
574 541
575/** 542/**
576 * @defgroup Evas_Coord_Mapping_Group Evas Coordinate Mapping
577 * Functions
578 *
579 * Functions that are used to map coordinates from the canvas to the
580 * screen or the screen to the canvas.
581 */
582
583/**
584 * Convert/scale an ouput screen co-ordinate into canvas co-ordinates 543 * Convert/scale an ouput screen co-ordinate into canvas co-ordinates
585 * 544 *
586 * @param e The pointer to the Evas Canvas 545 * @param e The pointer to the Evas Canvas
@@ -727,11 +686,16 @@ evas_coord_world_y_to_screen(const Evas *e, Evas_Coord y)
727 * written accessing render method ID's directly, without first 686 * written accessing render method ID's directly, without first
728 * obtaining it from this function. 687 * obtaining it from this function.
729 * 688 *
689 * @attention it is mandatory that one calls evas_init() before
690 * looking up the render method.
691 *
730 * Example: 692 * Example:
731 * @code 693 * @code
732 * int engine_id; 694 * int engine_id;
733 * Evas *evas; 695 * Evas *evas;
734 * 696 *
697 * evas_init();
698 *
735 * evas = evas_new(); 699 * evas = evas_new();
736 * if (!evas) 700 * if (!evas)
737 * { 701 * {
@@ -890,12 +854,6 @@ evas_render_method_list_free(Eina_List *list)
890} 854}
891 855
892/** 856/**
893 * @defgroup Evas_Pointer_Group Evas Pointer Functions
894 *
895 * Functions that deal with the status of the pointer.
896 */
897
898/**
899 * This function returns the current known pointer co-ordinates 857 * This function returns the current known pointer co-ordinates
900 * 858 *
901 * @param e The pointer to the Evas Canvas 859 * @param e The pointer to the Evas Canvas
@@ -1051,6 +1009,7 @@ evas_pointer_inside_get(const Evas *e)
1051 * 1009 *
1052 * @param e The canvas to attach the pointer to 1010 * @param e The canvas to attach the pointer to
1053 * @param data The pointer to attach 1011 * @param data The pointer to attach
1012 * @ingroup Evas_Canvas
1054 */ 1013 */
1055EAPI void 1014EAPI void
1056evas_data_attach_set(Evas *e, void *data) 1015evas_data_attach_set(Evas *e, void *data)
@@ -1066,6 +1025,7 @@ evas_data_attach_set(Evas *e, void *data)
1066 * 1025 *
1067 * @param e The canvas to attach the pointer to 1026 * @param e The canvas to attach the pointer to
1068 * @return The pointer attached 1027 * @return The pointer attached
1028 * @ingroup Evas_Canvas
1069 */ 1029 */
1070EAPI void * 1030EAPI void *
1071evas_data_attach_get(const Evas *e) 1031evas_data_attach_get(const Evas *e)
@@ -1076,6 +1036,12 @@ evas_data_attach_get(const Evas *e)
1076 return e->attach_data; 1036 return e->attach_data;
1077} 1037}
1078 1038
1039/**
1040 * Inform to the evas that it got the focus.
1041 *
1042 * @param e The evas to change information.
1043 * @ingroup Evas_Canvas
1044 */
1079EAPI void 1045EAPI void
1080evas_focus_in(Evas *e) 1046evas_focus_in(Evas *e)
1081{ 1047{
@@ -1087,6 +1053,12 @@ evas_focus_in(Evas *e)
1087 evas_event_callback_call(e, EVAS_CALLBACK_CANVAS_FOCUS_IN, NULL); 1053 evas_event_callback_call(e, EVAS_CALLBACK_CANVAS_FOCUS_IN, NULL);
1088} 1054}
1089 1055
1056/**
1057 * Inform to the evas that it lost the focus.
1058 *
1059 * @param e The evas to change information.
1060 * @ingroup Evas_Canvas
1061 */
1090EAPI void 1062EAPI void
1091evas_focus_out(Evas *e) 1063evas_focus_out(Evas *e)
1092{ 1064{
@@ -1098,6 +1070,12 @@ evas_focus_out(Evas *e)
1098 evas_event_callback_call(e, EVAS_CALLBACK_CANVAS_FOCUS_OUT, NULL); 1070 evas_event_callback_call(e, EVAS_CALLBACK_CANVAS_FOCUS_OUT, NULL);
1099} 1071}
1100 1072
1073/**
1074 * Get the focus state known by the given evas
1075 *
1076 * @param e The evas to query information.
1077 * @ingroup Evas_Canvas
1078 */
1101EAPI Eina_Bool 1079EAPI Eina_Bool
1102evas_focus_state_get(const Evas *e) 1080evas_focus_state_get(const Evas *e)
1103{ 1081{
@@ -1120,6 +1098,13 @@ _evas_unwalk(Evas *e)
1120 if ((e->walking_list == 0) && (e->delete_me)) evas_free(e); 1098 if ((e->walking_list == 0) && (e->delete_me)) evas_free(e);
1121} 1099}
1122 1100
1101/**
1102 * Converts the given error code into a string describing it in english.
1103 * @param error the error code.
1104 * @return Always return a valid string. If given @p error is not
1105 * supported "Unknown error" is returned.
1106 * @ingroup Evas_Utils
1107 */
1123EAPI const char * 1108EAPI const char *
1124evas_load_error_str(int error) 1109evas_load_error_str(int error)
1125{ 1110{
diff --git a/legacy/evas/src/lib/canvas/evas_map.c b/legacy/evas/src/lib/canvas/evas_map.c
index 543a31b..96d249e 100644
--- a/legacy/evas/src/lib/canvas/evas_map.c
+++ b/legacy/evas/src/lib/canvas/evas_map.c
@@ -263,6 +263,11 @@ evas_map_inside_get(const Evas_Map *m, Evas_Coord x, Evas_Coord y)
263 263
264 264
265/** 265/**
266 * @addtogroup Evas_Object_Group_Map
267 * @{
268 */
269
270/**
266 * Enable or disable the map that is set 271 * Enable or disable the map that is set
267 * 272 *
268 * This enables the map that is set or disables it. On enable, the object 273 * This enables the map that is set or disables it. On enable, the object
@@ -274,7 +279,7 @@ evas_map_inside_get(const Evas_Map *m, Evas_Coord x, Evas_Coord y)
274 * disable the map with evas_object_map_enable_set() as needed. 279 * disable the map with evas_object_map_enable_set() as needed.
275 * 280 *
276 * @param obj object to enable the map on 281 * @param obj object to enable the map on
277 * @param enbled enabled state 282 * @param enabled enabled state
278 */ 283 */
279EAPI void 284EAPI void
280evas_object_map_enable_set(Evas_Object *obj, Eina_Bool enabled) 285evas_object_map_enable_set(Evas_Object *obj, Eina_Bool enabled)
@@ -1136,14 +1141,14 @@ evas_map_util_3d_rotate(Evas_Map *m, double dx, double dy, double dz,
1136 * @param lr light red value (0 - 255) 1141 * @param lr light red value (0 - 255)
1137 * @param lg light green value (0 - 255) 1142 * @param lg light green value (0 - 255)
1138 * @param lb light blue value (0 - 255) 1143 * @param lb light blue value (0 - 255)
1139 * @param lr ambient color red value (0 - 255) 1144 * @param ar ambient color red value (0 - 255)
1140 * @param lg ambient color green value (0 - 255) 1145 * @param ag ambient color green value (0 - 255)
1141 * @param lb ambient color blue value (0 - 255) 1146 * @param ab ambient color blue value (0 - 255)
1142 */ 1147 */
1143EAPI void 1148EAPI void
1144evas_map_util_3d_lighting(Evas_Map *m, 1149evas_map_util_3d_lighting(Evas_Map *m,
1145 Evas_Coord lx, Evas_Coord ly, Evas_Coord lz, 1150 Evas_Coord lx, Evas_Coord ly, Evas_Coord lz,
1146 int lr, int lg, int lb, int ar, int ab, int ag) 1151 int lr, int lg, int lb, int ar, int ag, int ab)
1147{ 1152{
1148 int i; 1153 int i;
1149 1154
@@ -1309,3 +1314,7 @@ evas_map_util_clockwise_get(Evas_Map *m)
1309 if (count > 0) return 1; 1314 if (count > 0) return 1;
1310 return 0; 1315 return 0;
1311} 1316}
1317
1318/**
1319 * @}
1320 */
diff --git a/legacy/evas/src/lib/canvas/evas_name.c b/legacy/evas/src/lib/canvas/evas_name.c
index 92bb187..f5e204b 100644
--- a/legacy/evas/src/lib/canvas/evas_name.c
+++ b/legacy/evas/src/lib/canvas/evas_name.c
@@ -2,7 +2,7 @@
2#include "evas_private.h" 2#include "evas_private.h"
3 3
4/** 4/**
5 * @addtogroup Evas_Object_Group 5 * @addtogroup Evas_Object_Group_Basic
6 * @{ 6 * @{
7 */ 7 */
8 8
@@ -46,11 +46,16 @@ evas_object_name_get(const Evas_Object *obj)
46} 46}
47 47
48/** 48/**
49 * @}
50 */
51
52/**
49 * Retrieves the object on the given evas with the given name. 53 * Retrieves the object on the given evas with the given name.
50 * @param e The given evas. 54 * @param e The given evas.
51 * @param name The given name. 55 * @param name The given name.
52 * @return If successful, the evas object with the given name. Otherwise, 56 * @return If successful, the evas object with the given name. Otherwise,
53 * @c NULL. 57 * @c NULL.
58 * @ingroup Evas_Object_Group_Find
54 */ 59 */
55EAPI Evas_Object * 60EAPI Evas_Object *
56evas_object_name_find(const Evas *e, const char *name) 61evas_object_name_find(const Evas *e, const char *name)
@@ -61,7 +66,3 @@ evas_object_name_find(const Evas *e, const char *name)
61 if (!name) return NULL; 66 if (!name) return NULL;
62 return (Evas_Object *)eina_hash_find(e->name_hash, name); 67 return (Evas_Object *)eina_hash_find(e->name_hash, name);
63} 68}
64
65/**
66 * @}
67 */
diff --git a/legacy/evas/src/lib/canvas/evas_object_box.c b/legacy/evas/src/lib/canvas/evas_object_box.c
index 0efd262..2260240 100644
--- a/legacy/evas/src/lib/canvas/evas_object_box.c
+++ b/legacy/evas/src/lib/canvas/evas_object_box.c
@@ -22,7 +22,6 @@ struct _Evas_Object_Box_Accessor
22/** 22/**
23 * @addtogroup Evas_Object_Box 23 * @addtogroup Evas_Object_Box
24 * @{ 24 * @{
25 * @ingroup Evas_Smart_Object_Group
26 */ 25 */
27 26
28#define EVAS_OBJECT_BOX_DATA_GET(o, ptr) \ 27#define EVAS_OBJECT_BOX_DATA_GET(o, ptr) \
diff --git a/legacy/evas/src/lib/canvas/evas_object_gradient.c b/legacy/evas/src/lib/canvas/evas_object_gradient.c
index 506708f..9a97a46 100644
--- a/legacy/evas/src/lib/canvas/evas_object_gradient.c
+++ b/legacy/evas/src/lib/canvas/evas_object_gradient.c
@@ -85,24 +85,8 @@ static const Evas_Object_Func object_func =
85/* the actual api call to add a gradient */ 85/* the actual api call to add a gradient */
86 86
87/** 87/**
88 * @defgroup Evas_Object_Gradient_Group Gradient Object Functions
89 *
90 * Functions that work on evas gradient objects.
91 *
92 * The following example shows how
93 */
94
95/**
96 * @defgroup Evas_Object_Specific Specific Object Functions
97 *
98 * Functions that work on specific objects.
99 *
100 */
101
102/**
103 * @addtogroup Evas_Object_Gradient_Group 88 * @addtogroup Evas_Object_Gradient_Group
104 * @{ 89 * @{
105 * @ingroup Evas_Object_Specific
106 */ 90 */
107 91
108/** 92/**
@@ -724,6 +708,7 @@ evas_object_gradient_type_get(const Evas_Object *obj, char **name, char **params
724 * This function converts a given color in HSV color format to RGB 708 * This function converts a given color in HSV color format to RGB
725 * color format. 709 * color format.
726 * 710 *
711 * @ingroup Evas_Utils
727 **/ 712 **/
728EAPI void 713EAPI void
729evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int *b) 714evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int *b)
@@ -744,6 +729,7 @@ evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int *b)
744 * This function converts a given color in RGB color format to HSV 729 * This function converts a given color in RGB color format to HSV
745 * color format. 730 * color format.
746 * 731 *
732 * @ingroup Evas_Utils
747 **/ 733 **/
748EAPI void 734EAPI void
749evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float *v) 735evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float *v)
@@ -762,6 +748,7 @@ evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float *v)
762 * This function pre-multiplies a given rbg triplet by an alpha 748 * This function pre-multiplies a given rbg triplet by an alpha
763 * factor. Alpha factor is used to define transparency. 749 * factor. Alpha factor is used to define transparency.
764 * 750 *
751 * @ingroup Evas_Utils
765 **/ 752 **/
766EAPI void 753EAPI void
767evas_color_argb_premul(int a, int *r, int *g, int *b) 754evas_color_argb_premul(int a, int *r, int *g, int *b)
@@ -782,6 +769,7 @@ evas_color_argb_premul(int a, int *r, int *g, int *b)
782 * 769 *
783 * @see evas_color_argb_premul(). 770 * @see evas_color_argb_premul().
784 * 771 *
772 * @ingroup Evas_Utils
785 **/ 773 **/
786EAPI void 774EAPI void
787evas_color_argb_unpremul(int a, int *r, int *g, int *b) 775evas_color_argb_unpremul(int a, int *r, int *g, int *b)
@@ -798,6 +786,7 @@ evas_color_argb_unpremul(int a, int *r, int *g, int *b)
798 * This function pre-multiplies a given data by an alpha 786 * This function pre-multiplies a given data by an alpha
799 * factor. Alpha factor is used to define transparency. 787 * factor. Alpha factor is used to define transparency.
800 * 788 *
789 * @ingroup Evas_Utils
801 **/ 790 **/
802EAPI void 791EAPI void
803evas_data_argb_premul(unsigned int *data, unsigned int len) 792evas_data_argb_premul(unsigned int *data, unsigned int len)
@@ -815,6 +804,7 @@ evas_data_argb_premul(unsigned int *data, unsigned int len)
815 * This function undoes pre-multiplication of a given data by an alpha 804 * This function undoes pre-multiplication of a given data by an alpha
816 * factor. Alpha factor is used to define transparency. 805 * factor. Alpha factor is used to define transparency.
817 * 806 *
807 * @ingroup Evas_Utils
818 **/ 808 **/
819EAPI void 809EAPI void
820evas_data_argb_unpremul(unsigned int *data, unsigned int len) 810evas_data_argb_unpremul(unsigned int *data, unsigned int len)
diff --git a/legacy/evas/src/lib/canvas/evas_object_gradient2.c b/legacy/evas/src/lib/canvas/evas_object_gradient2.c
index 42b8018..ab003ce 100644
--- a/legacy/evas/src/lib/canvas/evas_object_gradient2.c
+++ b/legacy/evas/src/lib/canvas/evas_object_gradient2.c
@@ -19,18 +19,9 @@ struct _Evas_Object_Gradient2
19}; 19};
20 20
21 21
22
23/**
24 * @defgroup Evas_Object_Gradient2_Group Gradient2 Object Functions
25 *
26 * Functions that work on evas gradient2 objects.
27 *
28 */
29
30/** 22/**
31 * @addtogroup Evas_Object_Gradient2_Group 23 * @addtogroup Evas_Object_Gradient2_Group
32 * @{ 24 * @{
33 * @ingroup Evas_Object_Specific
34 */ 25 */
35 26
36/** 27/**
diff --git a/legacy/evas/src/lib/canvas/evas_object_image.c b/legacy/evas/src/lib/canvas/evas_object_image.c
index 4b773d0..bbda40c 100644
--- a/legacy/evas/src/lib/canvas/evas_object_image.c
+++ b/legacy/evas/src/lib/canvas/evas_object_image.c
@@ -120,94 +120,10 @@ static const Evas_Object_Func object_func =
120 evas_object_image_can_map 120 evas_object_image_can_map
121}; 121};
122 122
123/**
124 * @defgroup Evas_Object_Image Image Object Functions
125 *
126 * Functions used to create and manipulate image objects.
127 *
128 * Note - Image objects may return or accept "image data" in multiple
129 * formats. This is based on the colorspace of an object. Here is a
130 * rundown on formats:
131 *
132 * EVAS_COLORSPACE_ARGB8888:
133 *
134 * This pixel format is a linear block of pixels, starting at the
135 * top-left row by row until the bottom right of the image or pixel
136 * region. All pixels are 32-bit unsigned int's with the high-byte
137 * being alpha and the low byte being blue in the format ARGB. Alpha
138 * may or may not be used by evas depending on the alpha flag of the
139 * image, but if not used, should be set to 0xff anyway.
140 *
141 * This colorspace uses premultiplied alpha. That means that R, G and
142 * B cannot exceed A in value. The conversion from non-premultiplied
143 * colorspace is:
144 *
145 * R = (r * a) / 255; G = (g * a) / 255; B = (b * a) / 255;
146 *
147 * So 50% transparent blue will be: 0x80000080. This will not be
148 * "dark" - just 50% transparent. Values are 0 == black, 255 == solid
149 * or full red, green or blue.
150 *
151 * EVAS_COLORSPACE_YCBCR422P601_PL:
152 *
153 * This is a pointer-list indirected set of YUV (YCbCr) pixel
154 * data. This means that the data returned or set is not actual pixel
155 * data, but pointers TO lines of pixel data. The list of pointers
156 * will first be N rows of pointers to the Y plane - pointing to the
157 * first pixel at the start of each row in the Y plane. N is the
158 * height of the image data in pixels. Each pixel in the Y, U and V
159 * planes is 1 byte exactly, packed. The next N / 2 pointers will
160 * point to rows in the U plane, and the next N / 2 pointers will
161 * point to the V plane rows. U and V planes are half the horizontal
162 * and vertical resolution of the Y plane.
163 *
164 * Row order is top to bottom and row pixels are stored left to right.
165 *
166 * There is a limitation that these images MUST be a multiple of 2
167 * pixels in size horizontally or vertically. This is due to the U and
168 * V planes being half resolution. Also note that this assumes the
169 * itu601 YUV colorspace specification. This is defined for standard
170 * television and mpeg streams. HDTV may use the itu709
171 * specification.
172 *
173 * Values are 0 to 255, indicating full or no signal in that plane
174 * respectively.
175 *
176 * EVAS_COLORSPACE_YCBCR422P709_PL:
177 *
178 * Not implemented yet.
179 *
180 * EVAS_COLORSPACE_RGB565_A5P:
181 *
182 * In the process of being implemented in 1 engine only. This may change.
183 *
184 * This is a pointer to image data for 16-bit half-word pixel data in
185 * 16bpp RGB 565 format (5 bits red, 6 bits green, 5 bits blue), with
186 * the high-byte containing red and the low byte containing blue, per
187 * pixel. This data is packed row by row from the top-left to the
188 * bottom right.
189 *
190 * If the image has an alpha channel enabled there will be an extra
191 * alpha plane after the color pixel plane. If not, then this data
192 * will not exist and should not be accessed in any way. This plane is
193 * a set of pixels with 1 byte per pixel defining the alpha values of
194 * all pixels in the image from the top-left to the bottom right of
195 * the image, row by row. Even though the values of the alpha pixels
196 * can be 0 to 255, only values 0 through to 32 are used, 32 being
197 * solid and 0 being transparent.
198 *
199 * RGB values can be 0 to 31 for red and blue and 0 to 63 for green,
200 * with 0 being black and 31 or 63 being full red, green or blue
201 * respectively. This colorspace is also pre-multiplied like
202 * EVAS_COLORSPACE_ARGB8888 so:
203 *
204 * R = (r * a) / 32; G = (g * a) / 32; B = (b * a) / 32;
205 */
206 123
207/** 124/**
208 * @addtogroup Evas_Object_Image 125 * @addtogroup Evas_Object_Image
209 * @{ 126 * @{
210 * @ingroup Evas_Object_Specific
211 */ 127 */
212 128
213/** 129/**
@@ -2071,6 +1987,15 @@ evas_object_image_content_hint_get(const Evas_Object *obj)
2071} 1987}
2072 1988
2073/** 1989/**
1990 * @}
1991 */
1992
1993/**
1994 * @addtogroup Evas_Image_Group
1995 * @{
1996 */
1997
1998/**
2074 * Flush the image cache of the canvas. 1999 * Flush the image cache of the canvas.
2075 * 2000 *
2076 * @param e The given evas pointer. 2001 * @param e The given evas pointer.
@@ -2094,6 +2019,7 @@ evas_image_cache_flush(Evas *e)
2094 * @param e The given evas pointer. 2019 * @param e The given evas pointer.
2095 * 2020 *
2096 * This function reloads the image cache of canvas. 2021 * This function reloads the image cache of canvas.
2022 *
2097 */ 2023 */
2098EAPI void 2024EAPI void
2099evas_image_cache_reload(Evas *e) 2025evas_image_cache_reload(Evas *e)
diff --git a/legacy/evas/src/lib/canvas/evas_object_intercept.c b/legacy/evas/src/lib/canvas/evas_object_intercept.c
index b1195de..3387685 100644
--- a/legacy/evas/src/lib/canvas/evas_object_intercept.c
+++ b/legacy/evas/src/lib/canvas/evas_object_intercept.c
@@ -240,6 +240,11 @@ evas_object_intercept_call_clip_unset(Evas_Object *obj)
240/* public calls */ 240/* public calls */
241 241
242/** 242/**
243 * @addtogroup Evas_Object_Group_Interceptors
244 * @{
245 */
246
247/**
243 * Set the callback function that intercepts a show event of a object. 248 * Set the callback function that intercepts a show event of a object.
244 * 249 *
245 * @param obj The given canvas object pointer. 250 * @param obj The given canvas object pointer.
@@ -809,3 +814,7 @@ evas_object_intercept_clip_unset_callback_del(Evas_Object *obj, void (*func) (vo
809 evas_object_intercept_deinit(obj); 814 evas_object_intercept_deinit(obj);
810 return data; 815 return data;
811} 816}
817
818/**
819 * @}
820 */
diff --git a/legacy/evas/src/lib/canvas/evas_object_line.c b/legacy/evas/src/lib/canvas/evas_object_line.c
index 138ad20..2cf1b0a 100644
--- a/legacy/evas/src/lib/canvas/evas_object_line.c
+++ b/legacy/evas/src/lib/canvas/evas_object_line.c
@@ -72,16 +72,10 @@ static const Evas_Object_Func object_func =
72/* the actual api call to add a rect */ 72/* the actual api call to add a rect */
73/* it has no other api calls as all properties are standard */ 73/* it has no other api calls as all properties are standard */
74 74
75/**
76 * @defgroup Evas_Line_Group Line Object Functions
77 *
78 * Functions used to deal with evas line objects.
79 */
80 75
81/** 76/**
82 * @addtogroup Evas_Line_Group 77 * @addtogroup Evas_Line_Group
83 * @{ 78 * @{
84 * @ingroup Evas_Object_Specific
85 */ 79 */
86 80
87/** 81/**
diff --git a/legacy/evas/src/lib/canvas/evas_object_main.c b/legacy/evas/src/lib/canvas/evas_object_main.c
index f130173..a016e2a 100644
--- a/legacy/evas/src/lib/canvas/evas_object_main.c
+++ b/legacy/evas/src/lib/canvas/evas_object_main.c
@@ -350,12 +350,6 @@ evas_object_was_inside(Evas_Object *obj, Evas_Coord x, Evas_Coord y)
350/* routines apps will call */ 350/* routines apps will call */
351 351
352/** 352/**
353 * @defgroup Evas_Object_Group Generic Object Functions
354 *
355 * Functions that manipulate generic evas objects.
356 */
357
358/**
359 * Deletes the given evas object and frees its memory. 353 * Deletes the given evas object and frees its memory.
360 * 354 *
361 * The object's 'free' callback is called when this function is called. 355 * The object's 'free' callback is called when this function is called.
@@ -363,7 +357,7 @@ evas_object_was_inside(Evas_Object *obj, Evas_Coord x, Evas_Coord y)
363 * also called. 357 * also called.
364 * 358 *
365 * @param obj The given evas object. 359 * @param obj The given evas object.
366 * @ingroup Evas_Object_Group 360 * @ingroup Evas_Object_Group_Basic
367 */ 361 */
368EAPI void 362EAPI void
369evas_object_del(Evas_Object *obj) 363evas_object_del(Evas_Object *obj)
@@ -410,7 +404,7 @@ evas_object_del(Evas_Object *obj)
410 * @param obj The given evas object. 404 * @param obj The given evas object.
411 * @param x X position to move the object to, in canvas units. 405 * @param x X position to move the object to, in canvas units.
412 * @param y Y position to move the object to, in canvas units. 406 * @param y Y position to move the object to, in canvas units.
413 * @ingroup Evas_Object_Group 407 * @ingroup Evas_Object_Group_Basic
414 */ 408 */
415EAPI void 409EAPI void
416evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) 410evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y)
@@ -484,7 +478,24 @@ evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y)
484 * @param obj The given evas object. 478 * @param obj The given evas object.
485 * @param w The new width of the evas object. 479 * @param w The new width of the evas object.
486 * @param h The new height of the evas object. 480 * @param h The new height of the evas object.
487 * @ingroup Evas_Object_Group 481 *
482 * @note Be aware that resizing an object changes its drawing area,
483 * but that does imply the object is rescaled! For instance,
484 * images are filled inside their drawing area using the
485 * specifications of evas_object_image_fill_set(), thus to scale
486 * the image to match exactly your drawing area, you need to
487 * change the evas_object_image_fill_set() as well. Consider the
488 * following example:
489 * @code
490 * // rescale image to fill exactly its area without tiling:
491 * evas_object_resize(img, w, h);
492 * evas_object_image_fill_set(img, 0, 0, w, h);
493 * @endcode
494 * This is more evident in images, but text, textblock, lines
495 * and polygons will behave similarly. Check their specific APIs
496 * to know how to achive your desired behavior.
497 *
498 * @ingroup Evas_Object_Group_Basic
488 */ 499 */
489EAPI void 500EAPI void
490evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h) 501evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
@@ -574,7 +585,7 @@ evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
574 * object. 585 * object.
575 * @param h Pointer to an integer in which to store the height of the 586 * @param h Pointer to an integer in which to store the height of the
576 * object. 587 * object.
577 * @ingroup Evas_Object_Group 588 * @ingroup Evas_Object_Group_Basic
578 */ 589 */
579EAPI void 590EAPI void
580evas_object_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) 591evas_object_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
@@ -595,7 +606,7 @@ evas_object_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, E
595} 606}
596 607
597/** 608/**
598 * @addtogroup Evas_Object_Group 609 * @addtogroup Evas_Object_Group_Size_Hints
599 * @{ 610 * @{
600 */ 611 */
601 612
@@ -1034,7 +1045,7 @@ evas_object_size_hint_padding_set(Evas_Object *obj, Evas_Coord l, Evas_Coord r,
1034/** 1045/**
1035 * Makes the given evas object visible. 1046 * Makes the given evas object visible.
1036 * @param obj The given evas object. 1047 * @param obj The given evas object.
1037 * @ingroup Evas_Object_Group 1048 * @ingroup Evas_Object_Group_Basic
1038 */ 1049 */
1039EAPI void 1050EAPI void
1040evas_object_show(Evas_Object *obj) 1051evas_object_show(Evas_Object *obj)
@@ -1083,7 +1094,13 @@ evas_object_show(Evas_Object *obj)
1083/** 1094/**
1084 * Makes the given evas object invisible. 1095 * Makes the given evas object invisible.
1085 * @param obj The given evas object. 1096 * @param obj The given evas object.
1086 * @ingroup Evas_Object_Group 1097 *
1098 * @note the hidden objects will not be checked for changes and will
1099 * not catch events. That is, they are much ligher than an
1100 * object that is invisible due indirect effects, such as
1101 * clipped or out-of-viewport.
1102 *
1103 * @ingroup Evas_Object_Group_Basic
1087 */ 1104 */
1088EAPI void 1105EAPI void
1089evas_object_hide(Evas_Object *obj) 1106evas_object_hide(Evas_Object *obj)
@@ -1175,7 +1192,7 @@ evas_object_hide(Evas_Object *obj)
1175 * Retrieves whether or not the given evas object is visible. 1192 * Retrieves whether or not the given evas object is visible.
1176 * @param obj The given evas object. 1193 * @param obj The given evas object.
1177 * @return @c 1 if the object is visible. @c 0 otherwise. 1194 * @return @c 1 if the object is visible. @c 0 otherwise.
1178 * @ingroup Evas_Object_Group 1195 * @ingroup Evas_Object_Group_Basic
1179 */ 1196 */
1180EAPI Eina_Bool 1197EAPI Eina_Bool
1181evas_object_visible_get(const Evas_Object *obj) 1198evas_object_visible_get(const Evas_Object *obj)
@@ -1194,7 +1211,7 @@ evas_object_visible_get(const Evas_Object *obj)
1194 * @param g The green component of the given colour. 1211 * @param g The green component of the given colour.
1195 * @param b The blue component of the given colour. 1212 * @param b The blue component of the given colour.
1196 * @param a The alpha component of the given colour. 1213 * @param a The alpha component of the given colour.
1197 * @ingroup Evas_Object_Group 1214 * @ingroup Evas_Object_Group_Basic
1198 */ 1215 */
1199EAPI void 1216EAPI void
1200evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a) 1217evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a)
@@ -1241,7 +1258,7 @@ evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a)
1241 * the colour. 1258 * the colour.
1242 * @param a Pointer to an integer in which to store the alpha component of 1259 * @param a Pointer to an integer in which to store the alpha component of
1243 * the colour. 1260 * the colour.
1244 * @ingroup Evas_Object_Group 1261 * @ingroup Evas_Object_Group_Basic
1245 */ 1262 */
1246EAPI void 1263EAPI void
1247evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a) 1264evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a)
@@ -1266,7 +1283,7 @@ evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a)
1266 * 1283 *
1267 * @param obj The given evas object. 1284 * @param obj The given evas object.
1268 * @param anti_alias 1 if the object is to be anti_aliased, 0 otherwise. 1285 * @param anti_alias 1 if the object is to be anti_aliased, 0 otherwise.
1269 * @ingroup Evas_Object_Group 1286 * @ingroup Evas_Object_Group_Extras
1270 */ 1287 */
1271EAPI void 1288EAPI void
1272evas_object_anti_alias_set(Evas_Object *obj, Eina_Bool anti_alias) 1289evas_object_anti_alias_set(Evas_Object *obj, Eina_Bool anti_alias)
@@ -1286,7 +1303,7 @@ evas_object_anti_alias_set(Evas_Object *obj, Eina_Bool anti_alias)
1286 * Retrieves whether or not the given evas object is to be drawn anti_aliased. 1303 * Retrieves whether or not the given evas object is to be drawn anti_aliased.
1287 * @param obj The given evas object. 1304 * @param obj The given evas object.
1288 * @return @c 1 if the object is to be anti_aliased. @c 0 otherwise. 1305 * @return @c 1 if the object is to be anti_aliased. @c 0 otherwise.
1289 * @ingroup Evas_Object_Group 1306 * @ingroup Evas_Object_Group_Extras
1290 */ 1307 */
1291EAPI Eina_Bool 1308EAPI Eina_Bool
1292evas_object_anti_alias_get(const Evas_Object *obj) 1309evas_object_anti_alias_get(const Evas_Object *obj)
@@ -1303,7 +1320,7 @@ evas_object_anti_alias_get(const Evas_Object *obj)
1303 * 1320 *
1304 * @param obj The given evas object. 1321 * @param obj The given evas object.
1305 * @param scale The scaling factor. 1.0 == none. 1322 * @param scale The scaling factor. 1.0 == none.
1306 * @ingroup Evas_Object_Group 1323 * @ingroup Evas_Object_Group_Extras
1307 */ 1324 */
1308EAPI void 1325EAPI void
1309evas_object_scale_set(Evas_Object *obj, double scale) 1326evas_object_scale_set(Evas_Object *obj, double scale)
@@ -1325,7 +1342,7 @@ evas_object_scale_set(Evas_Object *obj, double scale)
1325 * @param obj The given evas object. 1342 * @param obj The given evas object.
1326 * @return The scaling factor. 1343 * @return The scaling factor.
1327 * 1344 *
1328 * @ingroup Evas_Object_Group 1345 * @ingroup Evas_Object_Group_Extras
1329 */ 1346 */
1330EAPI double 1347EAPI double
1331evas_object_scale_get(const Evas_Object *obj) 1348evas_object_scale_get(const Evas_Object *obj)
@@ -1343,7 +1360,7 @@ evas_object_scale_get(const Evas_Object *obj)
1343 * @param obj The given evas object. 1360 * @param obj The given evas object.
1344 * @param color_space one of EVAS_COLOR_SPACE_ARGB or EVAS_COLOR_SPACE_AHSV. 1361 * @param color_space one of EVAS_COLOR_SPACE_ARGB or EVAS_COLOR_SPACE_AHSV.
1345 * 1362 *
1346 * @ingroup Evas_Object_Group 1363 * @ingroup Evas_Object_Group_Extras
1347 */ 1364 */
1348EAPI void 1365EAPI void
1349evas_object_color_interpolation_set(Evas_Object *obj, int color_space) 1366evas_object_color_interpolation_set(Evas_Object *obj, int color_space)
@@ -1363,7 +1380,7 @@ evas_object_color_interpolation_set(Evas_Object *obj, int color_space)
1363 * Retrieves the current value of the color space used for linear interpolation. 1380 * Retrieves the current value of the color space used for linear interpolation.
1364 * @param obj The given evas object. 1381 * @param obj The given evas object.
1365 * @return @c EVAS_COLOR_SPACE_ARGB or EVAS_COLOR_SPACE_AHSV. 1382 * @return @c EVAS_COLOR_SPACE_ARGB or EVAS_COLOR_SPACE_AHSV.
1366 * @ingroup Evas_Object_Group 1383 * @ingroup Evas_Object_Group_Extras
1367 */ 1384 */
1368EAPI int 1385EAPI int
1369evas_object_color_interpolation_get(const Evas_Object *obj) 1386evas_object_color_interpolation_get(const Evas_Object *obj)
@@ -1379,7 +1396,7 @@ evas_object_color_interpolation_get(const Evas_Object *obj)
1379 * Sets the render_op to be used for rendering the evas object. 1396 * Sets the render_op to be used for rendering the evas object.
1380 * @param obj The given evas object. 1397 * @param obj The given evas object.
1381 * @param render_op one of the Evas_Render_Op values. 1398 * @param render_op one of the Evas_Render_Op values.
1382 * @ingroup Evas_Object_Group 1399 * @ingroup Evas_Object_Group_Extras
1383 */ 1400 */
1384EAPI void 1401EAPI void
1385evas_object_render_op_set(Evas_Object *obj, Evas_Render_Op render_op) 1402evas_object_render_op_set(Evas_Object *obj, Evas_Render_Op render_op)
@@ -1399,7 +1416,7 @@ evas_object_render_op_set(Evas_Object *obj, Evas_Render_Op render_op)
1399 * Retrieves the current value of the operation used for rendering the evas object. 1416 * Retrieves the current value of the operation used for rendering the evas object.
1400 * @param obj The given evas object. 1417 * @param obj The given evas object.
1401 * @return one of the enumerated values in Evas_Render_Op. 1418 * @return one of the enumerated values in Evas_Render_Op.
1402 * @ingroup Evas_Object_Group 1419 * @ingroup Evas_Object_Group_Extras
1403 */ 1420 */
1404EAPI Evas_Render_Op 1421EAPI Evas_Render_Op
1405evas_object_render_op_get(const Evas_Object *obj) 1422evas_object_render_op_get(const Evas_Object *obj)
@@ -1415,7 +1432,7 @@ evas_object_render_op_get(const Evas_Object *obj)
1415 * Retrieves the evas that the given evas object is on. 1432 * Retrieves the evas that the given evas object is on.
1416 * @param obj The given evas object. 1433 * @param obj The given evas object.
1417 * @return The evas that the object is on. 1434 * @return The evas that the object is on.
1418 * @ingroup Evas_Object_Group 1435 * @ingroup Evas_Object_Group_Basic
1419 */ 1436 */
1420EAPI Evas * 1437EAPI Evas *
1421evas_object_evas_get(const Evas_Object *obj) 1438evas_object_evas_get(const Evas_Object *obj)
@@ -1428,7 +1445,7 @@ evas_object_evas_get(const Evas_Object *obj)
1428} 1445}
1429 1446
1430/** 1447/**
1431 * @addtogroup Evas_Object_Group 1448 * @addtogroup Evas_Object_Group_Find
1432 * @{ 1449 * @{
1433 */ 1450 */
1434 1451
@@ -1634,9 +1651,14 @@ evas_objects_in_rectangle_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Co
1634} 1651}
1635 1652
1636/** 1653/**
1654 * @}
1655 */
1656
1657/**
1637 * Retrieves the name of the type of the given evas object. 1658 * Retrieves the name of the type of the given evas object.
1638 * @param obj The given object. 1659 * @param obj The given object.
1639 * @return The name. 1660 * @return The name.
1661 * @ingroup Evas_Object_Group_Basic
1640 */ 1662 */
1641EAPI const char * 1663EAPI const char *
1642evas_object_type_get(const Evas_Object *obj) 1664evas_object_type_get(const Evas_Object *obj)
@@ -1653,6 +1675,7 @@ evas_object_type_get(const Evas_Object *obj)
1653 * @param obj The given object. 1675 * @param obj The given object.
1654 * @param precise wheter to use a precise point collision detection or not 1676 * @param precise wheter to use a precise point collision detection or not
1655 * The default value is false. 1677 * The default value is false.
1678 * @ingroup Evas_Object_Group_Extras
1656 */ 1679 */
1657EAPI void 1680EAPI void
1658evas_object_precise_is_inside_set(Evas_Object *obj, Eina_Bool precise) 1681evas_object_precise_is_inside_set(Evas_Object *obj, Eina_Bool precise)
@@ -1664,8 +1687,10 @@ evas_object_precise_is_inside_set(Evas_Object *obj, Eina_Bool precise)
1664} 1687}
1665 1688
1666/** 1689/**
1667 * Determine whether an object is set to use a precise point collision detection. 1690 * Determine whether an object is set to use a precise point collision
1691 * detection.
1668 * @param obj The given object. 1692 * @param obj The given object.
1693 * @ingroup Evas_Object_Group_Extras
1669 */ 1694 */
1670EAPI Eina_Bool 1695EAPI Eina_Bool
1671evas_object_precise_is_inside_get(const Evas_Object *obj) 1696evas_object_precise_is_inside_get(const Evas_Object *obj)
@@ -1675,7 +1700,3 @@ evas_object_precise_is_inside_get(const Evas_Object *obj)
1675 MAGIC_CHECK_END(); 1700 MAGIC_CHECK_END();
1676 return obj->precise_is_inside; 1701 return obj->precise_is_inside;
1677} 1702}
1678
1679/**
1680 * @}
1681 */
diff --git a/legacy/evas/src/lib/canvas/evas_object_polygon.c b/legacy/evas/src/lib/canvas/evas_object_polygon.c
index e3eb7ff..15a5546 100644
--- a/legacy/evas/src/lib/canvas/evas_object_polygon.c
+++ b/legacy/evas/src/lib/canvas/evas_object_polygon.c
@@ -76,15 +76,8 @@ static const Evas_Object_Func object_func =
76/* it has no other api calls as all properties are standard */ 76/* it has no other api calls as all properties are standard */
77 77
78/** 78/**
79 * @defgroup Evas_Object_Polygon Polygon Object Functions
80 *
81 * Functions that operate on evas polygon objects.
82 */
83
84/**
85 * @addtogroup Evas_Object_Polygon 79 * @addtogroup Evas_Object_Polygon
86 * @{ 80 * @{
87 * @ingroup Evas_Object_Specific
88 */ 81 */
89 82
90/** 83/**
diff --git a/legacy/evas/src/lib/canvas/evas_object_rectangle.c b/legacy/evas/src/lib/canvas/evas_object_rectangle.c
index 9e2dd42..b3d8fed 100644
--- a/legacy/evas/src/lib/canvas/evas_object_rectangle.c
+++ b/legacy/evas/src/lib/canvas/evas_object_rectangle.c
@@ -66,16 +66,10 @@ static const Evas_Object_Func object_func =
66/* the actual api call to add a rect */ 66/* the actual api call to add a rect */
67/* it has no other api calls as all properties are standard */ 67/* it has no other api calls as all properties are standard */
68 68
69/**
70 * @defgroup Evas_Object_Rectangle Rectangle Object Functions
71 *
72 * Functions that operate on evas rectangle objects.
73 */
74 69
75/** 70/**
76 * @addtogroup Evas_Object_Rectangle 71 * @addtogroup Evas_Object_Rectangle
77 * @{ 72 * @{
78 * @ingroup Evas_Object_Specific
79 */ 73 */
80 74
81/** 75/**
diff --git a/legacy/evas/src/lib/canvas/evas_object_smart.c b/legacy/evas/src/lib/canvas/evas_object_smart.c
index 93455fc..2151699 100644
--- a/legacy/evas/src/lib/canvas/evas_object_smart.c
+++ b/legacy/evas/src/lib/canvas/evas_object_smart.c
@@ -66,18 +66,6 @@ static const Evas_Object_Func object_func =
66 66
67/* public funcs */ 67/* public funcs */
68/** 68/**
69 * @defgroup Evas_Smart_Object_Group Evas Smart Object Functions
70 *
71 * Functions dealing with evas smart objects.
72 *
73 * Smart objects are groupings of primitive evas objects that behave as a
74 * cohesive group. For instance, a file manager icon may be a smart object
75 * composed of an image object, a text label and two rectangles that appear
76 * behind the image and text when the icon is selected. As a smart object,
77 * the normal evas api could be used on the icon object.
78 *
79 */
80/**
81 * Store a pointer to user data for a smart object. 69 * Store a pointer to user data for a smart object.
82 * 70 *
83 * @param obj The smart object 71 * @param obj The smart object
@@ -534,7 +522,7 @@ evas_object_smart_callbacks_descriptions_set(Evas_Object *obj, const Evas_Smart_
534 * @a instance_count can be ignored, the terminator @c NULL is not 522 * @a instance_count can be ignored, the terminator @c NULL is not
535 * counted in these values. 523 * counted in these values.
536 * 524 *
537 * @param s the smart object. 525 * @param obj the smart object.
538 * @param class_descriptions where to store class callbacks 526 * @param class_descriptions where to store class callbacks
539 * descriptions array, if any is known. If no descriptions are 527 * descriptions array, if any is known. If no descriptions are
540 * known, @c NULL is returned. This parameter may be @c NULL if 528 * known, @c NULL is returned. This parameter may be @c NULL if
diff --git a/legacy/evas/src/lib/canvas/evas_object_smart_clipped.c b/legacy/evas/src/lib/canvas/evas_object_smart_clipped.c
index 8ece21a..5df37fd 100644
--- a/legacy/evas/src/lib/canvas/evas_object_smart_clipped.c
+++ b/legacy/evas/src/lib/canvas/evas_object_smart_clipped.c
@@ -2,7 +2,7 @@
2#include "evas_private.h" 2#include "evas_private.h"
3 3
4/** 4/**
5 * @addtogroup Evas_Smart_Object_Group 5 * @addtogroup Evas_Smart_Object_Clipped Clipped Smart Object
6 * @{ 6 * @{
7 */ 7 */
8 8
diff --git a/legacy/evas/src/lib/canvas/evas_object_text.c b/legacy/evas/src/lib/canvas/evas_object_text.c
index 054862a..0c72b1f 100644
--- a/legacy/evas/src/lib/canvas/evas_object_text.c
+++ b/legacy/evas/src/lib/canvas/evas_object_text.c
@@ -81,15 +81,8 @@ static const Evas_Object_Func object_func =
81/* it has no other api calls as all properties are standard */ 81/* it has no other api calls as all properties are standard */
82 82
83/** 83/**
84 * @defgroup Evas_Object_Text Text Object Functions
85 *
86 * Functions that operate on evas text objects.
87 */
88
89/**
90 * @addtogroup Evas_Object_Text 84 * @addtogroup Evas_Object_Text
91 * @{ 85 * @{
92 * @ingroup Evas_Object_Specific
93 */ 86 */
94 87
95/** 88/**
@@ -1006,11 +999,6 @@ evas_object_text_style_pad_get(const Evas_Object *obj, int *l, int *r, int *t, i
1006 * @} 999 * @}
1007 */ 1000 */
1008 1001
1009/**
1010 * @defgroup Evas_Font_Path_Group Evas Font Path Functions
1011 *
1012 * Functions that edit the paths being used to load fonts.
1013 */
1014 1002
1015/** 1003/**
1016 * Removes all font paths loaded into memory for the given evas. 1004 * Removes all font paths loaded into memory for the given evas.
@@ -1096,6 +1084,14 @@ evas_font_object_rehint(Evas_Object *obj)
1096 } 1084 }
1097} 1085}
1098 1086
1087/**
1088 * Changes the font hinting for the given evas.
1089 *
1090 * @param e The given evas.
1091 * @param hinting The hinting to use, one of #EVAS_FONT_HINTING_NONE,
1092 * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
1093 * @ingroup Evas_Font_Group
1094 */
1099EAPI void 1095EAPI void
1100evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting) 1096evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting)
1101{ 1097{
@@ -1115,6 +1111,14 @@ evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting)
1115 } 1111 }
1116} 1112}
1117 1113
1114/**
1115 * Retrieves the font hinting used by the given evas.
1116 *
1117 * @param e The given evas to query.
1118 * @return The hinting in use, one of #EVAS_FONT_HINTING_NONE,
1119 * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
1120 * @ingroup Evas_Font_Group
1121 */
1118EAPI Evas_Font_Hinting_Flags 1122EAPI Evas_Font_Hinting_Flags
1119evas_font_hinting_get(const Evas *e) 1123evas_font_hinting_get(const Evas *e)
1120{ 1124{
@@ -1124,6 +1128,15 @@ evas_font_hinting_get(const Evas *e)
1124 return e->hinting; 1128 return e->hinting;
1125} 1129}
1126 1130
1131/**
1132 * Checks if the font hinting is supported by the given evas.
1133 *
1134 * @param e The given evas to query.
1135 * @param hinting The hinting to use, one of #EVAS_FONT_HINTING_NONE,
1136 * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
1137 * @return @c EINA_TRUE if it is supported, @c EINA_FALSE otherwise.
1138 * @ingroup Evas_Font_Group
1139 */
1127EAPI Eina_Bool 1140EAPI Eina_Bool
1128evas_font_hinting_can_hint(const Evas *e, Evas_Font_Hinting_Flags hinting) 1141evas_font_hinting_can_hint(const Evas *e, Evas_Font_Hinting_Flags hinting)
1129{ 1142{
@@ -1136,15 +1149,11 @@ evas_font_hinting_can_hint(const Evas *e, Evas_Font_Hinting_Flags hinting)
1136 return EINA_FALSE; 1149 return EINA_FALSE;
1137} 1150}
1138 1151
1139
1140
1141
1142
1143/** 1152/**
1144 * To be documented. 1153 * Force the given evas and associated engine to flush its font cache.
1145 *
1146 * FIXME: To be fixed.
1147 * 1154 *
1155 * @param e The given evas to flush font cache.
1156 * @ingroup Evas_Font_Group
1148 */ 1157 */
1149EAPI void 1158EAPI void
1150evas_font_cache_flush(Evas *e) 1159evas_font_cache_flush(Evas *e)
@@ -1157,10 +1166,12 @@ evas_font_cache_flush(Evas *e)
1157} 1166}
1158 1167
1159/** 1168/**
1160 * To be documented. 1169 * Changes the size of font cache of the given evas.
1161 * 1170 *
1162 * FIXME: To be fixed. 1171 * @param e The given evas to flush font cache.
1172 * @param size The size, in bytes.
1163 * 1173 *
1174 * @ingroup Evas_Font_Group
1164 */ 1175 */
1165EAPI void 1176EAPI void
1166evas_font_cache_set(Evas *e, int size) 1177evas_font_cache_set(Evas *e, int size)
@@ -1174,10 +1185,12 @@ evas_font_cache_set(Evas *e, int size)
1174} 1185}
1175 1186
1176/** 1187/**
1177 * To be documented. 1188 * Changes the size of font cache of the given evas.
1178 * 1189 *
1179 * FIXME: To be fixed. 1190 * @param e The given evas to flush font cache.
1191 * @return The size, in bytes.
1180 * 1192 *
1193 * @ingroup Evas_Font_Group
1181 */ 1194 */
1182EAPI int 1195EAPI int
1183evas_font_cache_get(const Evas *e) 1196evas_font_cache_get(const Evas *e)
@@ -1190,10 +1203,18 @@ evas_font_cache_get(const Evas *e)
1190} 1203}
1191 1204
1192/** 1205/**
1193 * To be documented. 1206 * List of available font descriptions known or found by this evas.
1194 * 1207 *
1195 * FIXME: To be fixed. 1208 * The list depends on Evas compile time configuration, such as
1209 * fontconfig support, and the paths provided at runtime as explained
1210 * in @ref Evas_Font_Path_Group.
1211 *
1212 * @param e The evas instance to query.
1213 * @return a newly allocated list of strings. Do not change the
1214 * strings. Be sure to call evas_font_available_list_free()
1215 * after you're done.
1196 * 1216 *
1217 * @ingroup Evas_Font_Group
1197 */ 1218 */
1198EAPI Eina_List * 1219EAPI Eina_List *
1199evas_font_available_list(const Evas *e) 1220evas_font_available_list(const Evas *e)
@@ -1206,10 +1227,12 @@ evas_font_available_list(const Evas *e)
1206} 1227}
1207 1228
1208/** 1229/**
1209 * To be documented. 1230 * Free list of font descriptions returned by evas_font_dir_available_list().
1210 * 1231 *
1211 * FIXME: To be fixed. 1232 * @param e The evas instance that returned such list.
1233 * @param available the list returned by evas_font_dir_available_list().
1212 * 1234 *
1235 * @ingroup Evas_Font_Group
1213 */ 1236 */
1214EAPI void 1237EAPI void
1215evas_font_available_list_free(Evas *e, Eina_List *available) 1238evas_font_available_list_free(Evas *e, Eina_List *available)
@@ -1226,6 +1249,7 @@ evas_font_available_list_free(Evas *e, Eina_List *available)
1226 * 1249 *
1227 * FIXME: To be fixed. 1250 * FIXME: To be fixed.
1228 * 1251 *
1252 * @ingroup Evas_Utils
1229 */ 1253 */
1230EAPI int 1254EAPI int
1231evas_string_char_next_get(const char *str, int pos, int *decoded) 1255evas_string_char_next_get(const char *str, int pos, int *decoded)
@@ -1246,6 +1270,7 @@ evas_string_char_next_get(const char *str, int pos, int *decoded)
1246 * 1270 *
1247 * FIXME: To be fixed. 1271 * FIXME: To be fixed.
1248 * 1272 *
1273 * @ingroup Evas_Utils
1249 */ 1274 */
1250EAPI int 1275EAPI int
1251evas_string_char_prev_get(const char *str, int pos, int *decoded) 1276evas_string_char_prev_get(const char *str, int pos, int *decoded)
@@ -1265,6 +1290,7 @@ evas_string_char_prev_get(const char *str, int pos, int *decoded)
1265 * Get the length in characters of the string. 1290 * Get the length in characters of the string.
1266 * @param str The string to get the length of. 1291 * @param str The string to get the length of.
1267 * @return The length in characters (not bytes) 1292 * @return The length in characters (not bytes)
1293 * @ingroup Evas_Utils
1268 */ 1294 */
1269EAPI int 1295EAPI int
1270evas_string_char_len_get(const char *str) 1296evas_string_char_len_get(const char *str)
diff --git a/legacy/evas/src/lib/canvas/evas_object_textblock.c b/legacy/evas/src/lib/canvas/evas_object_textblock.c
index 75ee5ab..a497038 100644
--- a/legacy/evas/src/lib/canvas/evas_object_textblock.c
+++ b/legacy/evas/src/lib/canvas/evas_object_textblock.c
@@ -212,18 +212,10 @@ static const Evas_Object_Func object_func =
212 return (x); \ 212 return (x); \
213 MAGIC_CHECK_END(); 213 MAGIC_CHECK_END();
214 214
215/**
216 * @defgroup Evas_Object_Textblock Textblock Object Functions
217 *
218 * Functions used to create and manipulate textblock objects.
219 *
220 * Note: put here some usage examples
221 */
222 215
223/** 216/**
224 * @addtogroup Evas_Object_Textblock 217 * @addtogroup Evas_Object_Textblock
225 * @{ 218 * @{
226 * @ingroup Evas_Object_Specific
227 */ 219 */
228 220
229/* styles */ 221/* styles */
@@ -4956,6 +4948,12 @@ evas_textblock_cursor_range_geometry_get(const Evas_Textblock_Cursor *cur1, cons
4956 return rects; 4948 return rects;
4957} 4949}
4958 4950
4951/**
4952 * To be documented.
4953 *
4954 * FIXME: To be fixed.
4955 *
4956 */
4959EAPI Eina_Bool 4957EAPI Eina_Bool
4960evas_textblock_cursor_eol_get(const Evas_Textblock_Cursor *cur) 4958evas_textblock_cursor_eol_get(const Evas_Textblock_Cursor *cur)
4961{ 4959{
@@ -4963,6 +4961,12 @@ evas_textblock_cursor_eol_get(const Evas_Textblock_Cursor *cur)
4963 return cur->eol; 4961 return cur->eol;
4964} 4962}
4965 4963
4964/**
4965 * To be documented.
4966 *
4967 * FIXME: To be fixed.
4968 *
4969 */
4966EAPI void 4970EAPI void
4967evas_textblock_cursor_eol_set(Evas_Textblock_Cursor *cur, Eina_Bool eol) 4971evas_textblock_cursor_eol_set(Evas_Textblock_Cursor *cur, Eina_Bool eol)
4968{ 4972{
diff --git a/legacy/evas/src/lib/canvas/evas_render.c b/legacy/evas/src/lib/canvas/evas_render.c
index 3db53fc..b951fa9 100644
--- a/legacy/evas/src/lib/canvas/evas_render.c
+++ b/legacy/evas/src/lib/canvas/evas_render.c
@@ -53,6 +53,7 @@ evas_render_updates_internal(Evas *e, unsigned char make_updates, unsigned char
53 * This is the function by which one tells evas that a part of the 53 * This is the function by which one tells evas that a part of the
54 * canvas has to be repainted. 54 * canvas has to be repainted.
55 * 55 *
56 * @ingroup Evas_Canvas
56 */ 57 */
57EAPI void 58EAPI void
58evas_damage_rectangle_add(Evas *e, int x, int y, int w, int h) 59evas_damage_rectangle_add(Evas *e, int x, int y, int w, int h)
@@ -83,6 +84,7 @@ evas_damage_rectangle_add(Evas *e, int x, int y, int w, int h)
83 * 84 *
84 * @see evas_obscured_clear(). 85 * @see evas_obscured_clear().
85 * 86 *
87 * @ingroup Evas_Canvas
86 */ 88 */
87EAPI void 89EAPI void
88evas_obscured_rectangle_add(Evas *e, int x, int y, int w, int h) 90evas_obscured_rectangle_add(Evas *e, int x, int y, int w, int h)
@@ -107,6 +109,7 @@ evas_obscured_rectangle_add(Evas *e, int x, int y, int w, int h)
107 * evas_obscured_rectangle_add() and makes it a region that have to be 109 * evas_obscured_rectangle_add() and makes it a region that have to be
108 * repainted. 110 * repainted.
109 * 111 *
112 * @ingroup Evas_Canvas
110 */ 113 */
111EAPI void 114EAPI void
112evas_obscured_clear(Evas *e) 115evas_obscured_clear(Evas *e)
@@ -1166,6 +1169,7 @@ evas_render_updates_internal(Evas *e,
1166 * This function removes the region from the render updates list. It 1169 * This function removes the region from the render updates list. It
1167 * makes the region doesn't be render updated anymore. 1170 * makes the region doesn't be render updated anymore.
1168 * 1171 *
1172 * @ingroup Evas_Canvas
1169 */ 1173 */
1170EAPI void 1174EAPI void
1171evas_render_updates_free(Eina_List *updates) 1175evas_render_updates_free(Eina_List *updates)
@@ -1180,11 +1184,13 @@ evas_render_updates_free(Eina_List *updates)
1180 * Force immediate renderization of the given canvas. 1184 * Force immediate renderization of the given canvas.
1181 * 1185 *
1182 * @param e The given canvas pointer. 1186 * @param e The given canvas pointer.
1183 * @return A list of updated rectangles of the canvas. 1187 * @return A newly allocated list of updated rectangles of the canvas.
1188 * Free this list with evas_render_updates_free().
1184 * 1189 *
1185 * This function forces an immediate renderization update of the given 1190 * This function forces an immediate renderization update of the given
1186 * given canvas. 1191 * given canvas.
1187 * 1192 *
1193 * @ingroup Evas_Canvas
1188 */ 1194 */
1189EAPI Eina_List * 1195EAPI Eina_List *
1190evas_render_updates(Evas *e) 1196evas_render_updates(Evas *e)
@@ -1198,12 +1204,11 @@ evas_render_updates(Evas *e)
1198} 1204}
1199 1205
1200/** 1206/**
1201 * Force renderization of a region 1207 * Force renderization of the given canvas.
1202 * 1208 *
1203 * @param e The given canvas pointer. 1209 * @param e The given canvas pointer.
1204 * 1210 *
1205 * This function forces renderization of the region given. 1211 * @ingroup Evas_Canvas
1206 *
1207 */ 1212 */
1208EAPI void 1213EAPI void
1209evas_render(Evas *e) 1214evas_render(Evas *e)
@@ -1228,6 +1233,7 @@ evas_render(Evas *e)
1228 * 1233 *
1229 * @see evas_render. 1234 * @see evas_render.
1230 * 1235 *
1236 * @ingroup Evas_Canvas
1231 */ 1237 */
1232EAPI void 1238EAPI void
1233evas_norender(Evas *e) 1239evas_norender(Evas *e)
@@ -1247,6 +1253,7 @@ evas_norender(Evas *e)
1247 * 1253 *
1248 * This function flushes the arrays of delete, active and render objects. 1254 * This function flushes the arrays of delete, active and render objects.
1249 * 1255 *
1256 * @ingroup Evas_Canvas
1250 */ 1257 */
1251EAPI void 1258EAPI void
1252evas_render_idle_flush(Evas *e) 1259evas_render_idle_flush(Evas *e)
diff --git a/legacy/evas/src/lib/canvas/evas_smart.c b/legacy/evas/src/lib/canvas/evas_smart.c
index 861b001..f85c1a4 100644
--- a/legacy/evas/src/lib/canvas/evas_smart.c
+++ b/legacy/evas/src/lib/canvas/evas_smart.c
@@ -7,13 +7,6 @@ static void _evas_smart_class_callbacks_create(Evas_Smart *s);
7/* all public */ 7/* all public */
8 8
9/** 9/**
10 * @defgroup Evas_Smart_Group Evas Smart Functions
11 *
12 * Functions that deal with Evas_Smart's.
13 *
14 */
15
16/**
17 * @addtogroup Evas_Smart_Group 10 * @addtogroup Evas_Smart_Group
18 * @{ 11 * @{
19 */ 12 */
diff --git a/legacy/evas/src/lib/canvas/evas_stack.c b/legacy/evas/src/lib/canvas/evas_stack.c
index b7fcb68..1ca1b66 100644
--- a/legacy/evas/src/lib/canvas/evas_stack.c
+++ b/legacy/evas/src/lib/canvas/evas_stack.c
@@ -38,11 +38,14 @@ evas_object_below_get_internal(const Evas_Object *obj)
38} 38}
39 39
40/** 40/**
41 * @addtogroup Evas_Object_Group_Basic
42 * @{
43 */
44
45/**
41 * Raise @p obj to the top of its layer. 46 * Raise @p obj to the top of its layer.
42 * 47 *
43 * @param obj the object to raise 48 * @param obj the object to raise
44 *
45 * @ingroup Evas_Object_Group
46 */ 49 */
47EAPI void 50EAPI void
48evas_object_raise(Evas_Object *obj) 51evas_object_raise(Evas_Object *obj)
@@ -97,8 +100,6 @@ evas_object_raise(Evas_Object *obj)
97 * Lower @p obj to the bottom of its layer. 100 * Lower @p obj to the bottom of its layer.
98 * 101 *
99 * @param obj the object to lower 102 * @param obj the object to lower
100 *
101 * @ingroup Evas_Object_Group
102 */ 103 */
103EAPI void 104EAPI void
104evas_object_lower(Evas_Object *obj) 105evas_object_lower(Evas_Object *obj)
@@ -160,8 +161,6 @@ evas_object_lower(Evas_Object *obj)
160 * 161 *
161 * @param obj the object to stack 162 * @param obj the object to stack
162 * @param above the object above which to stack 163 * @param above the object above which to stack
163 *
164 * @ingroup Evas_Object_Group
165 */ 164 */
166EAPI void 165EAPI void
167evas_object_stack_above(Evas_Object *obj, Evas_Object *above) 166evas_object_stack_above(Evas_Object *obj, Evas_Object *above)
@@ -254,8 +253,6 @@ evas_object_stack_above(Evas_Object *obj, Evas_Object *above)
254 * 253 *
255 * @param obj the object to stack 254 * @param obj the object to stack
256 * @param below the object below which to stack 255 * @param below the object below which to stack
257 *
258 * @ingroup Evas_Object_Group
259 */ 256 */
260EAPI void 257EAPI void
261evas_object_stack_below(Evas_Object *obj, Evas_Object *below) 258evas_object_stack_below(Evas_Object *obj, Evas_Object *below)
@@ -342,8 +339,6 @@ evas_object_stack_below(Evas_Object *obj, Evas_Object *below)
342 * 339 *
343 * @param obj an Evas_Object 340 * @param obj an Evas_Object
344 * @return the Evas_Object directly above 341 * @return the Evas_Object directly above
345 *
346 * @ingroup Evas_Object_Group
347 */ 342 */
348EAPI Evas_Object * 343EAPI Evas_Object *
349evas_object_above_get(const Evas_Object *obj) 344evas_object_above_get(const Evas_Object *obj)
@@ -375,8 +370,6 @@ evas_object_above_get(const Evas_Object *obj)
375 * 370 *
376 * @param obj an Evas_Object 371 * @param obj an Evas_Object
377 * @return the Evas_Object directly below 372 * @return the Evas_Object directly below
378 *
379 * @ingroup Evas_Object_Group
380 */ 373 */
381EAPI Evas_Object * 374EAPI Evas_Object *
382evas_object_below_get(const Evas_Object *obj) 375evas_object_below_get(const Evas_Object *obj)
@@ -404,12 +397,19 @@ evas_object_below_get(const Evas_Object *obj)
404} 397}
405 398
406/** 399/**
400 * @}
401 */
402
403/**
404 * @addtogroup Evas_Object_Group_Find
405 * @{
406 */
407
408/**
407 * Get the lowest evas object on the Evas @p e 409 * Get the lowest evas object on the Evas @p e
408 * 410 *
409 * @param e an Evas 411 * @param e an Evas
410 * @return the lowest object 412 * @return the lowest object
411 *
412 * @ingroup Evas_Object_Group
413 */ 413 */
414EAPI Evas_Object * 414EAPI Evas_Object *
415evas_object_bottom_get(const Evas *e) 415evas_object_bottom_get(const Evas *e)
@@ -436,8 +436,6 @@ evas_object_bottom_get(const Evas *e)
436 * 436 *
437 * @param e an Evas 437 * @param e an Evas
438 * @return the highest object 438 * @return the highest object
439 *
440 * @ingroup Evas_Object_Group
441 */ 439 */
442EAPI Evas_Object * 440EAPI Evas_Object *
443evas_object_top_get(const Evas *e) 441evas_object_top_get(const Evas *e)
@@ -470,3 +468,7 @@ evas_object_top_get(const Evas *e)
470 468
471 return obj; 469 return obj;
472} 470}
471
472/**
473 * @}
474 */
diff --git a/legacy/evas/src/lib/canvas/evas_stats.c b/legacy/evas/src/lib/canvas/evas_stats.c
index d43569c..94cb27b 100644
--- a/legacy/evas/src/lib/canvas/evas_stats.c
+++ b/legacy/evas/src/lib/canvas/evas_stats.c
@@ -2,6 +2,11 @@
2#include "evas_private.h" 2#include "evas_private.h"
3#include "evas_cs.h" 3#include "evas_cs.h"
4 4
5/**
6 * Retrieves if the system wants to share bitmaps using the server.
7 * @return @c EINA_TRUE if wants, @c EINA_FALSE otherwise.
8 * @ingroup Evas_Cserve
9 */
5EAPI Eina_Bool 10EAPI Eina_Bool
6evas_cserve_want_get(void) 11evas_cserve_want_get(void)
7{ 12{
@@ -11,6 +16,11 @@ evas_cserve_want_get(void)
11 return 0; 16 return 0;
12} 17}
13 18
19/**
20 * Retrieves if the system is connected to the server used to shae bitmaps.
21 * @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise.
22 * @ingroup Evas_Cserve
23 */
14EAPI Eina_Bool 24EAPI Eina_Bool
15evas_cserve_connected_get(void) 25evas_cserve_connected_get(void)
16{ 26{
@@ -20,6 +30,14 @@ evas_cserve_connected_get(void)
20 return 0; 30 return 0;
21} 31}
22 32
33/**
34 * Retrieves if the system wants to share bitmaps using the server.
35 * @param stats pointer to structure to fill with statistics about
36 * cache server.
37 * @return @c EINA_TRUE if @p stats were filled with data,
38 * @c EINA_FALSE otherwise and @p stats is untouched.
39 * @ingroup Evas_Cserve
40 */
23EAPI Eina_Bool 41EAPI Eina_Bool
24evas_cserve_stats_get(Evas_Cserve_Stats *stats) 42evas_cserve_stats_get(Evas_Cserve_Stats *stats)
25{ 43{
@@ -137,6 +155,13 @@ evas_cserve_image_cache_contents_clean(Evas_Cserve_Image_Cache *cache)
137#endif 155#endif
138} 156}
139 157
158/**
159 * Retrieves the current configuration of the server.
160 * @param config where to store current server configuration.
161 * @return @c EINA_TRUE if @p config were filled with data,
162 * @c EINA_FALSE otherwise and @p config is untouched.
163 * @ingroup Evas_Cserve
164 */
140EAPI Eina_Bool 165EAPI Eina_Bool
141evas_cserve_config_get(Evas_Cserve_Config *config) 166evas_cserve_config_get(Evas_Cserve_Config *config)
142{ 167{
@@ -154,8 +179,15 @@ evas_cserve_config_get(Evas_Cserve_Config *config)
154#endif 179#endif
155} 180}
156 181
182/**
183 * Changes the configuration of the server.
184 * @param config where to store current server configuration.
185 * @return @c EINA_TRUE if @p config were successfully applied,
186 * @c EINA_FALSE otherwise.
187 * @ingroup Evas_Cserve
188 */
157EAPI Eina_Bool 189EAPI Eina_Bool
158evas_cserve_config_set(Evas_Cserve_Config *config) 190evas_cserve_config_set(const Evas_Cserve_Config *config)
159{ 191{
160#ifdef EVAS_CSERVE 192#ifdef EVAS_CSERVE
161 Op_Setconfig conf; 193 Op_Setconfig conf;
@@ -170,6 +202,10 @@ evas_cserve_config_set(Evas_Cserve_Config *config)
170#endif 202#endif
171} 203}
172 204
205/**
206 * Force system to disconnect from cache server.
207 * @ingroup Evas_Cserve
208 */
173EAPI void 209EAPI void
174evas_cserve_disconnect(void) 210evas_cserve_disconnect(void)
175{ 211{
diff --git a/legacy/evas/src/lib/canvas/evas_transform.c b/legacy/evas/src/lib/canvas/evas_transform.c
index f5d0f41..024e173 100644
--- a/legacy/evas/src/lib/canvas/evas_transform.c
+++ b/legacy/evas/src/lib/canvas/evas_transform.c
@@ -2,6 +2,17 @@
2#include "evas_private.h" 2#include "evas_private.h"
3#include <math.h> 3#include <math.h>
4 4
5/**
6 * @addtogroup Evas_Utils
7 * @{
8 */
9
10/**
11 * To be documented.
12 *
13 * FIXME: To be fixed.
14 *
15 */
5EAPI void 16EAPI void
6evas_transform_identity_set(Evas_Transform *t) 17evas_transform_identity_set(Evas_Transform *t)
7{ 18{
@@ -14,6 +25,12 @@ evas_transform_identity_set(Evas_Transform *t)
14 } 25 }
15} 26}
16 27
28/**
29 * To be documented.
30 *
31 * FIXME: To be fixed.
32 *
33 */
17EAPI void 34EAPI void
18evas_transform_rotate(double angle, Evas_Transform *t) 35evas_transform_rotate(double angle, Evas_Transform *t)
19{ 36{
@@ -39,6 +56,12 @@ evas_transform_rotate(double angle, Evas_Transform *t)
39 t->myz = (-sa * mxz) + (ca * myz); 56 t->myz = (-sa * mxz) + (ca * myz);
40} 57}
41 58
59/**
60 * To be documented.
61 *
62 * FIXME: To be fixed.
63 *
64 */
42EAPI void 65EAPI void
43evas_transform_translate(float dx, float dy, Evas_Transform *t) 66evas_transform_translate(float dx, float dy, Evas_Transform *t)
44{ 67{
@@ -54,6 +77,12 @@ evas_transform_translate(float dx, float dy, Evas_Transform *t)
54 t->myz = dy * t->mzz; 77 t->myz = dy * t->mzz;
55} 78}
56 79
80/**
81 * To be documented.
82 *
83 * FIXME: To be fixed.
84 *
85 */
57EAPI void 86EAPI void
58evas_transform_scale(float sx, float sy, Evas_Transform *t) 87evas_transform_scale(float sx, float sy, Evas_Transform *t)
59{ 88{
@@ -69,6 +98,12 @@ evas_transform_scale(float sx, float sy, Evas_Transform *t)
69 t->myz = sy * t->myz; 98 t->myz = sy * t->myz;
70} 99}
71 100
101/**
102 * To be documented.
103 *
104 * FIXME: To be fixed.
105 *
106 */
72EAPI void 107EAPI void
73evas_transform_shear(float sh, float sv, Evas_Transform *t) 108evas_transform_shear(float sh, float sv, Evas_Transform *t)
74{ 109{
@@ -90,6 +125,12 @@ evas_transform_shear(float sh, float sv, Evas_Transform *t)
90 t->myz = (sv * mxz) + myz; 125 t->myz = (sv * mxz) + myz;
91} 126}
92 127
128/**
129 * To be documented.
130 *
131 * FIXME: To be fixed.
132 *
133 */
93EAPI void 134EAPI void
94evas_transform_compose(Evas_Transform *l, Evas_Transform *t) 135evas_transform_compose(Evas_Transform *l, Evas_Transform *t)
95{ 136{
@@ -115,3 +156,7 @@ evas_transform_compose(Evas_Transform *l, Evas_Transform *t)
115 t->mzy = (l->mzx * mxy) + (l->mzy * myy) + (l->mzz * mzy); 156 t->mzy = (l->mzx * mxy) + (l->mzy * myy) + (l->mzz * mzy);
116 t->mzz = (l->mzx * mxz) + (l->mzy * myz) + (l->mzz * mzz); 157 t->mzz = (l->mzx * mxz) + (l->mzy * myz) + (l->mzz * mzz);
117} 158}
159
160/**
161 * @}
162 */