From 5663cc502c55f0cd4c6506e239a79015da3adf4c Mon Sep 17 00:00:00 2001 From: gastal Date: Mon, 23 Apr 2012 20:09:51 +0000 Subject: [PATCH] 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 git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/ecore@70423 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- src/lib/ecore_file/Ecore_File.h | 4 ++-- src/lib/ecore_file/ecore_file_monitor.c | 2 +- src/lib/ecore_imf/Ecore_IMF.h | 14 ++++++++++++-- src/lib/ecore_imf/ecore_imf_context.c | 4 ++-- 4 files changed, 17 insertions(+), 7 deletions(-) diff --git a/src/lib/ecore_file/Ecore_File.h b/src/lib/ecore_file/Ecore_File.h index e4b8851..30f3bd7 100644 --- a/src/lib/ecore_file/Ecore_File.h +++ b/src/lib/ecore_file/Ecore_File.h @@ -62,7 +62,7 @@ typedef struct _Ecore_File_Monitor Ecore_File_Monitor; 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. */ 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 Ecore_File_Progress_Return + * @typedef _Ecore_File_Progress_Return * What to do with the download as a return from the * Ecore_File_Download_Progress_Cb function, if provided. */ diff --git a/src/lib/ecore_file/ecore_file_monitor.c b/src/lib/ecore_file/ecore_file_monitor.c index 7c334c0..8b07589 100644 --- a/src/lib/ecore_file/ecore_file_monitor.c +++ b/src/lib/ecore_file/ecore_file_monitor.c @@ -85,7 +85,7 @@ ecore_file_monitor_shutdown(void) * notification or polling) is available, or if @p path is not a file, * the function returns @c NULL. Otherwise, it returns a newly * 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 * stop the monitoring. */ diff --git a/src/lib/ecore_imf/Ecore_IMF.h b/src/lib/ecore_imf/Ecore_IMF.h index 9144d70..4e723cd 100644 --- a/src/lib/ecore_imf/Ecore_IMF.h +++ b/src/lib/ecore_imf/Ecore_IMF.h @@ -106,7 +106,10 @@ typedef enum ECORE_IMF_EVENT_KEY_DOWN, /**< Key Down event */ ECORE_IMF_EVENT_KEY_UP /**< Key Up event */ } Ecore_IMF_Event_Type; - +/** + * @typedef Ecore_IMF_Keyboard_Modifiers + * Type for Ecore_IMF keyboard modifiers + */ typedef enum { 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_Modifiers; +/** + * @typedef Ecore_IMF_Keyboard_Locks + * Type for Ecore_IMF keyboard locks + */ typedef enum { 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_SCROLL = 1 << 2 /**< "Scroll" lock is active */ } Ecore_IMF_Keyboard_Locks; - +/** + * @typedef Ecore_IMF_Mouse_Flags + * Type for Ecore_IMF mouse flags + */ typedef enum { ECORE_IMF_MOUSE_NONE = 0, /**< A single click */ diff --git a/src/lib/ecore_imf/ecore_imf_context.c b/src/lib/ecore_imf/ecore_imf_context.c index 44c52c0..4eb065f 100644 --- a/src/lib/ecore_imf/ecore_imf_context.c +++ b/src/lib/ecore_imf/ecore_imf_context.c @@ -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. * * 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. * * @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). * * 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. * * @param ctx An #Ecore_IMF_Context. -- 2.7.4