Diagrams for Ecore_Thread

SVN revision: 61507

legacy/ecore/src/lib/ecore/Ecore.h

@@ -821,11 +821,27 @@ extern "C" {
    * a thread as soon as one becomes available and notify the calling user of
    * its completion once the task is done.
    *
+   * The following image shows the flow of a program running four tasks on
+   * a pool of two threads.
+   *
+   * @image html ecore_thread.png
+   * @image rtf ecore_thread.png
+   * @image latex ecore_thread.eps width=\textwidth
+   *
    * For larger tasks that may require continuous communication with the main
    * program, the feedback workers provide the same functionality plus a way
    * for the function running in the thread to send messages to the main
    * thread.
    *
+   * The next diagram omits some details shown in the previous one regarding
+   * how threads are spawned and tasks are queued, but illustrates how feedback
+   * jobs communicate with the main loop and the special case of threads
+   * running out of pool.
+   *
+   * @image html ecore_thread_feedback.png
+   * @image rtf ecore_thread_feedback.png
+   * @image latex ecore_thread_feedback.eps width=\textwidth
+   *
    * See an overview example in @ref ecore_thread_example_c.
    *
    * @ingroup Ecore_Group