ecore - add and fix links to examples on each module description.
authorRafael Antognolli <antognolli@gmail.com>
Mon, 4 Jul 2011 18:31:02 +0000 (18:31 +0000)
committerRafael Antognolli <antognolli@gmail.com>
Mon, 4 Jul 2011 18:31:02 +0000 (18:31 +0000)
SVN revision: 61014

legacy/ecore/doc/examples.dox
legacy/ecore/src/lib/ecore/Ecore.h
legacy/ecore/src/lib/ecore/ecore_idler.c
legacy/ecore/src/lib/ecore/ecore_job.c
legacy/ecore/src/lib/ecore/ecore_main.c
legacy/ecore/src/lib/ecore/ecore_poll.c
legacy/ecore/src/lib/ecore/ecore_timer.c

index b2437d7..49ce553 100644 (file)
@@ -44,7 +44,7 @@
  */
 
 /**
- * @page ecore_timer_example_c ecore timers - Timed events
+ * @page ecore_timer_example_c ecore timers - Scheduled events
  * @dontinclude ecore_timer_example.c
  *
  * This example shows how to setup timer callbacks. It starts a timer that will
  * @until }
  *
  * @example ecore_pipe_simple_example.c
- */
\ No newline at end of file
+ */
index 2c99571..c494c59 100644 (file)
@@ -315,7 +315,7 @@ extern "C" {
    * Time functions are covered in @ref Ecore_Time_Group.
    *
    * There is also provision for callbacks for when the loop enters or
-   * exits an idle state. See @ref Idle_Group for more information.
+   * exits an idle state. See @ref Ecore_Idle_Group for more information.
    *
    * Functions are also provided for spawning child processes using fork.
    * See @ref Ecore_Exe_Group for more details.
index 0a056b3..af43c31 100644 (file)
@@ -62,6 +62,10 @@ else to process (which in most <em>event driven</em> programs also means that th
 program is idle too, but it's not a rule). The program itself may be doing a lot of
 processing in the idler, or in another thread, for example.
 
+Example with functions that deal with idle state:
+
+@li @ref ecore_idler_example_c
+
  * @{
  */
 
index 1a95af6..446547b 100644 (file)
@@ -56,6 +56,9 @@ _ecore_job_shutdown(void)
  * added before yours, they will be processed first). This also gives the chance
  * to other actions in your program to cancel the job before it is started.
  *
+ * Examples of using @ref Ecore_Job:
+ * @li @ref ecore_job_example_c
+ *
  * @{
  */
 
index 42de761..d2521ec 100644 (file)
@@ -776,6 +776,9 @@ ecore_main_loop_select_func_get(void)
  * @defgroup Ecore_FD_Handler_Group File Event Handling Functions
  *
  * Functions that deal with file descriptor handlers.
+ *
+ * Examples with functions that deal with file descriptor handlers:
+ * @li @ref ecore_fd_handler_example_c
  */
 
 /**
index cbf804a..d1ff9ac 100644 (file)
@@ -204,6 +204,9 @@ _ecore_poller_cb_timer(void *data __UNUSED__)
  * polling happens in as few spots as possible areound a core poll interval.
  * For now only 1 core poller type is supprted: ECORE_POLLER_CORE
  *
+ * Example of @ref Ecore_Poller:
+ * @li @ref ecore_poller_example_c
+ *
  * @{
  */
 
index a9758a0..fd4997c 100644 (file)
@@ -63,7 +63,8 @@ static double       precision = 10.0 / 1000000.0;
  * The timer allows callbacks to be called at specific intervals.
  *
  * Examples with functions that deal with time:
- * @li @ref ecore_time_example_c
+ * @li @ref ecore_time_functions_example_c
+ * @li @ref ecore_timer_example_c
  *
  * @{
  */