summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore/ecore_main.c
diff options
context:
space:
mode:
authorGustavo Lima Chaves <glima@profusion.mobi>2011-08-10 19:14:48 +0000
committerGustavo Lima Chaves <glima@profusion.mobi>2011-08-10 19:14:48 +0000
commit0603a5cf5088cb57a8babdf09da48dfc10357105 (patch)
treebc8c09eb66743caca870cc236cdddb01cc56d21f /legacy/ecore/src/lib/ecore/ecore_main.c
parent68ecfd8183fcfd5b276ac268c2f4a4d2db3cbf5f (diff)
[ecore] Put order in header file, splitting function groups in contiguous chunks.
Sorry for having to pratically rewrite the header, but the other way to get docs right would be to put lots of @addtogroup around several chunks of the file, which is ugly too and doesn't organize anything. I have tested ecore with that and it seems to be okay. SVN revision: 62307
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore/ecore_main.c51
1 files changed, 1 insertions, 50 deletions
diff --git a/legacy/ecore/src/lib/ecore/ecore_main.c b/legacy/ecore/src/lib/ecore/ecore_main.c
index 688c2c5895..edce31d8a3 100644
--- a/legacy/ecore/src/lib/ecore/ecore_main.c
+++ b/legacy/ecore/src/lib/ecore/ecore_main.c
@@ -790,29 +790,7 @@ _ecore_main_loop_shutdown(void)
790} 790}
791 791
792/** 792/**
793 * @addtogroup Ecore_Group Ecore - Main Loop and Job Functions. 793 * @addtogroup Ecore_Main_Loop_Group
794 *
795 * @{
796 */
797
798/**
799 * @addtogroup Ecore_Main_Loop_Group Ecore Main Loop functions
800 *
801 * These functions control the Ecore event handling loop. This loop is
802 * designed to work on embedded systems all the way to large and
803 * powerful mutli-cpu workstations.
804 *
805 * It serialises all system signals and events into a single event
806 * queue, that can be easily processed without needing to worry about
807 * concurrency. A properly written, event-driven program using this
808 * kind of programming does not need threads. It makes the program very
809 * robust and easy to follow.
810 *
811 * Here is an example of simple program and its basic event loop flow:
812 * @image html prog_flow.png
813 *
814 * For examples of setting up and using a main loop, see @ref
815 * Ecore_Main_Loop_Page.
816 * 794 *
817 * @{ 795 * @{
818 */ 796 */
@@ -918,29 +896,6 @@ ecore_main_loop_select_func_get(void)
918} 896}
919 897
920/** 898/**
921 * @defgroup Ecore_FD_Handler_Group File Event Handling Functions
922 *
923 * Functions that deal with file descriptor handlers.
924 *
925 * The @ref Ecore_Fd_Handler can be used to watch a file descriptor for data
926 * available for reading, for the availability to write without blocking, and
927 * for errors on the file descriptor.
928 *
929 * ecore_main_fd_handler_add() is used to setup a handler for a given file
930 * descriptor. This file descriptor can be the standard input, a network socket,
931 * a stream received through some driver of a hardware decoder, etc. Thus it can
932 * contain errors, like a disconnection, a broken pipe, and so, and that's why
933 * it's possible to check for these errors with the @ref ECORE_FD_ERROR flag.
934 *
935 * An @ref Ecore_Fd_Handler can be used to watch on a file descriptor without
936 * blocking, still being able to receive events, expire timers, and other watch
937 * for other things that happen in the Ecore main loop.
938 *
939 * Example of use of a file descriptor handler:
940 * @li @ref ecore_fd_handler_example_c
941 */
942
943/**
944 * Adds a callback for activity on the given file descriptor. 899 * Adds a callback for activity on the given file descriptor.
945 * 900 *
946 * @p func will be called during the execution of @ref ecore_main_loop_begin 901 * @p func will be called during the execution of @ref ecore_main_loop_begin
@@ -1236,10 +1191,6 @@ unlock:
1236 * @} 1191 * @}
1237 */ 1192 */
1238 1193
1239/**
1240 * @}
1241 */
1242
1243void 1194void
1244_ecore_main_shutdown(void) 1195_ecore_main_shutdown(void)
1245{ 1196{