summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile.in18
-rw-r--r--doc/eina_examples.dox37
-rw-r--r--doc/elementary_examples.dox2
-rw-r--r--doc/eo_tutorial.dox8
-rw-r--r--doc/ephysics_examples.dox52
-rw-r--r--doc/index_elm.dox2
-rw-r--r--doc/main.dox17
7 files changed, 44 insertions, 92 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index db4e63cdb2..5b0711a390 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -666,7 +666,8 @@ EXCLUDE_PATTERNS = *_private* \
666 */efl_*.eo.c \ 666 */efl_*.eo.c \
667 */efl_*.eo.h \ 667 */efl_*.eo.h \
668 */efl_*.eot.h \ 668 */efl_*.eot.h \
669 */Efl_* 669 */Efl_* \
670 */Eo.h
670 671
671# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 672# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
672# (namespaces, classes, functions, etc.) that should be excluded from the 673# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -680,7 +681,8 @@ EXCLUDE_SYMBOLS = eo_cxx::*
680# directories that contain example code fragments that are included (see 681# directories that contain example code fragments that are included (see
681# the \include command). 682# the \include command).
682 683
683EXAMPLE_PATH = @top_srcdir@/src/examples 684EXAMPLE_PATH = @top_srcdir@/src/examples \
685 @top_srcdir@/src/tests
684 686
685# If the value of the EXAMPLE_PATH tag contains directories, you can use the 687# If the value of the EXAMPLE_PATH tag contains directories, you can use the
686# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 688# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -1325,18 +1327,6 @@ GENERATE_XML = NO
1325 1327
1326XML_OUTPUT = xml 1328XML_OUTPUT = xml
1327 1329
1328# The XML_SCHEMA tag can be used to specify an XML schema,
1329# which can be used by a validating XML parser to check the
1330# syntax of the XML files.
1331
1332XML_SCHEMA =
1333
1334# The XML_DTD tag can be used to specify an XML DTD,
1335# which can be used by a validating XML parser to check the
1336# syntax of the XML files.
1337
1338XML_DTD =
1339
1340# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1330# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1341# dump the program listings (including syntax highlighting 1331# dump the program listings (including syntax highlighting
1342# and cross-referencing information) to the XML output. Note that 1332# and cross-referencing information) to the XML output. Note that
diff --git a/doc/eina_examples.dox b/doc/eina_examples.dox
index ad7fcc6b2a..1eecc05408 100644
--- a/doc/eina_examples.dox
+++ b/doc/eina_examples.dox
@@ -49,41 +49,4 @@
49 * @li @ref tutorial_quadtree_page 49 * @li @ref tutorial_quadtree_page
50 * @li @ref tutorial_strbuf 50 * @li @ref tutorial_strbuf
51 * @li @ref tutorial_ustringshare_page 51 * @li @ref tutorial_ustringshare_page
52 *
53 * @example eina_accessor_01.c
54 * @example eina_array_01.c
55 * @example eina_array_02.c
56 * @example eina_error_01.c
57 * @example eina_file_01.c
58 * @example eina_hash_01.c
59 * @example eina_hash_02.c
60 * @example eina_hash_03.c
61 * @example eina_hash_04.c
62 * @example eina_hash_05.c
63 * @example eina_hash_06.c
64 * @example eina_hash_07.c
65 * @example eina_hash_08.c
66 * @example eina_inarray_01.c
67 * @example eina_inarray_02.c
68 * @example eina_inarray_03.c
69 * @example eina_inlist_01.c
70 * @example eina_inlist_02.c
71 * @example eina_inlist_03.c
72 * @example eina_iterator_01.c
73 * @example eina_list_01.c
74 * @example eina_list_02.c
75 * @example eina_list_03.c
76 * @example eina_list_04.c
77 * @example eina_log_01.c
78 * @example eina_log_02.c
79 * @example eina_log_03.c
80 * @example eina_magic_01.c
81 * @example eina_simple_xml_parser_01.c
82 * @example eina_str_01.c
83 * @example eina_strbuf_01.c
84 * @example eina_stringshare_01.c
85 * @example eina_tiler_01.c
86 * @example eina_value_01.c
87 * @example eina_value_02.c
88 * @example eina_value_03.c
89 */ 52 */
diff --git a/doc/elementary_examples.dox b/doc/elementary_examples.dox
index 76aa37e953..b705b1ac26 100644
--- a/doc/elementary_examples.dox
+++ b/doc/elementary_examples.dox
@@ -2750,7 +2750,7 @@
2750 * 2750 *
2751 * The both states and the item are using the same callback function, 2751 * The both states and the item are using the same callback function,
2752 * that will cycle between states and unselect the item. Unseleting 2752 * that will cycle between states and unselect the item. Unseleting
2753 * is required because it won't call the callback if an user clicks 2753 * is required because it won't call the callback if a user clicks
2754 * over an item already selected: 2754 * over an item already selected:
2755 * @dontinclude toolbar_example_02.c 2755 * @dontinclude toolbar_example_02.c
2756 * @skip static 2756 * @skip static
diff --git a/doc/eo_tutorial.dox b/doc/eo_tutorial.dox
index d8e7d7fb8d..1cf0a2ee12 100644
--- a/doc/eo_tutorial.dox
+++ b/doc/eo_tutorial.dox
@@ -120,11 +120,11 @@
120 * 120 *
121 * @section create_class_h_side How to create a class - H side? 121 * @section create_class_h_side How to create a class - H side?
122 * - If the object is new, establish the public APIs 122 * - If the object is new, establish the public APIs
123 * - #define \$(CLASS_NAME) \$(class_name)_class_get(): will be used to access data/inherit from this class... 123 * - \#define \$(CLASS_NAME) \$(class_name)_class_get(): will be used to access data/inherit from this class...
124 * - const Eo_Class *\$(class_name)_class_get(void) EINA_CONST: declaration of the function that will create the class (not the instance), i.e virtual table... 124 * - const Eo_Class *\$(class_name)_class_get(void) EINA_CONST: declaration of the function that will create the class (not the instance), i.e virtual table...
125 * - extern EAPI Eo_Op \$(CLASS_NAME)_BASE_ID: class id that will be essentially used to identify functions set of this class 125 * - EAPI extern Eo_Op \$(CLASS_NAME)_BASE_ID: class id that will be essentially used to identify functions set of this class
126 * - enum of the function ids of the class in the form \$(CLASS_NAME)_SUB_ID: used to identify the function inside the class; function id is unique per class but (class id, function id) is unique per system.. 126 * - enum of the function ids of the class in the form \$(CLASS_NAME)_SUB_ID: used to identify the function inside the class; function id is unique per class but (class id, function id) is unique per system..
127 * - #define \$(CLASS_NAME)_ID(sub_id) (\$(CLASS_NAME)_BASE_ID + sub_id): formula to calculate the system function id 127 * - \#define \$(CLASS_NAME)_ID(sub_id) (\$(CLASS_NAME)_BASE_ID + sub_id): formula to calculate the system function id
128 * - define of each function consists of: 128 * - define of each function consists of:
129 * - the name of the function that will be used in eo_do 129 * - the name of the function that will be used in eo_do
130 * - parameters without types 130 * - parameters without types
@@ -138,7 +138,7 @@
138 138
139 const Eo_Class *evas_object_line_class_get(void) EINA_CONST; 139 const Eo_Class *evas_object_line_class_get(void) EINA_CONST;
140 140
141 extern EAPI Eo_Op EVAS_OBJ_LINE_BASE_ID; 141 EAPI extern Eo_Op EVAS_OBJ_LINE_BASE_ID;
142 142
143 enum 143 enum
144 { 144 {
diff --git a/doc/ephysics_examples.dox b/doc/ephysics_examples.dox
index cddf3c8bdf..ba509b05f7 100644
--- a/doc/ephysics_examples.dox
+++ b/doc/ephysics_examples.dox
@@ -196,7 +196,7 @@
196/** 196/**
197 * @page test_bouncing_ball_c test_bouncing_ball.c 197 * @page test_bouncing_ball_c test_bouncing_ball.c
198 * 198 *
199 * @section ephysics-test-h ephysics_test.h 199 * # ephysics_test.h
200 * @include ephysics_test.h 200 * @include ephysics_test.h
201 * 201 *
202 * @section test-bouncing-ball-c test_bouncing_ball.c 202 * @section test-bouncing-ball-c test_bouncing_ball.c
@@ -271,7 +271,7 @@
271 /** 271 /**
272 * @page test_bouncing_text_c test_bouncing_text.c 272 * @page test_bouncing_text_c test_bouncing_text.c
273 * 273 *
274 * @section ephysics-test-h ephysics_test.h 274 * # ephysics_test.h
275 * @include ephysics_test.h 275 * @include ephysics_test.h
276 * 276 *
277 * @section test-bouncing_text-c test_bouncing_text.c 277 * @section test-bouncing_text-c test_bouncing_text.c
@@ -297,7 +297,7 @@
297 * The purpose of this example is to demonstrate the EPhysics_Camera usage. 297 * The purpose of this example is to demonstrate the EPhysics_Camera usage.
298 * 298 *
299 * The EPhysics_Camera facilitates the usage of scenarios bigger than the 299 * The EPhysics_Camera facilitates the usage of scenarios bigger than the
300 * viewport, thats because the EPhysics handles the position of objects 300 * viewport, that's because the EPhysics handles the position of objects
301 * which has control. 301 * which has control.
302 * 302 *
303 * @image html camera.png 303 * @image html camera.png
@@ -323,7 +323,7 @@
323 * @skip struct _Camera_Data { 323 * @skip struct _Camera_Data {
324 * @until }; 324 * @until };
325 * 325 *
326 * @section add-camera Adding a Camera 326 * # Adding a Camera
327 * 327 *
328 * To move the camera in this example, we'll use an animator. 328 * To move the camera in this example, we'll use an animator.
329 * 329 *
@@ -355,7 +355,7 @@
355 * @until ephysics_camera_position_set(camera, x, y 355 * @until ephysics_camera_position_set(camera, x, y
356 * @skipline } 356 * @skipline }
357 * 357 *
358 * @section add-uptfloor Updating the floor 358 * # Updating the floor
359 * 359 *
360 * Here we'll use 2 floor images to give the impression of an infinite ground. 360 * Here we'll use 2 floor images to give the impression of an infinite ground.
361 * 361 *
@@ -402,7 +402,7 @@
402 /** 402 /**
403 * @page test_camera_c test_camera.c 403 * @page test_camera_c test_camera.c
404 * 404 *
405 * @section ephysics-test-h ephysics_test.h 405 * # ephysics_test.h
406 * @include ephysics_test.h 406 * @include ephysics_test.h
407 * 407 *
408 * @section test-camera-c test_camera.c 408 * @section test-camera-c test_camera.c
@@ -426,7 +426,7 @@
426 * usage. 426 * usage.
427 * 427 *
428 * The EPhysics_Camera facilitates the usage of scenarios bigger than the 428 * The EPhysics_Camera facilitates the usage of scenarios bigger than the
429 * viewport, thats because the EPhysics handles the position of objects 429 * viewport, that's because the EPhysics handles the position of objects
430 * which has control. 430 * which has control.
431 * 431 *
432 * @image html camera_track.png 432 * @image html camera_track.png
@@ -454,7 +454,7 @@
454 * @skip struct _Track_Data { 454 * @skip struct _Track_Data {
455 * @until }; 455 * @until };
456 * 456 *
457 * @section add-camera Adding a Camera 457 * # Adding a Camera
458 * 458 *
459 * In this example we'll use 3 kinds of tracking, to change this values we'll 459 * In this example we'll use 3 kinds of tracking, to change this values we'll
460 * have an Elementary spinner widget and handle it on this function. 460 * have an Elementary spinner widget and handle it on this function.
@@ -480,7 +480,7 @@
480 * @skip ephysics_camera_body_track(camera, body 480 * @skip ephysics_camera_body_track(camera, body
481 * @until } 481 * @until }
482 * 482 *
483 * @section add-uptfloor Updating the floor 483 * # Updating the floor
484 * 484 *
485 * Here we'll use 2 floor images to give the impression of an infinite ground. 485 * Here we'll use 2 floor images to give the impression of an infinite ground.
486 * 486 *
@@ -536,7 +536,7 @@
536 /** 536 /**
537 * @page test_camera_track_c test_camera_track.c 537 * @page test_camera_track_c test_camera_track.c
538 * 538 *
539 * @section ephysics-test-h ephysics_test.h 539 * # ephysics_test.h
540 * @include ephysics_test.h 540 * @include ephysics_test.h
541 * 541 *
542 * @section test-camera-track-c test_camera_track.c 542 * @section test-camera-track-c test_camera_track.c
@@ -583,7 +583,7 @@
583 * @skip struct _Collision_Data { 583 * @skip struct _Collision_Data {
584 * @until }; 584 * @until };
585 * 585 *
586 * @section add-callbacks Adding the Callback 586 * # Adding the Callback
587 * 587 *
588 * Calling ephysics_body_event_callback_add() 588 * Calling ephysics_body_event_callback_add()
589 * will register a callback to a type of physics body event. 589 * will register a callback to a type of physics body event.
@@ -632,7 +632,7 @@
632 /** 632 /**
633 * @page test_collision_detection_c test_collision_detection.c 633 * @page test_collision_detection_c test_collision_detection.c
634 * 634 *
635 * @section ephysics-test-h ephysics_test.h 635 * # ephysics_test.h
636 * @include ephysics_test.h 636 * @include ephysics_test.h
637 * 637 *
638 * @section test-collision_detection-c test_collision_detection.c 638 * @section test-collision_detection-c test_collision_detection.c
@@ -671,7 +671,7 @@
671 * already covered in 671 * already covered in
672 * @ref tutorial_ephysics_bouncing_ball 672 * @ref tutorial_ephysics_bouncing_ball
673 * 673 *
674 * @section add-callbacks Adding the balls 674 * # Adding the balls
675 * @dontinclude test_collision_filter.c 675 * @dontinclude test_collision_filter.c
676 * 676 *
677 * We'll use two arrays (color and size) to distinguish the groups. 677 * We'll use two arrays (color and size) to distinguish the groups.
@@ -711,7 +711,7 @@
711 /** 711 /**
712 * @page test_collision_filter_c test_collision_filter.c 712 * @page test_collision_filter_c test_collision_filter.c
713 * 713 *
714 * @section ephysics-test-h ephysics_test.h 714 * # ephysics_test.h
715 * @include ephysics_test.h 715 * @include ephysics_test.h
716 * 716 *
717 * @section test-collision_filter-c test_collision_filter.c 717 * @section test-collision_filter-c test_collision_filter.c
@@ -748,7 +748,7 @@
748 * covered in 748 * covered in
749 * @ref tutorial_ephysics_bouncing_ball 749 * @ref tutorial_ephysics_bouncing_ball
750 * 750 *
751 * @section add-callbacks Adding Callbacks 751 * # Adding Callbacks
752 * @dontinclude test_delete.c 752 * @dontinclude test_delete.c
753 * 753 *
754 * Calling ephysics_body_event_callback_add() 754 * Calling ephysics_body_event_callback_add()
@@ -800,7 +800,7 @@
800 /** 800 /**
801 * @page test_delete_c test_delete.c 801 * @page test_delete_c test_delete.c
802 * 802 *
803 * @section ephysics-test-h ephysics_test.h 803 * # ephysics_test.h
804 * @include ephysics_test.h 804 * @include ephysics_test.h
805 * 805 *
806 * @section test-delete-c test_delete.c 806 * @section test-delete-c test_delete.c
@@ -858,7 +858,7 @@
858 /** 858 /**
859 * @page test_constraint_c test_constraint.c 859 * @page test_constraint_c test_constraint.c
860 * 860 *
861 * @section ephysics-test-h ephysics_test.h 861 * # ephysics_test.h
862 * @include ephysics_test.h 862 * @include ephysics_test.h
863 * 863 *
864 * @section test-constraint-c test_constraint.c 864 * @section test-constraint-c test_constraint.c
@@ -932,7 +932,7 @@
932 /** 932 /**
933 * @page test_forces_c test_forces.c 933 * @page test_forces_c test_forces.c
934 * 934 *
935 * @section ephysics-test-h ephysics_test.h 935 * # ephysics_test.h
936 * @include ephysics_test.h 936 * @include ephysics_test.h
937 * 937 *
938 * @section test-forces-c test_forces.c 938 * @section test-forces-c test_forces.c
@@ -998,7 +998,7 @@
998 /** 998 /**
999 * @page test_growing_balls_c test_growing_balls.c 999 * @page test_growing_balls_c test_growing_balls.c
1000 * 1000 *
1001 * @section ephysics-test-h ephysics_test.h 1001 * # ephysics_test.h
1002 * @include ephysics_test.h 1002 * @include ephysics_test.h
1003 * 1003 *
1004 * @section test-growing-balls-c test_growing_balls.c 1004 * @section test-growing-balls-c test_growing_balls.c
@@ -1069,7 +1069,7 @@
1069 /** 1069 /**
1070 * @page test_no_gravity_c test_no_gravity.c 1070 * @page test_no_gravity_c test_no_gravity.c
1071 * 1071 *
1072 * @section ephysics-test-h ephysics_test.h 1072 * # ephysics_test.h
1073 * @include ephysics_test.h 1073 * @include ephysics_test.h
1074 * 1074 *
1075 * @section test-no-gravity-c test_no_gravity.c 1075 * @section test-no-gravity-c test_no_gravity.c
@@ -1372,7 +1372,7 @@
1372 /** 1372 /**
1373 * @page test_rotating_forever_c test_rotating_forever.c 1373 * @page test_rotating_forever_c test_rotating_forever.c
1374 * 1374 *
1375 * @section ephysics-test-h ephysics_test.h 1375 * # ephysics_test.h
1376 * @include ephysics_test.h 1376 * @include ephysics_test.h
1377 * 1377 *
1378 * @section test-rotating-forever-c test_rotating_forever.c 1378 * @section test-rotating-forever-c test_rotating_forever.c
@@ -1417,7 +1417,7 @@
1417 * @skip struct _Velocity_Data { 1417 * @skip struct _Velocity_Data {
1418 * @until }; 1418 * @until };
1419 * 1419 *
1420 * @section add-callbacks Adding the Callbacks 1420 * # Adding the Callbacks
1421 * 1421 *
1422 * Calling ephysics_body_event_callback_add() 1422 * Calling ephysics_body_event_callback_add()
1423 * will register a callback to a type of physics body event. 1423 * will register a callback to a type of physics body event.
@@ -1491,7 +1491,7 @@
1491 /** 1491 /**
1492 * @page test_velocity_c test_velocity.c 1492 * @page test_velocity_c test_velocity.c
1493 * 1493 *
1494 * @section ephysics-test-h ephysics_test.h 1494 * # ephysics_test.h
1495 * @include ephysics_test.h 1495 * @include ephysics_test.h
1496 * 1496 *
1497 * @section test-velocity-c test_velocity.c 1497 * @section test-velocity-c test_velocity.c
@@ -1588,7 +1588,7 @@
1588 /** 1588 /**
1589 * @page test_shapes_c test_shapes.c 1589 * @page test_shapes_c test_shapes.c
1590 * 1590 *
1591 * @section ephysics-test-h ephysics_test.h 1591 * # ephysics_test.h
1592 * @include ephysics_test.h 1592 * @include ephysics_test.h
1593 * 1593 *
1594 * @section test-shapes-c test_shapes.c 1594 * @section test-shapes-c test_shapes.c
@@ -1673,7 +1673,7 @@
1673 /** 1673 /**
1674 * @page test_sleeping_threshold_c test_sleeping_threshold.c 1674 * @page test_sleeping_threshold_c test_sleeping_threshold.c
1675 * 1675 *
1676 * @section ephysics-test-h ephysics_test.h 1676 * # ephysics_test.h
1677 * @include ephysics_test.h 1677 * @include ephysics_test.h
1678 * 1678 *
1679 * @section test-sleeping-threshold-c test_sleeping_threshold.c 1679 * @section test-sleeping-threshold-c test_sleeping_threshold.c
@@ -1769,7 +1769,7 @@
1769 /** 1769 /**
1770 * @page test_slider_c test_slider.c 1770 * @page test_slider_c test_slider.c
1771 * 1771 *
1772 * @section ephysics-test-h ephysics_test.h 1772 * # ephysics_test.h
1773 * @include ephysics_test.h 1773 * @include ephysics_test.h
1774 * 1774 *
1775 * @section test-slider-c test_slider.c 1775 * @section test-slider-c test_slider.c
diff --git a/doc/index_elm.dox b/doc/index_elm.dox
index 759512f4cf..b85703fd5a 100644
--- a/doc/index_elm.dox
+++ b/doc/index_elm.dox
@@ -44,6 +44,8 @@
44 * 44 *
45 * @image html img/widget/actionslider/preview-00.png 45 * @image html img/widget/actionslider/preview-00.png
46 * @image latex img/widget/actionslider/preview-00.eps 46 * @image latex img/widget/actionslider/preview-00.eps
47 * @li @ref Elm_Animation_View
48 *
47 * @li @ref Elm_Bg 49 * @li @ref Elm_Bg
48 * 50 *
49 * @image html img/widget/bg/preview-00.png 51 * @image html img/widget/bg/preview-00.png
diff --git a/doc/main.dox b/doc/main.dox
index 46f3c4edca..fa47155886 100644
--- a/doc/main.dox
+++ b/doc/main.dox
@@ -23,7 +23,7 @@
23 * @li @ref eio_main asynchronous input/output 23 * @li @ref eio_main asynchronous input/output
24 * @li @ref eldbus_main D-Bus integration. 24 * @li @ref eldbus_main D-Bus integration.
25 * @li @ref embryo_main embedded script language. 25 * @li @ref embryo_main embedded script language.
26 * @li @ref eo_main generic object system. 26 * @li @ref eolian_main an EO file parser and code generator.
27 * 27 *
28 * <h3>Graphics libraries</h3> 28 * <h3>Graphics libraries</h3>
29 * 29 *
@@ -35,15 +35,6 @@
35 * @li @ref ethumb_main to generate thumbnail images of files. 35 * @li @ref ethumb_main to generate thumbnail images of files.
36 * @li @ref evas_main drawing canvas. 36 * @li @ref evas_main drawing canvas.
37 * 37 *
38 * <h3>Operating System specific libraries</h3>
39 *
40 * @li @ref escape_main playstation3 portability layer.
41 * @li @ref evil_main microsoft windows portability layer.
42 *
43 * <h3>Early stage libraries (BETA testing)</h3>
44 *
45 * @li @ref eolian_main an EO file parser and code generator.
46 *
47 * If you are looking for methods that do not fit into the above list you can 38 * If you are looking for methods that do not fit into the above list you can
48 * see the full <a href="modules.html" />module listing</a>. 39 * see the full <a href="modules.html" />module listing</a>.
49 */ 40 */
@@ -261,3 +252,9 @@
261 * 252 *
262 * @brief Physics simulation integration and visual effects. 253 * @brief Physics simulation integration and visual effects.
263 */ 254 */
255
256/**
257 * @defgroup Elementary Elementary
258 *
259 * @brief Widget library (See the @ref elementary_main main page).
260 */