summaryrefslogtreecommitdiff
path: root/src
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
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 'src')
-rw-r--r--src/lib/ecore/Ecore_Getopt.h194
-rw-r--r--src/lib/ecore/Ecore_Legacy.h104
2 files changed, 149 insertions, 149 deletions
diff --git a/src/lib/ecore/Ecore_Getopt.h b/src/lib/ecore/Ecore_Getopt.h
index e184b20e08..e09a2bef2d 100644
--- a/src/lib/ecore/Ecore_Getopt.h
+++ b/src/lib/ecore/Ecore_Getopt.h
@@ -31,8 +31,8 @@
31#endif /* ! _WIN32 */ 31#endif /* ! _WIN32 */
32 32
33/** 33/**
34 * @defgroup Ecore_Getopt_Group Ecore Getopt
35 * @ingroup Ecore 34 * @ingroup Ecore
35 * @defgroup Ecore_Getopt_Group Ecore Getopt
36 * 36 *
37 * This group contains powerful getopt replacement. 37 * This group contains powerful getopt replacement.
38 * 38 *
@@ -58,7 +58,7 @@ extern "C" {
58 58
59/** 59/**
60 * @typedef Ecore_Getopt_Action 60 * @typedef Ecore_Getopt_Action
61 * @brief Enumeration that defines the actions to do when parsing command line 61 * @brief Enumeration for defining the actions to do when parsing command line
62 * parameters. 62 * parameters.
63 */ 63 */
64typedef enum { 64typedef enum {
@@ -80,7 +80,7 @@ typedef enum {
80 80
81/** 81/**
82 * @typedef Ecore_Getopt_Type 82 * @typedef Ecore_Getopt_Type
83 * @brief Enumeration that defines the type of the values to store when using 83 * @brief Enumeration for defining the type of the values to store when using
84 * append action. 84 * append action.
85 */ 85 */
86typedef enum { 86typedef enum {
@@ -97,7 +97,7 @@ typedef enum {
97 97
98/** 98/**
99 * @typedef Ecore_Getopt_Desc_Arg_Requirement 99 * @typedef Ecore_Getopt_Desc_Arg_Requirement
100 * @brief Enumeration that defines if the command line options require an 100 * @brief Enumeration for defining if the command line options require an
101 * argument. 101 * argument.
102 */ 102 */
103typedef enum { 103typedef enum {
@@ -222,14 +222,14 @@ struct _Ecore_Getopt
222}; 222};
223 223
224/** 224/**
225 * @brief Macro that helps to fill the Ecore_Getopt_Desc table. 225 * @brief Definition for macro that helps to fill the Ecore_Getopt_Desc table.
226 */ 226 */
227#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value) \ 227#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value) \
228 {shortname, longname, help, metavar, ECORE_GETOPT_ACTION_STORE, \ 228 {shortname, longname, help, metavar, ECORE_GETOPT_ACTION_STORE, \
229 {.store = {type, arg_requirement, default_value}}} 229 {.store = {type, arg_requirement, default_value}}}
230 230
231/** 231/**
232 * @brief Macro that fills an option in Ecore_Getopt_Desc table. 232 * @brief Definition for macro that fills an option in Ecore_Getopt_Desc table.
233 * 233 *
234 * @param shortname The option short name. 234 * @param shortname The option short name.
235 * @param longname The option long name. 235 * @param longname The option long name.
@@ -240,7 +240,7 @@ struct _Ecore_Getopt
240 ECORE_GETOPT_STORE_FULL(shortname, longname, help, NULL, type, \ 240 ECORE_GETOPT_STORE_FULL(shortname, longname, help, NULL, type, \
241 ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES, {}) 241 ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES, {})
242/** 242/**
243 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type string. 243 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type string.
244 * 244 *
245 * @param shortname The option short name. 245 * @param shortname The option short name.
246 * @param longname The option long name. 246 * @param longname The option long name.
@@ -250,7 +250,7 @@ struct _Ecore_Getopt
250 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_STR) 250 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_STR)
251 251
252/** 252/**
253 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type boolean. 253 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type boolean.
254 * 254 *
255 * @param shortname The option short name. 255 * @param shortname The option short name.
256 * @param longname The option long name. 256 * @param longname The option long name.
@@ -260,7 +260,7 @@ struct _Ecore_Getopt
260 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_BOOL) 260 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_BOOL)
261 261
262/** 262/**
263 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type short. 263 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type short.
264 * 264 *
265 * @param shortname The option short name. 265 * @param shortname The option short name.
266 * @param longname The option long name. 266 * @param longname The option long name.
@@ -270,7 +270,7 @@ struct _Ecore_Getopt
270 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_SHORT) 270 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_SHORT)
271 271
272/** 272/**
273 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type int. 273 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type int.
274 * 274 *
275 * @param shortname The option short name. 275 * @param shortname The option short name.
276 * @param longname The option long name. 276 * @param longname The option long name.
@@ -280,7 +280,7 @@ struct _Ecore_Getopt
280 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_INT) 280 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_INT)
281 281
282/** 282/**
283 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type long. 283 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type long.
284 * 284 *
285 * @param shortname The option short name. 285 * @param shortname The option short name.
286 * @param longname The option long name. 286 * @param longname The option long name.
@@ -290,7 +290,7 @@ struct _Ecore_Getopt
290 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_LONG) 290 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_LONG)
291 291
292/** 292/**
293 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type ushort. 293 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type ushort.
294 * 294 *
295 * @param shortname The option short name. 295 * @param shortname The option short name.
296 * @param longname The option long name. 296 * @param longname The option long name.
@@ -300,7 +300,7 @@ struct _Ecore_Getopt
300 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_USHORT) 300 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_USHORT)
301 301
302/** 302/**
303 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type uint. 303 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type uint.
304 * 304 *
305 * @param shortname The option short name. 305 * @param shortname The option short name.
306 * @param longname The option long name. 306 * @param longname The option long name.
@@ -310,7 +310,7 @@ struct _Ecore_Getopt
310 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_UINT) 310 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_UINT)
311 311
312/** 312/**
313 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type ulong. 313 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type ulong.
314 * 314 *
315 * @param shortname The option short name. 315 * @param shortname The option short name.
316 * @param longname The option long name. 316 * @param longname The option long name.
@@ -320,7 +320,7 @@ struct _Ecore_Getopt
320 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_ULONG) 320 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_ULONG)
321 321
322/** 322/**
323 * @brief Macro that fill Ecore_Getopt_Desc table with an option of type double. 323 * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type double.
324 * 324 *
325 * @param shortname The option short name. 325 * @param shortname The option short name.
326 * @param longname The option long name. 326 * @param longname The option long name.
@@ -330,7 +330,7 @@ struct _Ecore_Getopt
330 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_DOUBLE) 330 ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_DOUBLE)
331 331
332/** 332/**
333 * Macro that helps to fill the Ecore_Getopt_Desc table with a metavar after 333 * Definition for macro that helps to fill the Ecore_Getopt_Desc table with a metavar after
334 * the description of the option. 334 * the description of the option.
335 */ 335 */
336#define ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, type) \ 336#define ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, type) \
@@ -338,7 +338,7 @@ struct _Ecore_Getopt
338 ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES, {}) 338 ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES, {})
339 339
340/** 340/**
341 * @brief Fill Ecore_Getopt_Desc table with an option of type string and metavar. 341 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type string and metavar.
342 * 342 *
343 * @param shortname The option short name. 343 * @param shortname The option short name.
344 * @param longname The option long name. 344 * @param longname The option long name.
@@ -349,7 +349,7 @@ struct _Ecore_Getopt
349 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_STR) 349 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_STR)
350 350
351/** 351/**
352 * @brief Fill Ecore_Getopt_Desc table with an option of type boolean and metavar. 352 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type boolean and metavar.
353 * 353 *
354 * @param shortname The option short name. 354 * @param shortname The option short name.
355 * @param longname The option long name. 355 * @param longname The option long name.
@@ -360,7 +360,7 @@ struct _Ecore_Getopt
360 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_BOOL) 360 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_BOOL)
361 361
362/** 362/**
363 * @brief Fill Ecore_Getopt_Desc table with an option of type short and metavar. 363 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type short and metavar.
364 * 364 *
365 * @param shortname The option short name. 365 * @param shortname The option short name.
366 * @param longname The option long name. 366 * @param longname The option long name.
@@ -371,7 +371,7 @@ struct _Ecore_Getopt
371 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_SHORT) 371 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_SHORT)
372 372
373/** 373/**
374 * @brief Fill Ecore_Getopt_Desc table with an option of type int and metavar. 374 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type int and metavar.
375 * 375 *
376 * @param shortname The option short name. 376 * @param shortname The option short name.
377 * @param longname The option long name. 377 * @param longname The option long name.
@@ -382,7 +382,7 @@ struct _Ecore_Getopt
382 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_INT) 382 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_INT)
383 383
384/** 384/**
385 * @brief Fill Ecore_Getopt_Desc table with an option of type long and metavar. 385 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type long and metavar.
386 * 386 *
387 * @param shortname The option short name. 387 * @param shortname The option short name.
388 * @param longname The option long name. 388 * @param longname The option long name.
@@ -393,7 +393,7 @@ struct _Ecore_Getopt
393 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_LONG) 393 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_LONG)
394 394
395/** 395/**
396 * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned short and metavar. 396 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned short and metavar.
397 * 397 *
398 * @param shortname The option short name. 398 * @param shortname The option short name.
399 * @param longname The option long name. 399 * @param longname The option long name.
@@ -404,7 +404,7 @@ struct _Ecore_Getopt
404 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_USHORT) 404 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_USHORT)
405 405
406/** 406/**
407 * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned int and metavar. 407 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned int and metavar.
408 * 408 *
409 * @param shortname The option short name. 409 * @param shortname The option short name.
410 * @param longname The option long name. 410 * @param longname The option long name.
@@ -415,7 +415,7 @@ struct _Ecore_Getopt
415 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_UINT) 415 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_UINT)
416 416
417/** 417/**
418 * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned long and metavar. 418 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned long and metavar.
419 * 419 *
420 * @param shortname The option short name. 420 * @param shortname The option short name.
421 * @param longname The option long name. 421 * @param longname The option long name.
@@ -426,7 +426,7 @@ struct _Ecore_Getopt
426 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_ULONG) 426 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_ULONG)
427 427
428/** 428/**
429 * @brief Fill Ecore_Getopt_Desc table with an option of type double and metavar. 429 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type double and metavar.
430 * 430 *
431 * @param shortname The option short name. 431 * @param shortname The option short name.
432 * @param longname The option long name. 432 * @param longname The option long name.
@@ -437,7 +437,7 @@ struct _Ecore_Getopt
437 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_DOUBLE) 437 ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_DOUBLE)
438 438
439/** 439/**
440 * Macro that helps to fill the Ecore_Getopt_Desc table with a default value. 440 * Definition for macro that helps to fill the Ecore_Getopt_Desc table with a default value.
441 */ 441 */
442#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value) \ 442#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value) \
443 ECORE_GETOPT_STORE_FULL(shortname, longname, help, NULL, type, \ 443 ECORE_GETOPT_STORE_FULL(shortname, longname, help, NULL, type, \
@@ -445,7 +445,7 @@ struct _Ecore_Getopt
445 default_value) 445 default_value)
446 446
447/** 447/**
448 * @brief Fill Ecore_Getopt_Desc table with an option of type string and default value. 448 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type string and default value.
449 * 449 *
450 * @param shortname The option short name. 450 * @param shortname The option short name.
451 * @param longname The option long name. 451 * @param longname The option long name.
@@ -458,7 +458,7 @@ struct _Ecore_Getopt
458 {.strv = default_value}) 458 {.strv = default_value})
459 459
460/** 460/**
461 * @brief Fill Ecore_Getopt_Desc table with an option of type boolean and default value. 461 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type boolean and default value.
462 * 462 *
463 * @param shortname The option short name. 463 * @param shortname The option short name.
464 * @param longname The option long name. 464 * @param longname The option long name.
@@ -471,7 +471,7 @@ struct _Ecore_Getopt
471 {.boolv = default_value}) 471 {.boolv = default_value})
472 472
473/** 473/**
474 * @brief Fill Ecore_Getopt_Desc table with an option of type short and default value. 474 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type short and default value.
475 * 475 *
476 * @param shortname The option short name. 476 * @param shortname The option short name.
477 * @param longname The option long name. 477 * @param longname The option long name.
@@ -484,7 +484,7 @@ struct _Ecore_Getopt
484 {.shortv = default_value}) 484 {.shortv = default_value})
485 485
486/** 486/**
487 * @brief Fill Ecore_Getopt_Desc table with an option of type int and default value. 487 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type int and default value.
488 * 488 *
489 * @param shortname The option short name. 489 * @param shortname The option short name.
490 * @param longname The option long name. 490 * @param longname The option long name.
@@ -497,7 +497,7 @@ struct _Ecore_Getopt
497 {.intv = default_value}) 497 {.intv = default_value})
498 498
499/** 499/**
500 * @brief Fill Ecore_Getopt_Desc table with an option of type long and default value. 500 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type long and default value.
501 * 501 *
502 * @param shortname The option short name. 502 * @param shortname The option short name.
503 * @param longname The option long name. 503 * @param longname The option long name.
@@ -510,7 +510,7 @@ struct _Ecore_Getopt
510 {.longv = default_value}) 510 {.longv = default_value})
511 511
512/** 512/**
513 * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned short and default value. 513 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned short and default value.
514 * 514 *
515 * @param shortname The option short name. 515 * @param shortname The option short name.
516 * @param longname The option long name. 516 * @param longname The option long name.
@@ -523,7 +523,7 @@ struct _Ecore_Getopt
523 {.ushortv = default_value}) 523 {.ushortv = default_value})
524 524
525/** 525/**
526 * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned int and default value. 526 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned int and default value.
527 * 527 *
528 * @param shortname The option short name. 528 * @param shortname The option short name.
529 * @param longname The option long name. 529 * @param longname The option long name.
@@ -536,7 +536,7 @@ struct _Ecore_Getopt
536 {.uintv = default_value}) 536 {.uintv = default_value})
537 537
538/** 538/**
539 * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned long and default value. 539 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned long and default value.
540 * 540 *
541 * @param shortname The option short name. 541 * @param shortname The option short name.
542 * @param longname The option long name. 542 * @param longname The option long name.
@@ -549,7 +549,7 @@ struct _Ecore_Getopt
549 {.ulongv = default_value}) 549 {.ulongv = default_value})
550 550
551/** 551/**
552 * @brief Fill Ecore_Getopt_Desc table with an option of type double and default value. 552 * @brief Definition for filling Ecore_Getopt_Desc table with an option of type double and default value.
553 * 553 *
554 * @param shortname The option short name. 554 * @param shortname The option short name.
555 * @param longname The option long name. 555 * @param longname The option long name.
@@ -562,7 +562,7 @@ struct _Ecore_Getopt
562 {.doublev = default_value}) 562 {.doublev = default_value})
563 563
564/** 564/**
565 * @brief Fill full string type option description in Ecore_Getopt_Desc table. 565 * @brief Definition for filling full string type option description in Ecore_Getopt_Desc table.
566 * 566 *
567 * @param shortname The option short name. 567 * @param shortname The option short name.
568 * @param longname The option long name. 568 * @param longname The option long name.
@@ -578,7 +578,7 @@ struct _Ecore_Getopt
578 {.strv = default_value}) 578 {.strv = default_value})
579 579
580/** 580/**
581 * @brief Fill full boolean type option description in Ecore_Getopt_Desc table. 581 * @brief Definition for filling full boolean type option description in Ecore_Getopt_Desc table.
582 * 582 *
583 * @param shortname The option short name. 583 * @param shortname The option short name.
584 * @param longname The option long name. 584 * @param longname The option long name.
@@ -594,7 +594,7 @@ struct _Ecore_Getopt
594 {.boolv = default_value}) 594 {.boolv = default_value})
595 595
596/** 596/**
597 * @brief Fill full short type option description in Ecore_Getopt_Desc table. 597 * @brief Definition for filling full short type option description in Ecore_Getopt_Desc table.
598 * 598 *
599 * @param shortname The option short name. 599 * @param shortname The option short name.
600 * @param longname The option long name. 600 * @param longname The option long name.
@@ -610,7 +610,7 @@ struct _Ecore_Getopt
610 {.shortv = default_value}) 610 {.shortv = default_value})
611 611
612/** 612/**
613 * @brief Fill full int type option description in Ecore_Getopt_Desc table. 613 * @brief Definition for filling full int type option description in Ecore_Getopt_Desc table.
614 * 614 *
615 * @param shortname The option short name. 615 * @param shortname The option short name.
616 * @param longname The option long name. 616 * @param longname The option long name.
@@ -626,7 +626,7 @@ struct _Ecore_Getopt
626 {.intv = default_value}) 626 {.intv = default_value})
627 627
628/** 628/**
629 * @brief Fill full long type option description in Ecore_Getopt_Desc table. 629 * @brief Definition for filling full long type option description in Ecore_Getopt_Desc table.
630 * 630 *
631 * @param shortname The option short name. 631 * @param shortname The option short name.
632 * @param longname The option long name. 632 * @param longname The option long name.
@@ -642,7 +642,7 @@ struct _Ecore_Getopt
642 {.longv = default_value}) 642 {.longv = default_value})
643 643
644/** 644/**
645 * @brief Fill full unsigned short type option description in Ecore_Getopt_Desc table. 645 * @brief Definition for filling full unsigned short type option description in Ecore_Getopt_Desc table.
646 * 646 *
647 * @param shortname The option short name. 647 * @param shortname The option short name.
648 * @param longname The option long name. 648 * @param longname The option long name.
@@ -658,7 +658,7 @@ struct _Ecore_Getopt
658 {.ushortv = default_value}) 658 {.ushortv = default_value})
659 659
660/** 660/**
661 * @brief Fill full unsigned int type option description in Ecore_Getopt_Desc table. 661 * @brief Definition for filling full unsigned int type option description in Ecore_Getopt_Desc table.
662 * 662 *
663 * @param shortname The option short name. 663 * @param shortname The option short name.
664 * @param longname The option long name. 664 * @param longname The option long name.
@@ -674,7 +674,7 @@ struct _Ecore_Getopt
674 {.uintv = default_value}) 674 {.uintv = default_value})
675 675
676/** 676/**
677 * @brief Fill full unsigned long type option description in Ecore_Getopt_Desc table. 677 * @brief Definition for filling full unsigned long type option description in Ecore_Getopt_Desc table.
678 * 678 *
679 * @param shortname The option short name. 679 * @param shortname The option short name.
680 * @param longname The option long name. 680 * @param longname The option long name.
@@ -690,7 +690,7 @@ struct _Ecore_Getopt
690 {.ulongv = default_value}) 690 {.ulongv = default_value})
691 691
692/** 692/**
693 * @brief Fill full double type option description in Ecore_Getopt_Desc table. 693 * @brief Definition for filling full double type option description in Ecore_Getopt_Desc table.
694 * 694 *
695 * @param shortname The option short name. 695 * @param shortname The option short name.
696 * @param longname The option long name. 696 * @param longname The option long name.
@@ -706,7 +706,7 @@ struct _Ecore_Getopt
706 {.doublev = default_value}) 706 {.doublev = default_value})
707 707
708/** 708/**
709 * @brief Fill Ecore_Getopt_Desc table with a constant value. 709 * @brief Definition for filling Ecore_Getopt_Desc table with a constant value.
710 * 710 *
711 * @param shortname The option short name. 711 * @param shortname The option short name.
712 * @param longname The option long name. 712 * @param longname The option long name.
@@ -718,7 +718,7 @@ struct _Ecore_Getopt
718 {.store_const = value}} 718 {.store_const = value}}
719 719
720/** 720/**
721 * @brief Fill Ecore_Getopt_Desc table with a true boolean value. 721 * @brief Definition for filling Ecore_Getopt_Desc table with a true boolean value.
722 * 722 *
723 * @param shortname The option short name. 723 * @param shortname The option short name.
724 * @param longname The option long name. 724 * @param longname The option long name.
@@ -729,7 +729,7 @@ struct _Ecore_Getopt
729 {.dummy = NULL}} 729 {.dummy = NULL}}
730 730
731/** 731/**
732 * @brief Fill Ecore_Getopt_Desc table with a false boolean value. 732 * @brief Definition for filling Ecore_Getopt_Desc table with a false boolean value.
733 * 733 *
734 * @param shortname The option short name. 734 * @param shortname The option short name.
735 * @param longname The option long name. 735 * @param longname The option long name.
@@ -740,7 +740,7 @@ struct _Ecore_Getopt
740 {.dummy = NULL}} 740 {.dummy = NULL}}
741 741
742/** 742/**
743 * @brief Fill Ecore_Getopt_Desc table with a true boolean value. 743 * @brief Definition for filling Ecore_Getopt_Desc table with a true boolean value.
744 * 744 *
745 * @param shortname The option short name. 745 * @param shortname The option short name.
746 * @param longname The option long name. 746 * @param longname The option long name.
@@ -752,7 +752,7 @@ struct _Ecore_Getopt
752 {.choices = choices_array}} 752 {.choices = choices_array}}
753 753
754/** 754/**
755 * @brief Fill Ecore_Getopt_Desc table with a choice. 755 * @brief Definition for filling Ecore_Getopt_Desc table with a choice.
756 * 756 *
757 * @param shortname The option short name. 757 * @param shortname The option short name.
758 * @param longname The option long name. 758 * @param longname The option long name.
@@ -765,7 +765,7 @@ struct _Ecore_Getopt
765 {.choices = choices_array}} 765 {.choices = choices_array}}
766 766
767/** 767/**
768 * @brief Fill Ecore_Getopt_Desc table with an append action. 768 * @brief Definition for filling Ecore_Getopt_Desc table with an append action.
769 * 769 *
770 * @param shortname The option short name. 770 * @param shortname The option short name.
771 * @param longname The option long name. 771 * @param longname The option long name.
@@ -777,7 +777,7 @@ struct _Ecore_Getopt
777 {.append_type = sub_type}} 777 {.append_type = sub_type}}
778 778
779/** 779/**
780 * @brief Fill Ecore_Getopt_Desc table with an append action and a metavar. 780 * @brief Definition for filling Ecore_Getopt_Desc table with an append action and a metavar.
781 * 781 *
782 * @param shortname The option short name. 782 * @param shortname The option short name.
783 * @param longname The option long name. 783 * @param longname The option long name.
@@ -790,7 +790,7 @@ struct _Ecore_Getopt
790 {.append_type = type}} 790 {.append_type = type}}
791 791
792/** 792/**
793 * @brief Fill Ecore_Getopt_Desc table with an count action. 793 * @brief Definition for filling Ecore_Getopt_Desc table with an count action.
794 * 794 *
795 * This will store the number of time the option has been passed to the command 795 * This will store the number of time the option has been passed to the command
796 * line. 796 * line.
@@ -803,7 +803,7 @@ struct _Ecore_Getopt
803 {.dummy = NULL}} 803 {.dummy = NULL}}
804 804
805/** 805/**
806 * @brief Fill Ecore_Getopt_Desc table with an callback action and argument requirements. 806 * @brief Definition for filling Ecore_Getopt_Desc table with an callback action and argument requirements.
807 * 807 *
808 * @param shortname The option short name. 808 * @param shortname The option short name.
809 * @param longname The option long name. 809 * @param longname The option long name.
@@ -811,7 +811,7 @@ struct _Ecore_Getopt
811 * @param metavar The metavar message concerning the parameter of the option. 811 * @param metavar The metavar message concerning the parameter of the option.
812 * @param callback_func The callback function to call. 812 * @param callback_func The callback function to call.
813 * @param callback_data The data to pass to the callback. 813 * @param callback_data The data to pass to the callback.
814 * @param argument_requirement the required arguments to this option. 814 * @param argument_requirement The required arguments to this option.
815 * @param default_value The default values for these arguments. 815 * @param default_value The default values for these arguments.
816 */ 816 */
817#define ECORE_GETOPT_CALLBACK_FULL(shortname, longname, help, metavar, callback_func, callback_data, argument_requirement, default_value) \ 817#define ECORE_GETOPT_CALLBACK_FULL(shortname, longname, help, metavar, callback_func, callback_data, argument_requirement, default_value) \
@@ -820,7 +820,7 @@ struct _Ecore_Getopt
820 argument_requirement, default_value}}} 820 argument_requirement, default_value}}}
821 821
822/** 822/**
823 * @brief Fill Ecore_Getopt_Desc table with an callback action and no arguments. 823 * @brief Definition for filling Ecore_Getopt_Desc table with an callback action and no arguments.
824 * 824 *
825 * @param shortname The option short name. 825 * @param shortname The option short name.
826 * @param longname The option long name. 826 * @param longname The option long name.
@@ -835,7 +835,7 @@ struct _Ecore_Getopt
835 NULL) 835 NULL)
836 836
837/** 837/**
838 * @brief Fill Ecore_Getopt_Desc table with an callback action. 838 * @brief Definition for filling Ecore_Getopt_Desc table with an callback action.
839 * 839 *
840 * @param shortname The option short name. 840 * @param shortname The option short name.
841 * @param longname The option long name. 841 * @param longname The option long name.
@@ -851,7 +851,7 @@ struct _Ecore_Getopt
851 NULL) 851 NULL)
852 852
853/** 853/**
854 * @brief Fill Ecore_Getopt_Desc table with a help action. 854 * @brief Definition for filling Ecore_Getopt_Desc table with a help action.
855 * 855 *
856 * @param shortname The help option short name. 856 * @param shortname The help option short name.
857 * @param longname The help option long name. 857 * @param longname The help option long name.
@@ -862,7 +862,7 @@ struct _Ecore_Getopt
862 {.dummy = NULL}} 862 {.dummy = NULL}}
863 863
864/** 864/**
865 * @brief Fill Ecore_Getopt_Desc table with a version action. 865 * @brief Definition for filling Ecore_Getopt_Desc table with a version action.
866 * 866 *
867 * @param shortname The version option short name. 867 * @param shortname The version option short name.
868 * @param longname The version option long name. 868 * @param longname The version option long name.
@@ -873,7 +873,7 @@ struct _Ecore_Getopt
873 {.dummy = NULL}} 873 {.dummy = NULL}}
874 874
875/** 875/**
876 * @brief Fill Ecore_Getopt_Desc table with a copyright action. 876 * @brief Definition for filling Ecore_Getopt_Desc table with a copyright action.
877 * 877 *
878 * @param shortname The copyright option short name. 878 * @param shortname The copyright option short name.
879 * @param longname The copyright option long name. 879 * @param longname The copyright option long name.
@@ -884,7 +884,7 @@ struct _Ecore_Getopt
884 {.dummy = NULL}} 884 {.dummy = NULL}}
885 885
886/** 886/**
887 * @brief Fill Ecore_Getopt_Desc table with a license action. 887 * @brief Definition for filling Ecore_Getopt_Desc table with a license action.
888 * 888 *
889 * @param shortname The license option short name. 889 * @param shortname The license option short name.
890 * @param longname The license option long name. 890 * @param longname The license option long name.
@@ -895,7 +895,7 @@ struct _Ecore_Getopt
895 {.dummy = NULL}} 895 {.dummy = NULL}}
896 896
897/** 897/**
898 * @brief Fill Ecore_Getopt_Desc table with a break action. 898 * @brief Definition for filling Ecore_Getopt_Desc table with a break action.
899 * 899 *
900 * @param shortname The option short name. 900 * @param shortname The option short name.
901 * @param longname The option long name. 901 * @param longname The option long name.
@@ -906,7 +906,7 @@ struct _Ecore_Getopt
906 {.dummy = NULL}} 906 {.dummy = NULL}}
907 907
908/** 908/**
909 * @brief Fill Ecore_Getopt_Desc table with a break action with help message. 909 * @brief Definition for filling Ecore_Getopt_Desc table with a break action with help message.
910 * 910 *
911 * @param shortname The option short name. 911 * @param shortname The option short name.
912 * @param longname The option long name. 912 * @param longname The option long name.
@@ -921,104 +921,104 @@ struct _Ecore_Getopt
921 {0, name, help, NULL, ECORE_GETOPT_ACTION_CATEGORY, {.dummy = NULL}} 921 {0, name, help, NULL, ECORE_GETOPT_ACTION_CATEGORY, {.dummy = NULL}}
922 922
923/** 923/**
924 * @brief Fill Ecore_Getopt_Desc table with a sentinel to indicate the end of descriptions. 924 * @brief Definition for filling Ecore_Getopt_Desc table with a sentinel to indicate the end of descriptions.
925 * 925 *
926 */ 926 */
927#define ECORE_GETOPT_SENTINEL {0, NULL, NULL, NULL, 0, {.dummy = NULL}} 927#define ECORE_GETOPT_SENTINEL {0, NULL, NULL, NULL, 0, {.dummy = NULL}}
928 928
929/** 929/**
930 * @brief options that store a single value in a variable of type string. 930 * @brief Definition for options that store a single value in a variable of type string.
931 * 931 *
932 * @param val The value to store. 932 * @param val The value to store.
933 */ 933 */
934#define ECORE_GETOPT_VALUE_STR(val) {.strp = &(val)} 934#define ECORE_GETOPT_VALUE_STR(val) {.strp = &(val)}
935 935
936/** 936/**
937 * @brief options that store a single value in a variable of type boolean. 937 * @brief Definition for options that store a single value in a variable of type boolean.
938 * 938 *
939 * @param val The value to store. 939 * @param val The value to store.
940 */ 940 */
941#define ECORE_GETOPT_VALUE_BOOL(val) {.boolp = &(val)} 941#define ECORE_GETOPT_VALUE_BOOL(val) {.boolp = &(val)}
942 942
943/** 943/**
944 * @brief options that store a single value in a variable of type short. 944 * @brief Definition for options that store a single value in a variable of type short.
945 * 945 *
946 * @param val The value to store. 946 * @param val The value to store.
947 */ 947 */
948#define ECORE_GETOPT_VALUE_SHORT(val) {.shortp = &(val)} 948#define ECORE_GETOPT_VALUE_SHORT(val) {.shortp = &(val)}
949 949
950/** 950/**
951 * @brief options that store a single value in a variable of type int. 951 * @brief Definition for options that store a single value in a variable of type int.
952 * 952 *
953 * @param val The value to store. 953 * @param val The value to store.
954 */ 954 */
955#define ECORE_GETOPT_VALUE_INT(val) {.intp = &(val)} 955#define ECORE_GETOPT_VALUE_INT(val) {.intp = &(val)}
956 956
957/** 957/**
958 * @brief options that store a single value in a variable of type long. 958 * @brief Definition for options that store a single value in a variable of type long.
959 * 959 *
960 * @param val The value to store. 960 * @param val The value to store.
961 */ 961 */
962#define ECORE_GETOPT_VALUE_LONG(val) {.longp = &(val)} 962#define ECORE_GETOPT_VALUE_LONG(val) {.longp = &(val)}
963 963
964/** 964/**
965 * @brief options that store a single value in a variable of type unsigned short. 965 * @brief Definition for options that store a single value in a variable of type unsigned short.
966 * 966 *
967 * @param val The value to store. 967 * @param val The value to store.
968 */ 968 */
969#define ECORE_GETOPT_VALUE_USHORT(val) {.ushortp = &(val)} 969#define ECORE_GETOPT_VALUE_USHORT(val) {.ushortp = &(val)}
970 970
971/** 971/**
972 * @brief options that store a single value in a variable of type unsigned int. 972 * @brief Definition for options that store a single value in a variable of type unsigned int.
973 * 973 *
974 * @param val The value to store. 974 * @param val The value to store.
975 */ 975 */
976#define ECORE_GETOPT_VALUE_UINT(val) {.uintp = &(val)} 976#define ECORE_GETOPT_VALUE_UINT(val) {.uintp = &(val)}
977 977
978/** 978/**
979 * @brief options that store a single value in a variable of type unsigned long. 979 * @brief Definition for options that store a single value in a variable of type unsigned long.
980 * 980 *
981 * @param val The value to store. 981 * @param val The value to store.
982 */ 982 */
983#define ECORE_GETOPT_VALUE_ULONG(val) {.ulongp = &(val)} 983#define ECORE_GETOPT_VALUE_ULONG(val) {.ulongp = &(val)}
984 984
985/** 985/**
986 * @brief options that store a single value in a variable of type double. 986 * @brief Definition for options that store a single value in a variable of type double.
987 * 987 *
988 * @param val The value to store. 988 * @param val The value to store.
989 */ 989 */
990#define ECORE_GETOPT_VALUE_DOUBLE(val) {.doublep = &(val)} 990#define ECORE_GETOPT_VALUE_DOUBLE(val) {.doublep = &(val)}
991 991
992/** 992/**
993 * @brief options that store a single value in a variable of type pointer. 993 * @brief Definition for options that store a single value in a variable of type pointer.
994 * 994 *
995 * @param val The value to store. 995 * @param val The value to store.
996 */ 996 */
997#define ECORE_GETOPT_VALUE_PTR(val) {.ptrp = &(val)} 997#define ECORE_GETOPT_VALUE_PTR(val) {.ptrp = &(val)}
998 998
999/** 999/**
1000 * @brief options that store a single value in a variable of type pointer casted. 1000 * @brief Definition for options that store a single value in a variable of type pointer casted.
1001 * 1001 *
1002 * @param val The value to store. 1002 * @param val The value to store.
1003 */ 1003 */
1004#define ECORE_GETOPT_VALUE_PTR_CAST(val) {.ptrp = (void **)&(val)} 1004#define ECORE_GETOPT_VALUE_PTR_CAST(val) {.ptrp = (void **)&(val)}
1005 1005
1006/** 1006/**
1007 * @brief options that store a single value in a variable of type list. 1007 * @brief Definition for options that store a single value in a variable of type list.
1008 * 1008 *
1009 * @param val The value to store. 1009 * @param val The value to store.
1010 */ 1010 */
1011#define ECORE_GETOPT_VALUE_LIST(val) {.listp = &(val)} 1011#define ECORE_GETOPT_VALUE_LIST(val) {.listp = &(val)}
1012 1012
1013/** 1013/**
1014 * @brief options that store a NULL value. 1014 * @brief Definition for options that store a NULL value.
1015 * 1015 *
1016 * @param val The value to store. 1016 * @param val The value to store.
1017 */ 1017 */
1018#define ECORE_GETOPT_VALUE_NONE {.ptrp = NULL} 1018#define ECORE_GETOPT_VALUE_NONE {.ptrp = NULL}
1019 1019
1020/** 1020/**
1021 * Show nicely formatted help message for the given parser. 1021 * Shows nicely formatted help message for the given parser.
1022 * 1022 *
1023 * @param fp The file the message will be printed on. 1023 * @param fp The file the message will be printed on.
1024 * @param info The structure containing information about command line options. 1024 * @param info The structure containing information about command line options.
@@ -1028,7 +1028,7 @@ struct _Ecore_Getopt
1028EAPI void ecore_getopt_help(FILE *fp, const Ecore_Getopt *info); 1028EAPI void ecore_getopt_help(FILE *fp, const Ecore_Getopt *info);
1029 1029
1030/** 1030/**
1031 * Show help for a single category (along with program usage and description). 1031 * Shows help for a single category (along with program usage and description).
1032 * 1032 *
1033 * @param fp The file the message will be printed on. 1033 * @param fp The file the message will be printed on.
1034 * @param info The structure containing information about command line options. 1034 * @param info The structure containing information about command line options.
@@ -1041,7 +1041,7 @@ EAPI void ecore_getopt_help(FILE *fp, const Ecore_Getopt *info);
1041EAPI Eina_Bool ecore_getopt_help_category(FILE *fp, const Ecore_Getopt *info, const char *category); 1041EAPI Eina_Bool ecore_getopt_help_category(FILE *fp, const Ecore_Getopt *info, const char *category);
1042 1042
1043/** 1043/**
1044 * Check parser for duplicate entries, print them out. 1044 * Checks parser for duplicate entries, print them out.
1045 * 1045 *
1046 * @return @c EINA_TRUE if there are duplicates, @c EINA_FALSE otherwise. 1046 * @return @c EINA_TRUE if there are duplicates, @c EINA_FALSE otherwise.
1047 * @param parser The parser to be checked. 1047 * @param parser The parser to be checked.
@@ -1049,7 +1049,7 @@ EAPI Eina_Bool ecore_getopt_help_category(FILE *fp, const Ecore_Getopt *info, c
1049EAPI Eina_Bool ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser); 1049EAPI Eina_Bool ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser);
1050 1050
1051/** 1051/**
1052 * Parse command line parameters. 1052 * Parses command line parameters.
1053 * 1053 *
1054 * Walks the command line parameters and parse them based on @a parser 1054 * Walks the command line parameters and parse them based on @a parser
1055 * description, doing actions based on @c parser->descs->action, like 1055 * description, doing actions based on @c parser->descs->action, like
@@ -1098,22 +1098,22 @@ EAPI Eina_Bool ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser);
1098 * help, license, copyright, version and eventually others you may 1098 * help, license, copyright, version and eventually others you may
1099 * define. 1099 * define.
1100 * 1100 *
1101 * @param parser description of how to work. 1101 * @param parser Description of how to work.
1102 * @param values where to store values, it is assumed that this is a vector 1102 * @param values Where to store values, it is assumed that this is a vector
1103 * of the same size as @c parser->descs. Values should be previously 1103 * of the same size as @c parser->descs. Values should be previously
1104 * initialized. 1104 * initialized.
1105 * @param argc how many elements in @a argv. If not provided it will be 1105 * @param argc How many elements in @a argv. If not provided it will be
1106 * retrieved with ecore_app_args_get(). 1106 * retrieved with ecore_app_args_get().
1107 * @param argv command line parameters. 1107 * @param argv Command line parameters.
1108 * 1108 *
1109 * @return index of first non-option parameter or -1 on error. 1109 * @return Index of first non-option parameter or @c -1 on error.
1110 * 1110 *
1111 * @see ecore_getopt_parse_positional() 1111 * @see ecore_getopt_parse_positional()
1112 */ 1112 */
1113EAPI int ecore_getopt_parse(const Ecore_Getopt *parser, Ecore_Getopt_Value *values, int argc, char **argv); 1113EAPI int ecore_getopt_parse(const Ecore_Getopt *parser, Ecore_Getopt_Value *values, int argc, char **argv);
1114 1114
1115/** 1115/**
1116 * Parse command line positional parameters. 1116 * Parses command line positional parameters.
1117 * 1117 *
1118 * Walks the command line positional parameters (those that do not 1118 * Walks the command line positional parameters (those that do not
1119 * start with "-" or "--") and parse them based on @a parser 1119 * start with "-" or "--") and parse them based on @a parser
@@ -1148,18 +1148,18 @@ EAPI int ecore_getopt_parse(const Ecore_Getopt *parser, Ecore_Getopt_Valu
1148 * standard/global gettext() call will be applied on them if ecore was 1148 * standard/global gettext() call will be applied on them if ecore was
1149 * compiled with such support. 1149 * compiled with such support.
1150 * 1150 *
1151 * @param parser description of how to work. 1151 * @param parser Description of how to work.
1152 * @param values where to store values, it is assumed that this is a vector 1152 * @param values Where to store values, it is assumed that this is a vector
1153 * of the same size as @c parser->descs. Values should be previously 1153 * of the same size as @c parser->descs. Values should be previously
1154 * initialized. 1154 * initialized.
1155 * @param argc how many elements in @a argv. If not provided it will be 1155 * @param argc How many elements in @a argv. If not provided it will be
1156 * retrieved with ecore_app_args_get(). 1156 * retrieved with ecore_app_args_get().
1157 * @param argv command line parameters. 1157 * @param argv Command line parameters.
1158 * @param start the initial position argument to look at, usually the 1158 * @param start The initial position argument to look at, usually the
1159 * return of ecore_getopt_parse(). If less than 1, will try to 1159 * return of ecore_getopt_parse(). If less than 1, will try to
1160 * find it automatically. 1160 * find it automatically.
1161 * 1161 *
1162 * @return index of first non-option parameter or -1 on error. If the 1162 * @return Index of first non-option parameter or @c -1 on error. If the
1163 * last positional argument is of action @c 1163 * last positional argument is of action @c
1164 * ECORE_GETOPT_ACTION_APPEND then it will be the same as @a argc. 1164 * ECORE_GETOPT_ACTION_APPEND then it will be the same as @a argc.
1165 */ 1165 */
@@ -1167,9 +1167,9 @@ EAPI int ecore_getopt_parse_positional(const Ecore_Getopt *parser, Ecore_
1167 1167
1168 1168
1169/** 1169/**
1170 * Utility to free list and nodes allocated by @a ECORE_GETOPT_ACTION_APPEND. 1170 * Utilities to free list and nodes allocated by @a ECORE_GETOPT_ACTION_APPEND.
1171 * 1171 *
1172 * @param list pointer to list to be freed. 1172 * @param list Pointer to list to be freed.
1173 * @return always @c NULL, so you can easily make your list head @c NULL. 1173 * @return always @c NULL, so you can easily make your list head @c NULL.
1174 */ 1174 */
1175EAPI Eina_List *ecore_getopt_list_free(Eina_List *list); 1175EAPI Eina_List *ecore_getopt_list_free(Eina_List *list);
@@ -1181,11 +1181,11 @@ EAPI Eina_List *ecore_getopt_list_free(Eina_List *list);
1181 * @param desc This parameter isn't in use. 1181 * @param desc This parameter isn't in use.
1182 * @param str Geometry value 1182 * @param str Geometry value
1183 * @param data This parameter isn't in use. 1183 * @param data This parameter isn't in use.
1184 * @param storage must be a pointer to @c Eina_Rectangle and will be used to 1184 * @param storage Must be a pointer to @c Eina_Rectangle and will be used to
1185 * store the four values passed in the given string. 1185 * store the four values passed in the given string.
1186 * @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect geometry value. 1186 * @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect geometry value.
1187 * 1187 *
1188 * This is a helper functions to be used with ECORE_GETOPT_CALLBACK_*(). 1188 * This is a helper function to be used with ECORE_GETOPT_CALLBACK_*().
1189 * 1189 *
1190 * @c callback_data value is ignored, you can safely use @c NULL. 1190 * @c callback_data value is ignored, you can safely use @c NULL.
1191 */ 1191 */
@@ -1198,7 +1198,7 @@ EAPI Eina_Bool ecore_getopt_callback_geometry_parse(const Ecore_Getopt *parser,
1198 * @param desc This parameter isn't in use. 1198 * @param desc This parameter isn't in use.
1199 * @param str size value 1199 * @param str size value
1200 * @param data This parameter isn't in use. 1200 * @param data This parameter isn't in use.
1201 * @param storage must be a pointer to @c Eina_Rectangle and will be used to 1201 * @param storage Must be a pointer to @c Eina_Rectangle and will be used to
1202 * store the two values passed in the given string and @c 0 in the x and y 1202 * store the two values passed in the given string and @c 0 in the x and y
1203 * fields. 1203 * fields.
1204 * @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect size value. 1204 * @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect size value.
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 */