forked from enlightenment/efl
Cleanup Doxygen Warnings - ecore 3
Files modified: ecore/src/lib/ecore_file/Ecore_File.h ecore/src/lib/ecore_file/ecore_file_monitor.c ecore/src/lib/ecore_imf/Ecore_IMF.h ecore/src/lib/ecore_imf/ecore_imf_context.c SVN revision: 70423
This commit is contained in:
parent
d6350e7bc2
commit
66a0714619
|
@ -62,7 +62,7 @@ typedef struct _Ecore_File_Monitor Ecore_File_Monitor;
|
||||||
typedef struct _Ecore_File_Download_Job Ecore_File_Download_Job;
|
typedef struct _Ecore_File_Download_Job Ecore_File_Download_Job;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef Ecore_File_Event
|
* @typedef _Ecore_File_Event
|
||||||
* The event type returned when a file or directory is monitored.
|
* The event type returned when a file or directory is monitored.
|
||||||
*/
|
*/
|
||||||
typedef enum _Ecore_File_Event
|
typedef enum _Ecore_File_Event
|
||||||
|
@ -90,7 +90,7 @@ typedef void (*Ecore_File_Monitor_Cb)(void *data, Ecore_File_Monitor *em, Ecore_
|
||||||
typedef void (*Ecore_File_Download_Completion_Cb)(void *data, const char *file, int status);
|
typedef void (*Ecore_File_Download_Completion_Cb)(void *data, const char *file, int status);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef Ecore_File_Progress_Return
|
* @typedef _Ecore_File_Progress_Return
|
||||||
* What to do with the download as a return from the
|
* What to do with the download as a return from the
|
||||||
* Ecore_File_Download_Progress_Cb function, if provided.
|
* Ecore_File_Download_Progress_Cb function, if provided.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -85,7 +85,7 @@ ecore_file_monitor_shutdown(void)
|
||||||
* notification or polling) is available, or if @p path is not a file,
|
* notification or polling) is available, or if @p path is not a file,
|
||||||
* the function returns @c NULL. Otherwise, it returns a newly
|
* the function returns @c NULL. Otherwise, it returns a newly
|
||||||
* allocated Ecore_File_Monitor object and the monitoring begins. When
|
* allocated Ecore_File_Monitor object and the monitoring begins. When
|
||||||
* one of the #Ecore_File_Event event is notified, @p func is called
|
* one of the Ecore_File_Event event is notified, @p func is called
|
||||||
* and @p data is passed to @p func. Call ecore_file_monitor_del() to
|
* and @p data is passed to @p func. Call ecore_file_monitor_del() to
|
||||||
* stop the monitoring.
|
* stop the monitoring.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -106,7 +106,10 @@ typedef enum
|
||||||
ECORE_IMF_EVENT_KEY_DOWN, /**< Key Down event */
|
ECORE_IMF_EVENT_KEY_DOWN, /**< Key Down event */
|
||||||
ECORE_IMF_EVENT_KEY_UP /**< Key Up event */
|
ECORE_IMF_EVENT_KEY_UP /**< Key Up event */
|
||||||
} Ecore_IMF_Event_Type;
|
} Ecore_IMF_Event_Type;
|
||||||
|
/**
|
||||||
|
* @typedef Ecore_IMF_Keyboard_Modifiers
|
||||||
|
* Type for Ecore_IMF keyboard modifiers
|
||||||
|
*/
|
||||||
typedef enum
|
typedef enum
|
||||||
{
|
{
|
||||||
ECORE_IMF_KEYBOARD_MODIFIER_NONE = 0, /**< No active modifiers */
|
ECORE_IMF_KEYBOARD_MODIFIER_NONE = 0, /**< No active modifiers */
|
||||||
|
@ -116,6 +119,10 @@ typedef enum
|
||||||
ECORE_IMF_KEYBOARD_MODIFIER_WIN = 1 << 3 /**< "Win" (between "Ctrl" and "Alt") is pressed */
|
ECORE_IMF_KEYBOARD_MODIFIER_WIN = 1 << 3 /**< "Win" (between "Ctrl" and "Alt") is pressed */
|
||||||
} Ecore_IMF_Keyboard_Modifiers;
|
} Ecore_IMF_Keyboard_Modifiers;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef Ecore_IMF_Keyboard_Locks
|
||||||
|
* Type for Ecore_IMF keyboard locks
|
||||||
|
*/
|
||||||
typedef enum
|
typedef enum
|
||||||
{
|
{
|
||||||
ECORE_IMF_KEYBOARD_LOCK_NONE = 0, /**< No locks are active */
|
ECORE_IMF_KEYBOARD_LOCK_NONE = 0, /**< No locks are active */
|
||||||
|
@ -123,7 +130,10 @@ typedef enum
|
||||||
ECORE_IMF_KEYBOARD_LOCK_CAPS = 1 << 1, /**< "Caps" lock is active */
|
ECORE_IMF_KEYBOARD_LOCK_CAPS = 1 << 1, /**< "Caps" lock is active */
|
||||||
ECORE_IMF_KEYBOARD_LOCK_SCROLL = 1 << 2 /**< "Scroll" lock is active */
|
ECORE_IMF_KEYBOARD_LOCK_SCROLL = 1 << 2 /**< "Scroll" lock is active */
|
||||||
} Ecore_IMF_Keyboard_Locks;
|
} Ecore_IMF_Keyboard_Locks;
|
||||||
|
/**
|
||||||
|
* @typedef Ecore_IMF_Mouse_Flags
|
||||||
|
* Type for Ecore_IMF mouse flags
|
||||||
|
*/
|
||||||
typedef enum
|
typedef enum
|
||||||
{
|
{
|
||||||
ECORE_IMF_MOUSE_NONE = 0, /**< A single click */
|
ECORE_IMF_MOUSE_NONE = 0, /**< A single click */
|
||||||
|
|
|
@ -801,7 +801,7 @@ ecore_imf_context_retrieve_surrounding_callback_set(Ecore_IMF_Context *ctx, Eina
|
||||||
* Set the input mode used by the Ecore Input Context.
|
* Set the input mode used by the Ecore Input Context.
|
||||||
*
|
*
|
||||||
* The input mode can be one of the input modes defined in
|
* The input mode can be one of the input modes defined in
|
||||||
* #Ecore_IMF_Input_Mode. The default input mode is
|
* Ecore_IMF_Input_Mode. The default input mode is
|
||||||
* ECORE_IMF_INPUT_MODE_FULL.
|
* ECORE_IMF_INPUT_MODE_FULL.
|
||||||
*
|
*
|
||||||
* @param ctx An #Ecore_IMF_Context.
|
* @param ctx An #Ecore_IMF_Context.
|
||||||
|
@ -979,7 +979,7 @@ EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx)
|
||||||
* set using #ecore_imf_context_retrieve_surrounding_callback_set).
|
* set using #ecore_imf_context_retrieve_surrounding_callback_set).
|
||||||
*
|
*
|
||||||
* There is no obligation for a widget to respond to the
|
* There is no obligation for a widget to respond to the
|
||||||
* ::retrieve_surrounding_func, so input methods must be prepared
|
* retrieve_surrounding_func, so input methods must be prepared
|
||||||
* to function without context.
|
* to function without context.
|
||||||
*
|
*
|
||||||
* @param ctx An #Ecore_IMF_Context.
|
* @param ctx An #Ecore_IMF_Context.
|
||||||
|
|
Loading…
Reference in New Issue