fix more doc warnings.

SVN revision: 66670
This commit is contained in:
Carsten Haitzler 2011-12-30 08:23:04 +00:00
parent ca76e07b66
commit 2f1ed9100d
7 changed files with 33 additions and 31 deletions

View File

@ -32,7 +32,7 @@
* @{
*/
typedef enum _Elm_Ctxpopup_Direction
typedef enum
{
ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked area */
ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of the clicked area */
@ -49,9 +49,7 @@ typedef enum _Elm_Ctxpopup_Direction
*
* @ingroup Ctxpopup
*/
EAPI Evas_Object *
elm_ctxpopup_add(Evas_Object *parent)
EINA_ARG_NONNULL(1);
EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
* @brief Set the Ctxpopup's parent

View File

@ -8,7 +8,7 @@
/**
* Print Tree object hierarchy in stdout
*
* @param obj The root object
* @param top The root object
* @ingroup Debug
*/
EAPI void elm_object_tree_dump(const Evas_Object *top);

View File

@ -395,7 +395,7 @@ EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item
/**
* Get the icon associated to the item.
*
* @param it The diskselector item
* @param item The diskselector item
* @return The icon associated to @p it
*
* The return value is a pointer to the icon associated to @p item when it was

View File

@ -7,14 +7,14 @@ typedef enum _Elm_Text_Format
/**
* Line wrapping types.
*/
typedef enum _Elm_Wrap_Type
typedef enum
{
ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
ELM_WRAP_LAST
} Elm_Wrap_Type;
} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
typedef enum
{
@ -27,15 +27,15 @@ typedef enum
ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
ELM_INPUT_PANEL_LAYOUT_INVALID // XXX: remove this so we can expand
} Elm_Input_Panel_Layout;
} Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use */
typedef enum
{
ELM_AUTOCAPITAL_TYPE_NONE,
ELM_AUTOCAPITAL_TYPE_WORD,
ELM_AUTOCAPITAL_TYPE_SENTENCE,
ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
} Elm_Autocapital_Type;
ELM_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing */
ELM_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed */
ELM_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence */
ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
/**
* @defgroup Entry Entry
@ -56,7 +56,7 @@ typedef enum
*
* They can also be single line or multi line (the default) and when set
* to multi line mode they support text wrapping in any of the modes
* indicated by #Elm_Wrap_Type.
* indicated by Elm_Wrap_Type.
*
* Other features include password mode, filtering of inserted text with
* elm_entry_text_filter_append() and related functions, inline "items" and
@ -498,7 +498,7 @@ EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *ent
* Set the line wrap type to use on multi-line entries.
*
* Sets the wrap type used by the entry to any of the specified in
* #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
* Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
* line (without inserting a line break or paragraph separator) when it
* reaches the far edge of the widget.
*
@ -506,7 +506,7 @@ EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *ent
* to be single line will never wrap.
*
* @param obj The entry object
* @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
* @param wrap The wrap mode to use. See Elm_Wrap_Type for details on them
*/
EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
@ -1104,8 +1104,8 @@ EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scr
* the end of the contained entry.
*
* @param obj The scrolled entry object
* @param h The horizontal bounce state
* @param v The vertical bounce state
* @param h_bounce The horizontal bounce state
* @param v_bounce The vertical bounce state
*/
EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);

View File

@ -22,7 +22,7 @@
*
* @{
*/
typedef enum _Elm_Flip_Mode
typedef enum
{
ELM_FLIP_ROTATE_Y_CENTER_AXIS,
ELM_FLIP_ROTATE_X_CENTER_AXIS,
@ -37,14 +37,16 @@ typedef enum _Elm_Flip_Mode
ELM_FLIP_PAGE_UP,
ELM_FLIP_PAGE_DOWN
} Elm_Flip_Mode;
typedef enum _Elm_Flip_Interaction
typedef enum
{
ELM_FLIP_INTERACTION_NONE,
ELM_FLIP_INTERACTION_ROTATE,
ELM_FLIP_INTERACTION_CUBE,
ELM_FLIP_INTERACTION_PAGE
} Elm_Flip_Interaction;
typedef enum _Elm_Flip_Direction
typedef enum
{
ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
@ -58,9 +60,7 @@ typedef enum _Elm_Flip_Direction
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*/
EAPI Evas_Object *
elm_flip_add(Evas_Object *parent)
EINA_ARG_NONNULL(1);
EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
* @brief Set the front content of the flip widget.

View File

@ -43,8 +43,9 @@ EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
/**
* Set the enable status of the focus highlight
*
* Set whether to show or not the highlight on focused objects
* @param enable Enable highlight if EINA_TRUE, disable otherwise
*
* Set whether to show or not the highlight on focused objects
* @ingroup Focus
*/
EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
@ -52,8 +53,11 @@ EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
/**
* Get the enable status of the highlight animation
*
* @return The focus hilight mode set
*
* Get whether the focus highlight, if enabled, will animate its switch from
* one object to the next
*
* @ingroup Focus
*/
EAPI Eina_Bool elm_focus_highlight_animate_get(void);
@ -61,9 +65,11 @@ EAPI Eina_Bool elm_focus_highlight_animate_get(void);
/**
* Set the enable status of the highlight animation
*
* @param animate Enable animation if EINA_TRUE, disable otherwise
*
* Set whether the focus highlight, if enabled, will animate its switch from
* one object to the next
* @param animate Enable animation if EINA_TRUE, disable otherwise
*
* @ingroup Focus
*/
EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
@ -79,9 +85,7 @@ EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
*
* @ingroup Focus
*/
EAPI Eina_Bool
elm_object_focus_get(const Evas_Object *obj)
EINA_ARG_NONNULL(1);
EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
* Set/unset focus to a given Elementary object.

View File

@ -1,5 +1,5 @@
/**
* @defgroup GLView
* @defgroup GLView GLView
*
* A simple GLView widget that allows GL rendering.
*