seoz pushed a commit to branch master.
http://git.enlightenment.org/core/elementary.git/commit/?id=de812da16100e41271eb91ad2722cdc3fbe12988
commit de812da16100e41271eb91ad2722cdc3fbe12988
Author: Daniel Juyung Seo <seojuyu...@gmail.com>
Date: Sat Nov 22 00:37:08 2014 +0900
thumb, toolbar, web: Fix and clean up doxygen documentation.
---
src/lib/elm_thumb_common.h | 13 +++++++++----
src/lib/elm_toolbar_common.h | 17 +++++++++--------
src/lib/elm_web_common.h | 31 ++++++++++---------------------
3 files changed, 28 insertions(+), 33 deletions(-)
diff --git a/src/lib/elm_thumb_common.h b/src/lib/elm_thumb_common.h
index d61ff10..f569d21 100644
--- a/src/lib/elm_thumb_common.h
+++ b/src/lib/elm_thumb_common.h
@@ -1,10 +1,14 @@
/**
+ * @addtogroup Thumb
+ *
+ * @{
+ */
+
+/**
* @enum Elm_Thumb_Animation_Setting
* @typedef Elm_Thumb_Animation_Setting
*
* Used to set if a video thumbnail is animating or not.
- *
- * @ingroup Thumb
*/
typedef enum
{
@@ -22,8 +26,6 @@ typedef enum
* The ethumb client handle returned may or may not be NULL. It may or may
* not survive into the future (ethumbd may become disconnected). Do not use
* this unless you know what you are doing.
- *
- * @ingroup Thumb
*/
EAPI void *elm_thumb_ethumb_client_get(void);
@@ -35,3 +37,6 @@ EAPI void
*elm_thumb_ethumb_client_get(void);
*/
EAPI Eina_Bool elm_thumb_ethumb_client_connected_get(void);
+/**
+ * @}
+ */
diff --git a/src/lib/elm_toolbar_common.h b/src/lib/elm_toolbar_common.h
index d15a9a2..0e300f4 100644
--- a/src/lib/elm_toolbar_common.h
+++ b/src/lib/elm_toolbar_common.h
@@ -1,7 +1,10 @@
/**
- * @enum Elm_Toolbar_Shrink_Mode
- * @typedef Elm_Toolbar_Shrink_Mode
+ * @addtogroup Toolbar
*
+ * @{
+ */
+
+/**
* Set toolbar's items display behavior, it can be scrollable,
* show a menu with exceeding items, or simply hide them.
*
@@ -12,8 +15,6 @@
*
* @see elm_toolbar_shrink_mode_set()
* @see elm_toolbar_shrink_mode_get()
- *
- * @ingroup Toolbar
*/
typedef enum
{
@@ -27,8 +28,6 @@ typedef enum
/**
* Defines where to position the item in the toolbar.
- *
- * @ingroup Toolbar
*/
typedef enum
{
@@ -49,7 +48,9 @@ typedef struct _Elm_Toolbar_Item_State
Elm_Toolbar_Item_State; /**< State of
* The default icon and label from this item will be displayed.
*
* @see elm_toolbar_item_state_set() for more details.
- *
- * @ingroup Toolbar
*/
EAPI void elm_toolbar_item_state_unset(Elm_Object_Item
*it);
+
+/**
+ * @}
+ */
diff --git a/src/lib/elm_web_common.h b/src/lib/elm_web_common.h
index ee57863..879b927 100644
--- a/src/lib/elm_web_common.h
+++ b/src/lib/elm_web_common.h
@@ -1,4 +1,10 @@
/**
+ * @addtogroup Web
+ *
+ * @{
+ */
+
+/**
* Structure used to report load errors.
*
* Load errors are reported as signal by elm_web. All the strings are
@@ -70,8 +76,6 @@ struct _Elm_Web_Menu_Item
*
* @see elm_web_popup_selected_set()
* @see elm_web_popup_destroy()
- *
- * @ingroup Web
*/
typedef struct _Elm_Web_Menu Elm_Web_Menu;
@@ -91,8 +95,6 @@ typedef struct _Elm_Web_Menu Elm_Web_Menu;
*
* @see elm_web_popup_selected_set()
* @see elm_web_popup_destroy()
- *
- * @ingroup Web
*/
struct _Elm_Web_Menu
{
@@ -128,7 +130,6 @@ typedef enum
*/
typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
-
/**
* Definitions of web window features.
*
@@ -159,8 +160,6 @@ typedef enum
* the request.
*
* @see elm_web_window_create_hook_set()
- *
- * @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj,
Eina_Bool js, const Elm_Web_Window_Features *window_features);
@@ -179,8 +178,6 @@ typedef Evas_Object *(*Elm_Web_Window_Open)(void *data,
Evas_Object *obj, Eina_B
* If the function returns @c NULL the popup will be ignored.
*
* @see elm_web_dialog_alert_hook_set()
- *
- * @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj,
const char *message);
@@ -201,8 +198,6 @@ typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data,
Evas_Object *obj, const
* If the function returns @c NULL the popup will be ignored.
*
* @see elm_web_dialog_confirm_hook_set()
- *
- * @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj,
const char *message, Eina_Bool *ret);
@@ -226,8 +221,6 @@ typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data,
Evas_Object *obj, con
* If the function returns @c NULL the popup will be ignored.
*
* @see elm_web_dialog_prompt_hook_set()
- *
- * @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj,
const char *message, const char *def_value, const char **value, Eina_Bool *ret);
@@ -252,8 +245,6 @@ typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data,
Evas_Object *obj, cons
* If the function returns @c NULL the popup will be ignored.
*
* @see elm_web_dialog_file selector_hook_set()
- *
- * @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object
*obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected,
Eina_Bool *ret);
@@ -271,8 +262,6 @@ typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void
*data, Evas_Object *ob
* @param source_id Source id.
*
* @see elm_web_console_message_hook_set()
- *
- * @ingroup Web
*/
typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const
char *message, unsigned int line_number, const char *source_id);
@@ -284,8 +273,6 @@ typedef void (*Elm_Web_Console_Message)(void *data,
Evas_Object *obj, const char
* @param flag The web window feature flag whose value is required.
*
* @return @c EINA_TRUE if the flag is set, @c EINA_FALSE otherwise
- *
- * @ingroup Web
*/
EAPI Eina_Bool elm_web_window_features_property_get(const
Elm_Web_Window_Features *wf, Elm_Web_Window_Feature_Flag flag);
@@ -295,10 +282,12 @@ EAPI Eina_Bool
elm_web_window_features_property_get(const Elm_Web_W
*
* @param wf The web window features object
* @param x, y, w, h - the co-ordinates of the web view window.
- *
- * @ingroup Web
*/
EAPI void elm_web_window_features_region_get(const
Elm_Web_Window_Features *wf, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w,
Evas_Coord *h);
EAPI void elm_web_window_features_ref(Elm_Web_Window_Features
*wf);
EAPI void elm_web_window_features_unref(Elm_Web_Window_Features
*wf);
+
+/**
+ * @}
+ */
--
