summaryrefslogtreecommitdiff
path: root/src/lib/ecore/Ecore_Legacy.h
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-13 15:29:01 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-02-13 19:54:29 +0900
commite4b37d7cb41e005accf2703ec34a9002f14dc4bb (patch)
tree34d866c6810e11dce81b5ad00fbc3474247a422c /src/lib/ecore/Ecore_Legacy.h
parentc2e1eb7c54fbf2bc6848d727e78b85dafe2bbbeb (diff)
doxygen: Fix typos & invalid statements in Ecore_Getopt and Ecore_Legacy
Summary: There are some typos and calogique statements in doxygen of Ecore_Getopt and Ecore_Legacy so I had fixed typos and cacologique statements. Test Plan: Doxygen revision Reviewers: stefan, cedric, raster, Jaehyun_Cho Subscribers: jpeg, conr2d Differential Revision: https://phab.enlightenment.org/D4651
Diffstat (limited to '')
-rw-r--r--src/lib/ecore/Ecore_Legacy.h104
1 files changed, 52 insertions, 52 deletions
diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h
index 3db194a074..f596b40873 100644
--- a/src/lib/ecore/Ecore_Legacy.h
+++ b/src/lib/ecore/Ecore_Legacy.h
@@ -30,21 +30,21 @@ extern "C" {
30 * closest power of 2 greater than @a interval will be used. 30 * closest power of 2 greater than @a interval will be used.
31 * 31 *
32 * When the poller @p func is called, it must return a value of either 32 * When the poller @p func is called, it must return a value of either
33 * ECORE_CALLBACK_RENEW(or 1) or ECORE_CALLBACK_CANCEL(or 0). If it 33 * @c ECORE_CALLBACK_RENEW(or @c 1) or @c ECORE_CALLBACK_CANCEL(or @c 0). If it
34 * returns 1, it will be called again at the next tick, or if it returns 34 * returns @c 1, it will be called again at the next tick, or if it returns
35 * 0 it will be deleted automatically making any references/handles for it 35 * @c 0 it will be deleted automatically making any references/handles for it
36 * invalid. 36 * invalid.
37 */ 37 */
38EAPI Ecore_Poller *ecore_poller_add(Ecore_Poller_Type type, int interval, Ecore_Task_Cb func, const void *data); 38EAPI Ecore_Poller *ecore_poller_add(Ecore_Poller_Type type, int interval, Ecore_Task_Cb func, const void *data);
39 39
40/** 40/**
41 * @brief Delete the specified poller from the timer list. 41 * @brief Deletes the specified poller from the timer list.
42 * @param poller The poller to delete. 42 * @param poller The poller to delete.
43 * @return The data pointer set for the timer when @ref ecore_poller_add was 43 * @return The data pointer set for the timer when @ref ecore_poller_add was
44 * called on success, @c NULL otherwise. 44 * called on success, @c NULL otherwise.
45 * 45 *
46 * @note @a poller must be a valid handle. If the poller function has already 46 * @note @a poller must be a valid handle. If the poller function has already
47 * returned 0, the handle is no longer valid (and does not need to be deleted). 47 * returned @c 0, the handle is no longer valid (and does not need to be deleted).
48 */ 48 */
49EAPI void *ecore_poller_del(Ecore_Poller *poller); 49EAPI void *ecore_poller_del(Ecore_Poller *poller);
50 50
@@ -80,7 +80,7 @@ EAPI double ecore_poller_poll_interval_get(Ecore_Poller_Type type);
80typedef struct _Ecore_Animator Ecore_Animator; 80typedef struct _Ecore_Animator Ecore_Animator;
81 81
82/** 82/**
83 * @brief Add an animator to call @p func at every animation tick during main 83 * @brief Adds an animator to call @p func at every animation tick during main
84 * loop execution. 84 * loop execution.
85 * 85 *
86 * @param func The function to call when it ticks off 86 * @param func The function to call when it ticks off
@@ -93,19 +93,19 @@ typedef struct _Ecore_Animator Ecore_Animator;
93 * function will be passed the @p data pointer as its parameter. 93 * function will be passed the @p data pointer as its parameter.
94 * 94 *
95 * When the animator @p func is called, it must return a boolean value. 95 * When the animator @p func is called, it must return a boolean value.
96 * If it returns EINA_TRUE (or ECORE_CALLBACK_RENEW), it will be called again at 96 * If it returns @c EINA_TRUE (or @c ECORE_CALLBACK_RENEW), it will be called again at
97 * the next tick, or if it returns EINA_FALSE (or ECORE_CALLBACK_CANCEL) it will be 97 * the next tick, or if it returns @c EINA_FALSE (or @c ECORE_CALLBACK_CANCEL) it will be
98 * deleted automatically making any references/handles for it invalid. 98 * deleted automatically making any references/handles for it invalid.
99 * @see ecore_animator_timeline_add()
100 * @see ecore_animator_frametime_set()
99 * 101 *
100 * @note The default @p frametime value is 1/30th of a second. 102 * @note The default @p frametime value is 1/30th of a second.
101 * 103 *
102 * @see ecore_animator_timeline_add()
103 * @see ecore_animator_frametime_set()
104 */ 104 */
105EAPI Ecore_Animator *ecore_animator_add(Ecore_Task_Cb func, const void *data); 105EAPI Ecore_Animator *ecore_animator_add(Ecore_Task_Cb func, const void *data);
106 106
107/** 107/**
108 * @brief Add an animator that runs for a limited time 108 * @brief Adds an animator that runs for a limited time.
109 * 109 *
110 * @param runtime The time to run in seconds 110 * @param runtime The time to run in seconds
111 * @param func The function to call when it ticks off 111 * @param func The function to call when it ticks off
@@ -115,8 +115,8 @@ EAPI Ecore_Animator *ecore_animator_add(Ecore_Task_Cb func, const void *data);
115 * This function is just like ecore_animator_add() except the animator only 115 * This function is just like ecore_animator_add() except the animator only
116 * runs for a limited time specified in seconds by @p runtime. Once the 116 * runs for a limited time specified in seconds by @p runtime. Once the
117 * runtime the animator has elapsed (animator finished) it will automatically 117 * runtime the animator has elapsed (animator finished) it will automatically
118 * be deleted. The callback function @p func can return ECORE_CALLBACK_RENEW 118 * be deleted. The callback function @p func can return @c ECORE_CALLBACK_RENEW
119 * to keep the animator running or ECORE_CALLBACK_CANCEL ro stop it and have 119 * to keep the animator running or @c ECORE_CALLBACK_CANCEL ro stop it and have
120 * it be deleted automatically at any time. 120 * it be deleted automatically at any time.
121 * 121 *
122 * The @p func will ALSO be passed a position parameter that will be in value 122 * The @p func will ALSO be passed a position parameter that will be in value
@@ -124,22 +124,22 @@ EAPI Ecore_Animator *ecore_animator_add(Ecore_Task_Cb func, const void *data);
124 * the animator run is at. If the callback wishes not to have a linear 124 * the animator run is at. If the callback wishes not to have a linear
125 * transition it can "map" this value to one of several curves and mappings 125 * transition it can "map" this value to one of several curves and mappings
126 * via ecore_animator_pos_map(). 126 * via ecore_animator_pos_map().
127 * @see ecore_animator_add()
128 * @see ecore_animator_pos_map()
127 * 129 *
128 * @note The default @p frametime value is 1/30th of a second. 130 * @note The default @p frametime value is 1/30th of a second.
129 * 131 *
130 * @see ecore_animator_add()
131 * @see ecore_animator_pos_map()
132 * @since 1.1.0 132 * @since 1.1.0
133 */ 133 */
134EAPI Ecore_Animator *ecore_animator_timeline_add(double runtime, Ecore_Timeline_Cb func, const void *data); 134EAPI Ecore_Animator *ecore_animator_timeline_add(double runtime, Ecore_Timeline_Cb func, const void *data);
135 135
136/** 136/**
137 * @brief Delete the specified animator from the animator list. 137 * @brief Deletes the specified animator from the animator list.
138 * 138 *
139 * @param animator The animator to delete 139 * @param animator The animator to delete
140 * @return The data pointer set for the animator on add 140 * @return The data pointer set for the animator on add
141 * 141 *
142 * Delete the specified @p animator from the set of animators that are 142 * Deletes the specified @p animator from the set of animators that are
143 * executed during main loop execution. This function returns the data 143 * executed during main loop execution. This function returns the data
144 * parameter that was being passed to the callback on success, or @c NULL on 144 * parameter that was being passed to the callback on success, or @c NULL on
145 * failure. After this call returns the specified animator object @p animator 145 * failure. After this call returns the specified animator object @p animator
@@ -149,7 +149,7 @@ EAPI Ecore_Animator *ecore_animator_timeline_add(double runtime, Ecore_Timeline_
149EAPI void *ecore_animator_del(Ecore_Animator *animator); 149EAPI void *ecore_animator_del(Ecore_Animator *animator);
150 150
151/** 151/**
152 * @brief Suspend the specified animator. 152 * @brief Suspends the specified animator.
153 * 153 *
154 * @param animator The animator to delete 154 * @param animator The animator to delete
155 * 155 *
@@ -165,7 +165,7 @@ EAPI void *ecore_animator_del(Ecore_Animator *animator);
165EAPI void ecore_animator_freeze(Ecore_Animator *animator); 165EAPI void ecore_animator_freeze(Ecore_Animator *animator);
166 166
167/** 167/**
168 * @brief Restore execution of the specified animator. 168 * @brief Restores execution of the specified animator.
169 * 169 *
170 * @param animator The animator to delete 170 * @param animator The animator to delete
171 * 171 *
@@ -187,19 +187,19 @@ EAPI void ecore_animator_thaw(Ecore_Animator *animator);
187/** 187/**
188 * Creates a timer to call the given function in the given period of time. 188 * Creates a timer to call the given function in the given period of time.
189 * @param in The interval in seconds. 189 * @param in The interval in seconds.
190 * @param func The given function. If @p func returns 1, the timer is 190 * @param func The given function. If @p func returns @c 1, the timer is
191 * rescheduled for the next interval @p in. 191 * rescheduled for the next interval @p in.
192 * @param data Data to pass to @p func when it is called. 192 * @param data Data to pass to @p func when it is called.
193 * @return A timer object on success. @c NULL on failure. 193 * @return A timer object on success, @c NULL on failure.
194 * 194 *
195 * This function adds a timer and returns its handle on success and NULL on 195 * This function adds a timer and returns its handle on success and @c NULL on
196 * failure. The function @p func will be called every @p in seconds. The 196 * failure. The function @p func will be called every @p in seconds. The
197 * function will be passed the @p data pointer as its parameter. 197 * function will be passed the @p data pointer as its parameter.
198 * 198 *
199 * When the timer @p func is called, it must return a value of either 1 199 * When the timer @p func is called, it must return a value of either @c 1
200 * (or ECORE_CALLBACK_RENEW) or 0 (or ECORE_CALLBACK_CANCEL). 200 * (or @c ECORE_CALLBACK_RENEW) or @c 0 (or @c ECORE_CALLBACK_CANCEL).
201 * If it returns 1, it will be called again at the next tick, or if it returns 201 * If it returns @c 1, it will be called again at the next tick, or if it returns
202 * 0 it will be deleted automatically making any references/handles for it 202 * @c 0 it will be deleted automatically making any references/handles for it
203 * invalid. 203 * invalid.
204 */ 204 */
205EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *data); 205EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *data);
@@ -210,7 +210,7 @@ EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *dat
210 * @param func The given function. If @p func returns 1, the timer is 210 * @param func The given function. If @p func returns 1, the timer is
211 * rescheduled for the next interval @p in. 211 * rescheduled for the next interval @p in.
212 * @param data Data to pass to @p func when it is called. 212 * @param data Data to pass to @p func when it is called.
213 * @return A timer object on success. @c NULL on failure. 213 * @return A timer object on success, @c NULL on failure.
214 * 214 *
215 * This is the same as ecore_timer_add(), but "now" is the time from 215 * This is the same as ecore_timer_add(), but "now" is the time from
216 * ecore_loop_time_get() not ecore_time_get() as ecore_timer_add() uses. See 216 * ecore_loop_time_get() not ecore_time_get() as ecore_timer_add() uses. See
@@ -219,13 +219,13 @@ EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *dat
219EAPI Ecore_Timer *ecore_timer_loop_add(double in, Ecore_Task_Cb func, const void *data); 219EAPI Ecore_Timer *ecore_timer_loop_add(double in, Ecore_Task_Cb func, const void *data);
220 220
221/** 221/**
222 * Delete the specified timer from the timer list. 222 * Deletes the specified timer from the timer list.
223 * @param timer The timer to delete. 223 * @param timer The timer to delete.
224 * @return The data pointer set for the timer when @ref ecore_timer_add was 224 * @return The data pointer set for the timer when @ref ecore_timer_add was
225 * called. @c NULL is returned if the function is unsuccessful. 225 * called. @c NULL is returned if the function is unsuccessful.
226 * 226 *
227 * Note: @p timer must be a valid handle. If the timer function has already 227 * Note: @p timer must be a valid handle. If the timer function has already
228 * returned 0, the handle is no longer valid (and does not need to be delete). 228 * returned @c 0, the handle is no longer valid (and does not need to be delete).
229 */ 229 */
230EAPI void *ecore_timer_del(Ecore_Timer *timer); 230EAPI void *ecore_timer_del(Ecore_Timer *timer);
231 231
@@ -248,7 +248,7 @@ EAPI void ecore_timer_thaw(Ecore_Timer *timer);
248 */ 248 */
249 249
250/** 250/**
251 * Add an idler handler. 251 * Adds an idler handler.
252 * @param func The function to call when idling. 252 * @param func The function to call when idling.
253 * @param data The data to be passed to this @p func call. 253 * @param data The data to be passed to this @p func call.
254 * @return A idler handle if successfully added, @c NULL otherwise. 254 * @return A idler handle if successfully added, @c NULL otherwise.
@@ -256,15 +256,15 @@ EAPI void ecore_timer_thaw(Ecore_Timer *timer);
256 * Add an idler handle to the event loop, returning a handle on 256 * Add an idler handle to the event loop, returning a handle on
257 * success and @c NULL otherwise. The function @p func will be called 257 * success and @c NULL otherwise. The function @p func will be called
258 * repeatedly while no other events are ready to be processed, as 258 * repeatedly while no other events are ready to be processed, as
259 * long as it returns @c 1 (or ECORE_CALLBACK_RENEW). A return of @c 0 259 * long as it returns @c 1 (or @c ECORE_CALLBACK_RENEW). A return of @c 0
260 * (or ECORE_CALLBACK_CANCEL) deletes the idler. 260 * (or @c ECORE_CALLBACK_CANCEL) deletes the idler.
261 * 261 *
262 * Idlers are useful for progressively processing data without blocking. 262 * Idlers are useful for progressively processing data without blocking.
263 */ 263 */
264EAPI Ecore_Idler *ecore_idler_add(Ecore_Task_Cb func, const void *data); 264EAPI Ecore_Idler *ecore_idler_add(Ecore_Task_Cb func, const void *data);
265 265
266/** 266/**
267 * Delete an idler callback from the list to be executed. 267 * Deletes an idler callback from the list to be executed.
268 * @param idler The handle of the idler callback to delete 268 * @param idler The handle of the idler callback to delete
269 * @return The data pointer passed to the idler callback on success, @c NULL 269 * @return The data pointer passed to the idler callback on success, @c NULL
270 * otherwise. 270 * otherwise.
@@ -272,53 +272,53 @@ EAPI Ecore_Idler *ecore_idler_add(Ecore_Task_Cb func, const void *data);
272EAPI void *ecore_idler_del(Ecore_Idler *idler); 272EAPI void *ecore_idler_del(Ecore_Idler *idler);
273 273
274/** 274/**
275 * Add an idle enterer handler. 275 * Adds an idle enterer handler.
276 * @param func The function to call when entering an idle state. 276 * @param func The function to call when entering an idle state.
277 * @param data The data to be passed to the @p func call 277 * @param data The data to be passed to the @p func call
278 * @return A handle to the idle enterer callback if successful. Otherwise, 278 * @return A handle to the idle enterer callback if successful. Otherwise,
279 * NULL is returned. 279 * @c NULL is returned.
280 * @note The function func will be called every time the main loop is entering 280 * @note The function func will be called every time the main loop is entering
281 * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0 281 * idle state, as long as it returns @c 1 (or @c ECORE_CALLBACK_RENEW). A return of @c 0
282 * (or ECORE_CALLBACK_CANCEL) deletes the idle enterer. 282 * (or @c ECORE_CALLBACK_CANCEL) deletes the idle enterer.
283 */ 283 */
284EAPI Ecore_Idle_Enterer *ecore_idle_enterer_add(Ecore_Task_Cb func, const void *data); 284EAPI Ecore_Idle_Enterer *ecore_idle_enterer_add(Ecore_Task_Cb func, const void *data);
285 285
286/** 286/**
287 * Add an idle enterer handler at the start of the list so it gets called earlier than others. 287 * Adds an idle enterer handler at the start of the list so it gets called earlier than others.
288 * @param func The function to call when entering an idle state. 288 * @param func The function to call when entering an idle state.
289 * @param data The data to be passed to the @p func call 289 * @param data The data to be passed to the @p func call
290 * @return A handle to the idle enterer callback if successful. Otherwise, 290 * @return A handle to the idle enterer callback if successful. Otherwise,
291 * NULL is returned. 291 * @c NULL is returned.
292 * @note The function func will be called every time the main loop is entering 292 * @note The function func will be called every time the main loop is entering
293 * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0 293 * idle state, as long as it returns @c 1 (or @c ECORE_CALLBACK_RENEW). A return of @c 0
294 * (or ECORE_CALLBACK_CANCEL) deletes the idle enterer. 294 * (or @c ECORE_CALLBACK_CANCEL) deletes the idle enterer.
295 */ 295 */
296EAPI Ecore_Idle_Enterer *ecore_idle_enterer_before_add(Ecore_Task_Cb func, const void *data); 296EAPI Ecore_Idle_Enterer *ecore_idle_enterer_before_add(Ecore_Task_Cb func, const void *data);
297 297
298/** 298/**
299 * Delete an idle enterer callback. 299 * Deletes an idle enterer callback.
300 * @param idle_enterer The idle enterer to delete 300 * @param idle_enterer The idle enterer to delete
301 * @return The data pointer passed to the idler enterer callback on success. 301 * @return The data pointer passed to the idler enterer callback on success.
302 * NULL otherwise. 302 * @c NULL otherwise.
303 */ 303 */
304EAPI void *ecore_idle_enterer_del(Ecore_Idle_Enterer *idle_enterer); 304EAPI void *ecore_idle_enterer_del(Ecore_Idle_Enterer *idle_enterer);
305 305
306/** 306/**
307 * Add an idle exiter handler. 307 * Adds an idle exiter handler.
308 * @param func The function to call when exiting an idle state. 308 * @param func The function to call when exiting an idle state.
309 * @param data The data to be passed to the @p func call 309 * @param data The data to be passed to the @p func call.
310 * @return A handle to the idle exiter callback on success. NULL otherwise. 310 * @return A handle to the idle exiter callback on success. @c NULL otherwise.
311 * @note The function func will be called every time the main loop is exiting 311 * @note The function func will be called every time the main loop is exiting
312 * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0 312 * idle state, as long as it returns @c 1 (or @c ECORE_CALLBACK_RENEW). A return of @c 0
313 * (or ECORE_CALLBACK_CANCEL) deletes the idle exiter. 313 * (or @c ECORE_CALLBACK_CANCEL) deletes the idle exiter.
314 */ 314 */
315EAPI Ecore_Idle_Exiter *ecore_idle_exiter_add(Ecore_Task_Cb func, const void *data); 315EAPI Ecore_Idle_Exiter *ecore_idle_exiter_add(Ecore_Task_Cb func, const void *data);
316 316
317/** 317/**
318 * Delete an idle exiter handler from the list to be run on exiting idle state. 318 * Deletes an idle exiter handler from the list to be run on exiting idle state.
319 * @param idle_exiter The idle exiter to delete 319 * @param idle_exiter The idle exiter to delete
320 * @return The data pointer that was being being passed to the handler if 320 * @return The data pointer that was being being passed to the handler if
321 * successful. NULL otherwise. 321 * successful. @c NULL otherwise.
322 */ 322 */
323EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter); 323EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
324 324
@@ -344,7 +344,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
344 * @{ 344 * @{
345 */ 345 */
346/** 346/**
347 * Add a job to the event queue. 347 * Adds a job to the event queue.
348 * @param func The function to call when the job gets handled. 348 * @param func The function to call when the job gets handled.
349 * @param data Data pointer to be passed to the job function when the job is 349 * @param data Data pointer to be passed to the job function when the job is
350 * handled. 350 * handled.
@@ -355,7 +355,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
355EAPI Ecore_Job *ecore_job_add(Ecore_Cb func, const void *data); 355EAPI Ecore_Job *ecore_job_add(Ecore_Cb func, const void *data);
356 356
357/** 357/**
358 * Delete a queued job that has not yet been executed. 358 * Deletes a queued job that has not yet been executed.
359 * @param obj Handle of the job to delete. 359 * @param obj Handle of the job to delete.
360 * @return The data pointer that was to be passed to the job. 360 * @return The data pointer that was to be passed to the job.
361 */ 361 */