summaryrefslogtreecommitdiff
path: root/src/lib/evas/Evas_Common.h
diff options
context:
space:
mode:
authorNicolas Aguirre <aguirre.nicolas@gmail.com>2014-10-14 11:21:55 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:17:26 +0200
commit0f6e45e2a04bdc4a6c040fa41b28339ab807aae8 (patch)
tree8a582192051082ea2926622ac9167e1d8011342b /src/lib/evas/Evas_Common.h
parent604d3ae8a27d4f6661d0606b115e3cf0459c1715 (diff)
evas: add documentation on missing types and return values of Evas_Common.h.
Diffstat (limited to 'src/lib/evas/Evas_Common.h')
-rw-r--r--src/lib/evas/Evas_Common.h30
1 files changed, 18 insertions, 12 deletions
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index 6dfa5113cf..c1f78f889c 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -318,7 +318,7 @@ typedef struct _Evas_Video_Surface Evas_Video_Surface;
318 318
319typedef unsigned long long Evas_Modifier_Mask; /**< An Evas modifier mask type */ 319typedef unsigned long long Evas_Modifier_Mask; /**< An Evas modifier mask type */
320 320
321typedef int Evas_Coord; 321typedef int Evas_Coord /**< A type for coordinates */;
322typedef int Evas_Font_Size; 322typedef int Evas_Font_Size;
323typedef int Evas_Angle; 323typedef int Evas_Angle;
324 324
@@ -336,12 +336,13 @@ struct _Evas_Coord_Point
336 Evas_Coord y; /**< y co-ordinate */ 336 Evas_Coord y; /**< y co-ordinate */
337}; 337};
338 338
339struct _Evas_Coord_Size 339struct _Evas_Coord_Size /**< A size in Evas_Coord */
340{ 340{
341 Evas_Coord w; /**< width */ 341 Evas_Coord w; /**< width */
342 Evas_Coord h; /**< height */ 342 Evas_Coord h; /**< height */
343}; 343};
344 344
345
345struct _Evas_Coord_Precision_Size 346struct _Evas_Coord_Precision_Size
346{ 347{
347 Evas_Coord w; /** < width */ 348 Evas_Coord w; /** < width */
@@ -352,25 +353,28 @@ struct _Evas_Coord_Precision_Size
352 353
353struct _Evas_Coord_Precision_Point 354struct _Evas_Coord_Precision_Point
354{ 355{
355 Evas_Coord x, y; 356 Evas_Coord x; /**< x co-ordinate */
356 double xsub, ysub; 357 Evas_Coord y; /**< y co-ordinate */
358 double xsub; /** < subpixel precision for x */
359 double ysub; /** < subpixel precision for y */
357}; 360};
358 361
359struct _Evas_Point 362struct _Evas_Point
360{ 363{
361 int x, y; 364 int x; /**< x co-ordinate */
365 int y; /**< y co-ordinate */
362}; 366};
363 367
364struct _Evas_Position 368struct _Evas_Position
365{ 369{
366 Evas_Point output; 370 Evas_Point output; /**< position on the output */
367 Evas_Coord_Point canvas; /**< position on the canvas */ 371 Evas_Coord_Point canvas; /**< position on the canvas */
368}; 372};
369 373
370struct _Evas_Precision_Position 374struct _Evas_Precision_Position
371{ 375{
372 Evas_Point output; 376 Evas_Point output; /**< position on the output */
373 Evas_Coord_Precision_Point canvas; 377 Evas_Coord_Precision_Point canvas; /**< position on the canvas */
374}; 378};
375 379
376typedef enum _Evas_Aspect_Control 380typedef enum _Evas_Aspect_Control
@@ -505,7 +509,7 @@ typedef void (*Evas_Video_Coord_Cb)(void *data, Evas_Object *obj, const Evas_Vid
505 509
506struct _Evas_Video_Surface 510struct _Evas_Video_Surface
507{ 511{
508 int version; 512 int version; /**< The Evas Video surface version in use @see EVAS_VIDEO_SURFACE_VERSION*/
509 513
510 Evas_Video_Coord_Cb move; /**< Move the video surface to this position */ 514 Evas_Video_Coord_Cb move; /**< Move the video surface to this position */
511 Evas_Video_Coord_Cb resize; /**< Resize the video surface to that size */ 515 Evas_Video_Coord_Cb resize; /**< Resize the video surface to that size */
@@ -513,7 +517,7 @@ struct _Evas_Video_Surface
513 Evas_Video_Cb hide; /**< Hide the video overlay surface */ 517 Evas_Video_Cb hide; /**< Hide the video overlay surface */
514 Evas_Video_Cb update_pixels; /**< Please update the Evas_Object_Image pixels when called */ 518 Evas_Video_Cb update_pixels; /**< Please update the Evas_Object_Image pixels when called */
515 519
516 Evas_Object *parent; 520 Evas_Object *parent; /**< The parent object */
517 void *data; 521 void *data;
518}; 522};
519 523
@@ -571,8 +575,8 @@ typedef enum _Evas_Border_Fill_Mode
571 575
572typedef enum _Evas_Engine_Render_Mode 576typedef enum _Evas_Engine_Render_Mode
573{ 577{
574 EVAS_RENDER_MODE_BLOCKING = 0, 578 EVAS_RENDER_MODE_BLOCKING = 0, /**< The rendering is blocking mode*/
575 EVAS_RENDER_MODE_NONBLOCKING = 1, 579 EVAS_RENDER_MODE_NONBLOCKING = 1, /** < The rendering is non blocking mode*/
576} Evas_Engine_Render_Mode; 580} Evas_Engine_Render_Mode;
577 581
578typedef enum _Evas_Image_Content_Hint 582typedef enum _Evas_Image_Content_Hint
@@ -1337,6 +1341,8 @@ EAPI Evas_Device *evas_device_add(Evas *e);
1337/** 1341/**
1338 * Delete a new device type 1342 * Delete a new device type
1339 * 1343 *
1344 * @param dev The device node you want to delete.
1345 *
1340 * @see evas_device_add 1346 * @see evas_device_add
1341 * @see evas_device_push 1347 * @see evas_device_push
1342 * @see evas_device_pop 1348 * @see evas_device_pop