forked from enlightenment/efl
Cleanup Doxygen Warnings - ecore 1
Files modified: ecore/doc/Doxyfile.in ecore/src/lib/ecore/Ecore.h ecore/src/lib/ecore/ecore.c ecore/src/lib/ecore/ecore_getopt.c ecore/src/lib/ecore/ecore_main.c ecore/src/lib/ecore_con/Ecore_Con.h SVN revision: 70421
This commit is contained in:
parent
331ef4b522
commit
9080cd0a3a
|
@ -72,7 +72,7 @@ WARN_IF_DOC_ERROR = YES
|
|||
WARN_NO_PARAMDOC = YES
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
WARN_LOGFILE =
|
||||
INPUT = @srcdir@/ecore.dox \
|
||||
INPUT = @builddir@/ecore.dox \
|
||||
@top_srcdir@/src/lib \
|
||||
@srcdir@/examples.dox
|
||||
INPUT_ENCODING = UTF-8
|
||||
|
@ -85,7 +85,7 @@ EXCLUDE_SYMBOLS = Ecore_Config*
|
|||
EXAMPLE_PATH = @top_srcdir@/src/examples/
|
||||
EXAMPLE_PATTERNS =
|
||||
EXAMPLE_RECURSIVE = YES
|
||||
IMAGE_PATH = img
|
||||
IMAGE_PATH = @srcdir@/img
|
||||
INPUT_FILTER =
|
||||
FILTER_PATTERNS =
|
||||
FILTER_SOURCE_FILES = NO
|
||||
|
|
|
@ -419,7 +419,7 @@ EAPI extern Ecore_Version *ecore_version;
|
|||
typedef Eina_Bool (*Ecore_Task_Cb)(void *data);
|
||||
|
||||
/**
|
||||
* @typedef Ecore_Eselect_Function
|
||||
* @typedef Ecore_Select_Function
|
||||
* A function which can be used to replace select() in the main loop
|
||||
*/
|
||||
typedef int (*Ecore_Select_Function)(int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout);
|
||||
|
@ -850,6 +850,10 @@ EAPI extern int ECORE_EXE_EVENT_DEL; /**< A child process has been deleted (
|
|||
EAPI extern int ECORE_EXE_EVENT_DATA; /**< Data from a child process. */
|
||||
EAPI extern int ECORE_EXE_EVENT_ERROR; /**< Errors from a child process. */
|
||||
|
||||
/**
|
||||
* @enum _Ecore_Exe_Flags
|
||||
* Flags for executing a child with its stdin and/or stdout piped back.
|
||||
*/
|
||||
enum _Ecore_Exe_Flags /* flags for executing a child with its stdin and/or stdout piped back */
|
||||
{
|
||||
ECORE_EXE_NONE = 0, /**< No exe flags at all */
|
||||
|
@ -866,6 +870,10 @@ enum _Ecore_Exe_Flags /* flags for executing a child with its stdin and/or st
|
|||
};
|
||||
typedef enum _Ecore_Exe_Flags Ecore_Exe_Flags;
|
||||
|
||||
/**
|
||||
* @enum _Ecore_Exe_Win32_Priority
|
||||
* Defines the priority of the proccess.
|
||||
*/
|
||||
enum _Ecore_Exe_Win32_Priority
|
||||
{
|
||||
ECORE_EXE_WIN32_PRIORITY_IDLE, /**< Idle priority, for monitoring the system */
|
||||
|
@ -995,6 +1003,10 @@ EAPI void ecore_exe_hup(Ecore_Exe *exe);
|
|||
|
||||
typedef struct _Ecore_Fd_Handler Ecore_Fd_Handler; /**< A handle for Fd handlers */
|
||||
|
||||
/**
|
||||
* @enum _Ecore_Fd_Handler_Flags
|
||||
* What to monitor the file descriptor for: reading, writing or error.
|
||||
*/
|
||||
enum _Ecore_Fd_Handler_Flags
|
||||
{
|
||||
ECORE_FD_READ = 1, /**< Fd Read mask */
|
||||
|
@ -1151,6 +1163,10 @@ EAPI void *ecore_main_win32_handler_del(Ecore_Win32_Handler *win32_handler);
|
|||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @enum _Ecore_Poller_Type
|
||||
* Defines the frequency of ticks for the poller.
|
||||
*/
|
||||
enum _Ecore_Poller_Type /* Poller types */
|
||||
{
|
||||
ECORE_POLLER_CORE = 0 /**< The core poller interval */
|
||||
|
@ -1274,6 +1290,10 @@ EAPI void *ecore_poller_del(Ecore_Poller *poller);
|
|||
|
||||
typedef struct _Ecore_Animator Ecore_Animator; /**< A handle for animators */
|
||||
|
||||
/**
|
||||
* @enum _Ecore_Pos_Map
|
||||
* Defines the position mappings for the animation.
|
||||
*/
|
||||
enum _Ecore_Pos_Map /* Position mappings */
|
||||
{
|
||||
ECORE_POS_MAP_LINEAR, /**< Linear 0.0 -> 1.0 */
|
||||
|
@ -1289,6 +1309,10 @@ enum _Ecore_Pos_Map /* Position mappings */
|
|||
};
|
||||
typedef enum _Ecore_Pos_Map Ecore_Pos_Map;
|
||||
|
||||
/**
|
||||
* @enum _Ecore_Animator_Source
|
||||
* Defines the timing sources for animators.
|
||||
*/
|
||||
enum _Ecore_Animator_Source /* Timing sources for animators */
|
||||
{
|
||||
ECORE_ANIMATOR_SOURCE_TIMER, /**< The default system clock/timer based animator that ticks every "frametime" seconds */
|
||||
|
|
|
@ -209,6 +209,7 @@ shutdown_evil:
|
|||
/**
|
||||
* Shut down connections, signal handlers sockets etc.
|
||||
*
|
||||
* @return 0 if ecore shuts down, greater than 0 otherwise.
|
||||
* This function shuts down all things set up in ecore_init() and cleans up all
|
||||
* event queues, handlers, filters, timers, idlers, idle enterers/exiters
|
||||
* etc. set up after ecore_init() was called.
|
||||
|
|
|
@ -669,7 +669,8 @@ _ecore_getopt_help_options(FILE *fp,
|
|||
/**
|
||||
* Show nicely formatted help message for the given parser.
|
||||
*
|
||||
* Message will be print to stderr.
|
||||
* @param fp The file the message will be printed on.
|
||||
* @param parser The parser to be used.
|
||||
*/
|
||||
EAPI void
|
||||
ecore_getopt_help(FILE *fp,
|
||||
|
@ -1675,6 +1676,7 @@ _ecore_getopt_parse_find_long_other(const Ecore_Getopt *parser,
|
|||
* Check 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)
|
||||
|
@ -1861,7 +1863,10 @@ ecore_getopt_list_free(Eina_List *list)
|
|||
/**
|
||||
* Helper ecore_getopt callback to parse geometry (x:y:w:h).
|
||||
*
|
||||
* @param parser This parameter isn't in use.
|
||||
* @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
|
||||
* store the four values passed in the given string.
|
||||
* @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect geometry value.
|
||||
|
@ -1889,7 +1894,10 @@ ecore_getopt_callback_geometry_parse(const Ecore_Getopt *parser __UNUSED__,
|
|||
/**
|
||||
* Helper ecore_getopt callback to parse geometry size (WxH).
|
||||
*
|
||||
* @param parser This parameter isn't in use.
|
||||
* @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
|
||||
* store the two values passed in the given string and @c 0 in the x and y
|
||||
* fields.
|
||||
|
|
|
@ -969,6 +969,7 @@ ecore_main_loop_quit(void)
|
|||
*
|
||||
* @warning you don't know how to use, don't even try to use it.
|
||||
*
|
||||
* @param func The function to be used.
|
||||
*/
|
||||
EAPI void
|
||||
ecore_main_loop_select_func_set(Ecore_Select_Function func)
|
||||
|
|
|
@ -250,7 +250,7 @@ typedef struct _Ecore_Con_Url Ecore_Con_Url;
|
|||
|
||||
|
||||
/**
|
||||
* @addtogroup Ecore_Con_Events_Group Events
|
||||
* @addtogroup Ecore_Con_Events_Group
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@ -1691,7 +1691,8 @@ EAPI void ecore_con_url_verbose_set(Ecore_Con_Url *url_con,
|
|||
Eina_Bool verbose);
|
||||
/**
|
||||
* Enable or disable EPSV extension
|
||||
* @return FIXME: To be more documented.
|
||||
* @param url_con The Ecore_Con_Url instance which will be acted upon.
|
||||
* @param use_epsv Boolean to enable/disable the EPSV extension.
|
||||
*/
|
||||
EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con,
|
||||
Eina_Bool use_epsv);
|
||||
|
|
Loading…
Reference in New Issue