#endif /* ! _WIN32 */
/**
- * @defgroup Ecore_Getopt_Group Ecore Getopt
* @ingroup Ecore
+ * @defgroup Ecore_Getopt_Group Ecore Getopt
*
* This group contains powerful getopt replacement.
*
/**
* @typedef Ecore_Getopt_Action
- * @brief Enumeration that defines the actions to do when parsing command line
+ * @brief Enumeration for defining the actions to do when parsing command line
* parameters.
*/
typedef enum {
/**
* @typedef Ecore_Getopt_Type
- * @brief Enumeration that defines the type of the values to store when using
+ * @brief Enumeration for defining the type of the values to store when using
* append action.
*/
typedef enum {
/**
* @typedef Ecore_Getopt_Desc_Arg_Requirement
- * @brief Enumeration that defines if the command line options require an
+ * @brief Enumeration for defining if the command line options require an
* argument.
*/
typedef enum {
};
/**
- * @brief Macro that helps to fill the Ecore_Getopt_Desc table.
+ * @brief Definition for macro that helps to fill the Ecore_Getopt_Desc table.
*/
#define ECORE_GETOPT_STORE_FULL(shortname, longname, help, metavar, type, arg_requirement, default_value) \
{shortname, longname, help, metavar, ECORE_GETOPT_ACTION_STORE, \
{.store = {type, arg_requirement, default_value}}}
/**
- * @brief Macro that fills an option in Ecore_Getopt_Desc table.
+ * @brief Definition for macro that fills an option in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_FULL(shortname, longname, help, NULL, type, \
ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES, {})
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type string.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type string.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_STR)
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type boolean.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type boolean.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_BOOL)
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type short.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type short.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_SHORT)
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type int.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type int.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_INT)
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type long.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type long.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_LONG)
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type ushort.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type ushort.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_USHORT)
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type uint.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type uint.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_UINT)
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type ulong.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type ulong.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_ULONG)
/**
- * @brief Macro that fill Ecore_Getopt_Desc table with an option of type double.
+ * @brief Definition for macro that fill Ecore_Getopt_Desc table with an option of type double.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE(shortname, longname, help, ECORE_GETOPT_TYPE_DOUBLE)
/**
- * Macro that helps to fill the Ecore_Getopt_Desc table with a metavar after
+ * Definition for macro that helps to fill the Ecore_Getopt_Desc table with a metavar after
* the description of the option.
*/
#define ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, type) \
ECORE_GETOPT_DESC_ARG_REQUIREMENT_YES, {})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type string and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type string and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_STR)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type boolean and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type boolean and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_BOOL)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type short and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type short and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_SHORT)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type int and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type int and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_INT)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type long and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type long and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_LONG)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned short and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned short and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_USHORT)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned int and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned int and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_UINT)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned long and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned long and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_ULONG)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type double and metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type double and metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
ECORE_GETOPT_STORE_METAVAR(shortname, longname, help, metavar, ECORE_GETOPT_TYPE_DOUBLE)
/**
- * Macro that helps to fill the Ecore_Getopt_Desc table with a default value.
+ * Definition for macro that helps to fill the Ecore_Getopt_Desc table with a default value.
*/
#define ECORE_GETOPT_STORE_DEF(shortname, longname, help, type, default_value) \
ECORE_GETOPT_STORE_FULL(shortname, longname, help, NULL, type, \
default_value)
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type string and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type string and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.strv = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type boolean and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type boolean and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.boolv = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type short and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type short and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.shortv = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type int and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type int and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.intv = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type long and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type long and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.longv = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned short and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned short and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.ushortv = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned int and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned int and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.uintv = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type unsigned long and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type unsigned long and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.ulongv = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with an option of type double and default value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an option of type double and default value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.doublev = default_value})
/**
- * @brief Fill full string type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full string type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.strv = default_value})
/**
- * @brief Fill full boolean type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full boolean type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.boolv = default_value})
/**
- * @brief Fill full short type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full short type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.shortv = default_value})
/**
- * @brief Fill full int type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full int type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.intv = default_value})
/**
- * @brief Fill full long type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full long type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.longv = default_value})
/**
- * @brief Fill full unsigned short type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full unsigned short type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.ushortv = default_value})
/**
- * @brief Fill full unsigned int type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full unsigned int type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.uintv = default_value})
/**
- * @brief Fill full unsigned long type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full unsigned long type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.ulongv = default_value})
/**
- * @brief Fill full double type option description in Ecore_Getopt_Desc table.
+ * @brief Definition for filling full double type option description in Ecore_Getopt_Desc table.
*
* @param shortname The option short name.
* @param longname The option long name.
{.doublev = default_value})
/**
- * @brief Fill Ecore_Getopt_Desc table with a constant value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a constant value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.store_const = value}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a true boolean value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a true boolean value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a false boolean value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a false boolean value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a true boolean value.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a true boolean value.
*
* @param shortname The option short name.
* @param longname The option long name.
{.choices = choices_array}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a choice.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a choice.
*
* @param shortname The option short name.
* @param longname The option long name.
{.choices = choices_array}}
/**
- * @brief Fill Ecore_Getopt_Desc table with an append action.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an append action.
*
* @param shortname The option short name.
* @param longname The option long name.
{.append_type = sub_type}}
/**
- * @brief Fill Ecore_Getopt_Desc table with an append action and a metavar.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an append action and a metavar.
*
* @param shortname The option short name.
* @param longname The option long name.
{.append_type = type}}
/**
- * @brief Fill Ecore_Getopt_Desc table with an count action.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an count action.
*
* This will store the number of time the option has been passed to the command
* line.
{.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with an callback action and argument requirements.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an callback action and argument requirements.
*
* @param shortname The option short name.
* @param longname The option long name.
* @param metavar The metavar message concerning the parameter of the option.
* @param callback_func The callback function to call.
* @param callback_data The data to pass to the callback.
- * @param argument_requirement the required arguments to this option.
+ * @param argument_requirement The required arguments to this option.
* @param default_value The default values for these arguments.
*/
#define ECORE_GETOPT_CALLBACK_FULL(shortname, longname, help, metavar, callback_func, callback_data, argument_requirement, default_value) \
argument_requirement, default_value}}}
/**
- * @brief Fill Ecore_Getopt_Desc table with an callback action and no arguments.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an callback action and no arguments.
*
* @param shortname The option short name.
* @param longname The option long name.
NULL)
/**
- * @brief Fill Ecore_Getopt_Desc table with an callback action.
+ * @brief Definition for filling Ecore_Getopt_Desc table with an callback action.
*
* @param shortname The option short name.
* @param longname The option long name.
NULL)
/**
- * @brief Fill Ecore_Getopt_Desc table with a help action.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a help action.
*
* @param shortname The help option short name.
* @param longname The help option long name.
{.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a version action.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a version action.
*
* @param shortname The version option short name.
* @param longname The version option long name.
{.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a copyright action.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a copyright action.
*
* @param shortname The copyright option short name.
* @param longname The copyright option long name.
{.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a license action.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a license action.
*
* @param shortname The license option short name.
* @param longname The license option long name.
{.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a break action.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a break action.
*
* @param shortname The option short name.
* @param longname The option long name.
{.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a break action with help message.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a break action with help message.
*
* @param shortname The option short name.
* @param longname The option long name.
{0, name, help, NULL, ECORE_GETOPT_ACTION_CATEGORY, {.dummy = NULL}}
/**
- * @brief Fill Ecore_Getopt_Desc table with a sentinel to indicate the end of descriptions.
+ * @brief Definition for filling Ecore_Getopt_Desc table with a sentinel to indicate the end of descriptions.
*
*/
#define ECORE_GETOPT_SENTINEL {0, NULL, NULL, NULL, 0, {.dummy = NULL}}
/**
- * @brief options that store a single value in a variable of type string.
+ * @brief Definition for options that store a single value in a variable of type string.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_STR(val) {.strp = &(val)}
/**
- * @brief options that store a single value in a variable of type boolean.
+ * @brief Definition for options that store a single value in a variable of type boolean.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_BOOL(val) {.boolp = &(val)}
/**
- * @brief options that store a single value in a variable of type short.
+ * @brief Definition for options that store a single value in a variable of type short.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_SHORT(val) {.shortp = &(val)}
/**
- * @brief options that store a single value in a variable of type int.
+ * @brief Definition for options that store a single value in a variable of type int.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_INT(val) {.intp = &(val)}
/**
- * @brief options that store a single value in a variable of type long.
+ * @brief Definition for options that store a single value in a variable of type long.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_LONG(val) {.longp = &(val)}
/**
- * @brief options that store a single value in a variable of type unsigned short.
+ * @brief Definition for options that store a single value in a variable of type unsigned short.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_USHORT(val) {.ushortp = &(val)}
/**
- * @brief options that store a single value in a variable of type unsigned int.
+ * @brief Definition for options that store a single value in a variable of type unsigned int.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_UINT(val) {.uintp = &(val)}
/**
- * @brief options that store a single value in a variable of type unsigned long.
+ * @brief Definition for options that store a single value in a variable of type unsigned long.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_ULONG(val) {.ulongp = &(val)}
/**
- * @brief options that store a single value in a variable of type double.
+ * @brief Definition for options that store a single value in a variable of type double.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_DOUBLE(val) {.doublep = &(val)}
/**
- * @brief options that store a single value in a variable of type pointer.
+ * @brief Definition for options that store a single value in a variable of type pointer.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_PTR(val) {.ptrp = &(val)}
/**
- * @brief options that store a single value in a variable of type pointer casted.
+ * @brief Definition for options that store a single value in a variable of type pointer casted.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_PTR_CAST(val) {.ptrp = (void **)&(val)}
/**
- * @brief options that store a single value in a variable of type list.
+ * @brief Definition for options that store a single value in a variable of type list.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_LIST(val) {.listp = &(val)}
/**
- * @brief options that store a NULL value.
+ * @brief Definition for options that store a NULL value.
*
* @param val The value to store.
*/
#define ECORE_GETOPT_VALUE_NONE {.ptrp = NULL}
/**
- * Show nicely formatted help message for the given parser.
+ * Shows nicely formatted help message for the given parser.
*
* @param fp The file the message will be printed on.
* @param info The structure containing information about command line options.
EAPI void ecore_getopt_help(FILE *fp, const Ecore_Getopt *info);
/**
- * Show help for a single category (along with program usage and description).
+ * Shows help for a single category (along with program usage and description).
*
* @param fp The file the message will be printed on.
* @param info The structure containing information about command line options.
EAPI Eina_Bool ecore_getopt_help_category(FILE *fp, const Ecore_Getopt *info, const char *category);
/**
- * Check parser for duplicate entries, print them out.
+ * Checks parser for duplicate entries, print them out.
*
* @return @c EINA_TRUE if there are duplicates, @c EINA_FALSE otherwise.
* @param parser The parser to be checked.
EAPI Eina_Bool ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser);
/**
- * Parse command line parameters.
+ * Parses command line parameters.
*
* Walks the command line parameters and parse them based on @a parser
* description, doing actions based on @c parser->descs->action, like
* help, license, copyright, version and eventually others you may
* define.
*
- * @param parser description of how to work.
- * @param values where to store values, it is assumed that this is a vector
+ * @param parser Description of how to work.
+ * @param values Where to store values, it is assumed that this is a vector
* of the same size as @c parser->descs. Values should be previously
* initialized.
- * @param argc how many elements in @a argv. If not provided it will be
+ * @param argc How many elements in @a argv. If not provided it will be
* retrieved with ecore_app_args_get().
- * @param argv command line parameters.
+ * @param argv Command line parameters.
*
- * @return index of first non-option parameter or -1 on error.
+ * @return Index of first non-option parameter or @c -1 on error.
*
* @see ecore_getopt_parse_positional()
*/
EAPI int ecore_getopt_parse(const Ecore_Getopt *parser, Ecore_Getopt_Value *values, int argc, char **argv);
/**
- * Parse command line positional parameters.
+ * Parses command line positional parameters.
*
* Walks the command line positional parameters (those that do not
* start with "-" or "--") and parse them based on @a parser
* standard/global gettext() call will be applied on them if ecore was
* compiled with such support.
*
- * @param parser description of how to work.
- * @param values where to store values, it is assumed that this is a vector
+ * @param parser Description of how to work.
+ * @param values Where to store values, it is assumed that this is a vector
* of the same size as @c parser->descs. Values should be previously
* initialized.
- * @param argc how many elements in @a argv. If not provided it will be
+ * @param argc How many elements in @a argv. If not provided it will be
* retrieved with ecore_app_args_get().
- * @param argv command line parameters.
- * @param start the initial position argument to look at, usually the
+ * @param argv Command line parameters.
+ * @param start The initial position argument to look at, usually the
* return of ecore_getopt_parse(). If less than 1, will try to
* find it automatically.
*
- * @return index of first non-option parameter or -1 on error. If the
+ * @return Index of first non-option parameter or @c -1 on error. If the
* last positional argument is of action @c
* ECORE_GETOPT_ACTION_APPEND then it will be the same as @a argc.
*/
/**
- * Utility to free list and nodes allocated by @a ECORE_GETOPT_ACTION_APPEND.
+ * Utilities to free list and nodes allocated by @a ECORE_GETOPT_ACTION_APPEND.
*
- * @param list pointer to list to be freed.
+ * @param list Pointer to list to be freed.
* @return always @c NULL, so you can easily make your list head @c NULL.
*/
EAPI Eina_List *ecore_getopt_list_free(Eina_List *list);
* @param desc This parameter isn't in use.
* @param str Geometry value
* @param data This parameter isn't in use.
- * @param storage must be a pointer to @c Eina_Rectangle and will be used to
+ * @param storage Must be a pointer to @c Eina_Rectangle and will be used to
* store the four values passed in the given string.
* @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect geometry value.
*
- * This is a helper functions to be used with ECORE_GETOPT_CALLBACK_*().
+ * This is a helper function to be used with ECORE_GETOPT_CALLBACK_*().
*
* @c callback_data value is ignored, you can safely use @c NULL.
*/
* @param desc This parameter isn't in use.
* @param str size value
* @param data This parameter isn't in use.
- * @param storage must be a pointer to @c Eina_Rectangle and will be used to
+ * @param storage Must be a pointer to @c Eina_Rectangle and will be used to
* store the two values passed in the given string and @c 0 in the x and y
* fields.
* @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect size value.
* closest power of 2 greater than @a interval will be used.
*
* When the poller @p func is called, it must return a value of either
- * ECORE_CALLBACK_RENEW(or 1) or ECORE_CALLBACK_CANCEL(or 0). If it
- * returns 1, it will be called again at the next tick, or if it returns
- * 0 it will be deleted automatically making any references/handles for it
+ * @c ECORE_CALLBACK_RENEW(or @c 1) or @c ECORE_CALLBACK_CANCEL(or @c 0). If it
+ * returns @c 1, it will be called again at the next tick, or if it returns
+ * @c 0 it will be deleted automatically making any references/handles for it
* invalid.
*/
EAPI Ecore_Poller *ecore_poller_add(Ecore_Poller_Type type, int interval, Ecore_Task_Cb func, const void *data);
/**
- * @brief Delete the specified poller from the timer list.
+ * @brief Deletes the specified poller from the timer list.
* @param poller The poller to delete.
* @return The data pointer set for the timer when @ref ecore_poller_add was
* called on success, @c NULL otherwise.
*
* @note @a poller must be a valid handle. If the poller function has already
- * returned 0, the handle is no longer valid (and does not need to be deleted).
+ * returned @c 0, the handle is no longer valid (and does not need to be deleted).
*/
EAPI void *ecore_poller_del(Ecore_Poller *poller);
typedef struct _Ecore_Animator Ecore_Animator;
/**
- * @brief Add an animator to call @p func at every animation tick during main
+ * @brief Adds an animator to call @p func at every animation tick during main
* loop execution.
*
* @param func The function to call when it ticks off
* function will be passed the @p data pointer as its parameter.
*
* When the animator @p func is called, it must return a boolean value.
- * If it returns EINA_TRUE (or ECORE_CALLBACK_RENEW), it will be called again at
- * the next tick, or if it returns EINA_FALSE (or ECORE_CALLBACK_CANCEL) it will be
+ * If it returns @c EINA_TRUE (or @c ECORE_CALLBACK_RENEW), it will be called again at
+ * the next tick, or if it returns @c EINA_FALSE (or @c ECORE_CALLBACK_CANCEL) it will be
* deleted automatically making any references/handles for it invalid.
+ * @see ecore_animator_timeline_add()
+ * @see ecore_animator_frametime_set()
*
* @note The default @p frametime value is 1/30th of a second.
*
- * @see ecore_animator_timeline_add()
- * @see ecore_animator_frametime_set()
*/
EAPI Ecore_Animator *ecore_animator_add(Ecore_Task_Cb func, const void *data);
/**
- * @brief Add an animator that runs for a limited time
+ * @brief Adds an animator that runs for a limited time.
*
* @param runtime The time to run in seconds
* @param func The function to call when it ticks off
* This function is just like ecore_animator_add() except the animator only
* runs for a limited time specified in seconds by @p runtime. Once the
* runtime the animator has elapsed (animator finished) it will automatically
- * be deleted. The callback function @p func can return ECORE_CALLBACK_RENEW
- * to keep the animator running or ECORE_CALLBACK_CANCEL ro stop it and have
+ * be deleted. The callback function @p func can return @c ECORE_CALLBACK_RENEW
+ * to keep the animator running or @c ECORE_CALLBACK_CANCEL ro stop it and have
* it be deleted automatically at any time.
*
* The @p func will ALSO be passed a position parameter that will be in value
* the animator run is at. If the callback wishes not to have a linear
* transition it can "map" this value to one of several curves and mappings
* via ecore_animator_pos_map().
+ * @see ecore_animator_add()
+ * @see ecore_animator_pos_map()
*
* @note The default @p frametime value is 1/30th of a second.
*
- * @see ecore_animator_add()
- * @see ecore_animator_pos_map()
* @since 1.1.0
*/
EAPI Ecore_Animator *ecore_animator_timeline_add(double runtime, Ecore_Timeline_Cb func, const void *data);
/**
- * @brief Delete the specified animator from the animator list.
+ * @brief Deletes the specified animator from the animator list.
*
* @param animator The animator to delete
* @return The data pointer set for the animator on add
*
- * Delete the specified @p animator from the set of animators that are
+ * Deletes the specified @p animator from the set of animators that are
* executed during main loop execution. This function returns the data
* parameter that was being passed to the callback on success, or @c NULL on
* failure. After this call returns the specified animator object @p animator
EAPI void *ecore_animator_del(Ecore_Animator *animator);
/**
- * @brief Suspend the specified animator.
+ * @brief Suspends the specified animator.
*
* @param animator The animator to delete
*
EAPI void ecore_animator_freeze(Ecore_Animator *animator);
/**
- * @brief Restore execution of the specified animator.
+ * @brief Restores execution of the specified animator.
*
* @param animator The animator to delete
*
/**
* Creates a timer to call the given function in the given period of time.
* @param in The interval in seconds.
- * @param func The given function. If @p func returns 1, the timer is
+ * @param func The given function. If @p func returns @c 1, the timer is
* rescheduled for the next interval @p in.
* @param data Data to pass to @p func when it is called.
- * @return A timer object on success. @c NULL on failure.
+ * @return A timer object on success, @c NULL on failure.
*
- * This function adds a timer and returns its handle on success and NULL on
+ * This function adds a timer and returns its handle on success and @c NULL on
* failure. The function @p func will be called every @p in seconds. The
* function will be passed the @p data pointer as its parameter.
*
- * When the timer @p func is called, it must return a value of either 1
- * (or ECORE_CALLBACK_RENEW) or 0 (or ECORE_CALLBACK_CANCEL).
- * If it returns 1, it will be called again at the next tick, or if it returns
- * 0 it will be deleted automatically making any references/handles for it
+ * When the timer @p func is called, it must return a value of either @c 1
+ * (or @c ECORE_CALLBACK_RENEW) or @c 0 (or @c ECORE_CALLBACK_CANCEL).
+ * If it returns @c 1, it will be called again at the next tick, or if it returns
+ * @c 0 it will be deleted automatically making any references/handles for it
* invalid.
*/
EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *data);
* @param func The given function. If @p func returns 1, the timer is
* rescheduled for the next interval @p in.
* @param data Data to pass to @p func when it is called.
- * @return A timer object on success. @c NULL on failure.
+ * @return A timer object on success, @c NULL on failure.
*
* This is the same as ecore_timer_add(), but "now" is the time from
* ecore_loop_time_get() not ecore_time_get() as ecore_timer_add() uses. See
EAPI Ecore_Timer *ecore_timer_loop_add(double in, Ecore_Task_Cb func, const void *data);
/**
- * Delete the specified timer from the timer list.
+ * Deletes the specified timer from the timer list.
* @param timer The timer to delete.
* @return The data pointer set for the timer when @ref ecore_timer_add was
* called. @c NULL is returned if the function is unsuccessful.
*
* Note: @p timer must be a valid handle. If the timer function has already
- * returned 0, the handle is no longer valid (and does not need to be delete).
+ * returned @c 0, the handle is no longer valid (and does not need to be delete).
*/
EAPI void *ecore_timer_del(Ecore_Timer *timer);
*/
/**
- * Add an idler handler.
+ * Adds an idler handler.
* @param func The function to call when idling.
* @param data The data to be passed to this @p func call.
* @return A idler handle if successfully added, @c NULL otherwise.
* Add an idler handle to the event loop, returning a handle on
* success and @c NULL otherwise. The function @p func will be called
* repeatedly while no other events are ready to be processed, as
- * long as it returns @c 1 (or ECORE_CALLBACK_RENEW). A return of @c 0
- * (or ECORE_CALLBACK_CANCEL) deletes the idler.
+ * long as it returns @c 1 (or @c ECORE_CALLBACK_RENEW). A return of @c 0
+ * (or @c ECORE_CALLBACK_CANCEL) deletes the idler.
*
* Idlers are useful for progressively processing data without blocking.
*/
EAPI Ecore_Idler *ecore_idler_add(Ecore_Task_Cb func, const void *data);
/**
- * Delete an idler callback from the list to be executed.
+ * Deletes an idler callback from the list to be executed.
* @param idler The handle of the idler callback to delete
* @return The data pointer passed to the idler callback on success, @c NULL
* otherwise.
EAPI void *ecore_idler_del(Ecore_Idler *idler);
/**
- * Add an idle enterer handler.
+ * Adds an idle enterer handler.
* @param func The function to call when entering an idle state.
* @param data The data to be passed to the @p func call
* @return A handle to the idle enterer callback if successful. Otherwise,
- * NULL is returned.
+ * @c NULL is returned.
* @note The function func will be called every time the main loop is entering
- * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0
- * (or ECORE_CALLBACK_CANCEL) deletes the idle enterer.
+ * idle state, as long as it returns @c 1 (or @c ECORE_CALLBACK_RENEW). A return of @c 0
+ * (or @c ECORE_CALLBACK_CANCEL) deletes the idle enterer.
*/
EAPI Ecore_Idle_Enterer *ecore_idle_enterer_add(Ecore_Task_Cb func, const void *data);
/**
- * Add an idle enterer handler at the start of the list so it gets called earlier than others.
+ * Adds an idle enterer handler at the start of the list so it gets called earlier than others.
* @param func The function to call when entering an idle state.
* @param data The data to be passed to the @p func call
* @return A handle to the idle enterer callback if successful. Otherwise,
- * NULL is returned.
+ * @c NULL is returned.
* @note The function func will be called every time the main loop is entering
- * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0
- * (or ECORE_CALLBACK_CANCEL) deletes the idle enterer.
+ * idle state, as long as it returns @c 1 (or @c ECORE_CALLBACK_RENEW). A return of @c 0
+ * (or @c ECORE_CALLBACK_CANCEL) deletes the idle enterer.
*/
EAPI Ecore_Idle_Enterer *ecore_idle_enterer_before_add(Ecore_Task_Cb func, const void *data);
/**
- * Delete an idle enterer callback.
+ * Deletes an idle enterer callback.
* @param idle_enterer The idle enterer to delete
* @return The data pointer passed to the idler enterer callback on success.
- * NULL otherwise.
+ * @c NULL otherwise.
*/
EAPI void *ecore_idle_enterer_del(Ecore_Idle_Enterer *idle_enterer);
/**
- * Add an idle exiter handler.
+ * Adds an idle exiter handler.
* @param func The function to call when exiting an idle state.
- * @param data The data to be passed to the @p func call
- * @return A handle to the idle exiter callback on success. NULL otherwise.
+ * @param data The data to be passed to the @p func call.
+ * @return A handle to the idle exiter callback on success. @c NULL otherwise.
* @note The function func will be called every time the main loop is exiting
- * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0
- * (or ECORE_CALLBACK_CANCEL) deletes the idle exiter.
+ * idle state, as long as it returns @c 1 (or @c ECORE_CALLBACK_RENEW). A return of @c 0
+ * (or @c ECORE_CALLBACK_CANCEL) deletes the idle exiter.
*/
EAPI Ecore_Idle_Exiter *ecore_idle_exiter_add(Ecore_Task_Cb func, const void *data);
/**
- * Delete an idle exiter handler from the list to be run on exiting idle state.
+ * Deletes an idle exiter handler from the list to be run on exiting idle state.
* @param idle_exiter The idle exiter to delete
* @return The data pointer that was being being passed to the handler if
- * successful. NULL otherwise.
+ * successful. @c NULL otherwise.
*/
EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
* @{
*/
/**
- * Add a job to the event queue.
+ * Adds a job to the event queue.
* @param func The function to call when the job gets handled.
* @param data Data pointer to be passed to the job function when the job is
* handled.
EAPI Ecore_Job *ecore_job_add(Ecore_Cb func, const void *data);
/**
- * Delete a queued job that has not yet been executed.
+ * Deletes a queued job that has not yet been executed.
* @param obj Handle of the job to delete.
* @return The data pointer that was to be passed to the job.
*/
projects / platform / upstream / efl.git / commitdiff