summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore/ecore_poll.c
diff options
context:
space:
mode:
authorVincent Torri <vincent.torri@gmail.com>2010-10-17 07:03:28 +0000
committerVincent Torri <vincent.torri@gmail.com>2010-10-17 07:03:28 +0000
commita17c58d0b0ddfc8d4b6e3852aeaf82a94b3810eb (patch)
treef86af3959dfb1bbf0511187a42c511177ef19b71 /legacy/ecore/src/lib/ecore/ecore_poll.c
parent58f5409b49181872159ef3bf1abd5fa39806d2f2 (diff)
improve doc layout
SVN revision: 53509
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore/ecore_poll.c24
1 files changed, 17 insertions, 7 deletions
diff --git a/legacy/ecore/src/lib/ecore/ecore_poll.c b/legacy/ecore/src/lib/ecore/ecore_poll.c
index d5bc6badf5..cbf804a74c 100644
--- a/legacy/ecore/src/lib/ecore/ecore_poll.c
+++ b/legacy/ecore/src/lib/ecore/ecore_poll.c
@@ -191,12 +191,20 @@ _ecore_poller_cb_timer(void *data __UNUSED__)
191} 191}
192 192
193/** 193/**
194 * @defgroup Ecore_Poll_Group Ecore Poll Functions 194 * @addtogroup Ecore_Group Ecore - Main Loop and Job Functions.
195 *
196 * @{
197 */
198
199/**
200 * @addtogroup Ecore_Poller_Group Ecore Poll functions
195 * 201 *
196 * These functions are for the need to poll information, but provide a shared 202 * These functions are for the need to poll information, but provide a shared
197 * abstracted API to pool such polling to minimise wakeup and ensure all the 203 * abstracted API to pool such polling to minimise wakeup and ensure all the
198 * polling happens in as few spots as possible areound a core poll interval. 204 * polling happens in as few spots as possible areound a core poll interval.
199 * For now only 1 core poller type is supprted: ECORE_POLLER_CORE 205 * For now only 1 core poller type is supprted: ECORE_POLLER_CORE
206 *
207 * @{
200 */ 208 */
201 209
202 210
@@ -204,7 +212,6 @@ _ecore_poller_cb_timer(void *data __UNUSED__)
204 * Sets the time between ticks (in seconds) for the given ticker clock. 212 * Sets the time between ticks (in seconds) for the given ticker clock.
205 * @param type The ticker type to adjust 213 * @param type The ticker type to adjust
206 * @param poll_time The time (in seconds) between ticks of the clock 214 * @param poll_time The time (in seconds) between ticks of the clock
207 * @ingroup Ecore_Poller_Group
208 * 215 *
209 * This will adjust the time between ticks of the given ticker type defined 216 * This will adjust the time between ticks of the given ticker type defined
210 * by @p type to the time period defined by @p poll_time. 217 * by @p type to the time period defined by @p poll_time.
@@ -220,7 +227,6 @@ ecore_poller_poll_interval_set(Ecore_Poller_Type type __UNUSED__, double poll_ti
220 * Gets the time between ticks (in seconds) for the given ticker clock. 227 * Gets the time between ticks (in seconds) for the given ticker clock.
221 * @param type The ticker type to query 228 * @param type The ticker type to query
222 * @return The time in seconds between ticks of the ticker clock 229 * @return The time in seconds between ticks of the ticker clock
223 * @ingroup Ecore_Poller_Group
224 * 230 *
225 * This will get the time between ticks of the specifider ticker clock. 231 * This will get the time between ticks of the specifider ticker clock.
226 */ 232 */
@@ -238,7 +244,6 @@ ecore_poller_poll_interval_get(Ecore_Poller_Type type __UNUSED__)
238 * rescheduled for the next tick interval. 244 * rescheduled for the next tick interval.
239 * @param data Data to pass to @p func when it is called. 245 * @param data Data to pass to @p func when it is called.
240 * @return A poller object on success. @c NULL on failure. 246 * @return A poller object on success. @c NULL on failure.
241 * @ingroup Ecore_Poller_Group
242 * 247 *
243 * This function adds a poller callback that is to be called regularly 248 * This function adds a poller callback that is to be called regularly
244 * along with all other poller callbacks so the pollers are synchronized with 249 * along with all other poller callbacks so the pollers are synchronized with
@@ -320,7 +325,6 @@ ecore_poller_add(Ecore_Poller_Type type __UNUSED__, int interval, Ecore_Task_Cb
320 * 325 *
321 * This allows the changing of a poller's polling interval. It is useful when you want to alter 326 * This allows the changing of a poller's polling interval. It is useful when you want to alter
322 * a poll rate without deleting and re-creating a poller. 327 * a poll rate without deleting and re-creating a poller.
323 * @ingroup Ecore_Poller_Group
324 */ 328 */
325EAPI Eina_Bool 329EAPI Eina_Bool
326ecore_poller_poller_interval_set(Ecore_Poller *poller, int interval) 330ecore_poller_poller_interval_set(Ecore_Poller *poller, int interval)
@@ -364,7 +368,6 @@ ecore_poller_poller_interval_set(Ecore_Poller *poller, int interval)
364 * @return Returns the interval, in ticks, that @p poller polls at 368 * @return Returns the interval, in ticks, that @p poller polls at
365 * 369 *
366 * This returns a poller's polling interval, or 0 on error. 370 * This returns a poller's polling interval, or 0 on error.
367 * @ingroup Ecore_Poller_Group
368 */ 371 */
369EAPI int 372EAPI int
370ecore_poller_poller_interval_get(Ecore_Poller *poller) 373ecore_poller_poller_interval_get(Ecore_Poller *poller)
@@ -392,7 +395,6 @@ ecore_poller_poller_interval_get(Ecore_Poller *poller)
392 * @param poller The poller to delete. 395 * @param poller The poller to delete.
393 * @return The data pointer set for the timer when @ref ecore_poller_add was 396 * @return The data pointer set for the timer when @ref ecore_poller_add was
394 * called. @c NULL is returned if the function is unsuccessful. 397 * called. @c NULL is returned if the function is unsuccessful.
395 * @ingroup Ecore_Poller_Group
396 * 398 *
397 * Note: @p poller must be a valid handle. If the poller function has already 399 * Note: @p poller must be a valid handle. If the poller function has already
398 * returned 0, the handle is no longer valid (and does not need to be delete). 400 * returned 0, the handle is no longer valid (and does not need to be delete).
@@ -425,6 +427,14 @@ ecore_poller_del(Ecore_Poller *poller)
425 return data; 427 return data;
426} 428}
427 429
430/**
431 * @}
432 */
433
434/**
435 * @}
436 */
437
428void 438void
429_ecore_poller_shutdown(void) 439_ecore_poller_shutdown(void)
430{ 440{