ecore: modify documentation for ecore_thread_wait

Summary: this patch modify ecore_thread_wait documentation to use it only main llop explicitly.

Reviewers: segfaultxavi

Reviewed By: segfaultxavi

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D7225

diff --git a/src/lib/ecore/Ecore_Common.h b/src/lib/ecore/Ecore_Common.h
index 9a3ce92..498f380 100644 (file)
--- a/src/lib/ecore/Ecore_Common.h
+++ b/src/lib/ecore/Ecore_Common.h
@@ -1913,6 +1913,9 @@ EAPI Eina_Bool ecore_thread_cancel(Ecore_Thread *thread);
  * @param thread The thread to wait on.
  * @param wait Maximum time to wait before exiting anyway.
  * @return EINA_TRUE if the thread execution is over.
+ *
+ * Note: This function should only be called in the main loop.
+ *
  */
 EAPI Eina_Bool ecore_thread_wait(Ecore_Thread *thread, double wait);