elementary: fix some doxygen warnings
SVN revision: 68112
This commit is contained in:
parent
8922f83418
commit
1e34a3e568
|
@ -105,7 +105,7 @@ EAPI Eina_Bool elm_cnp_selection_get(Elm_Sel_Type selection,
|
|||
* @see also elm_cnp_selection_set()
|
||||
*
|
||||
* @param selection Selection type for copying and pasting
|
||||
* @param widget The source widget pointer
|
||||
* @param obj The source widget pointer
|
||||
* @return If EINA_TRUE, clearing data is success.
|
||||
*
|
||||
* @ingroup CopyPaste
|
||||
|
|
|
@ -1928,7 +1928,7 @@ EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(
|
|||
/**
|
||||
* Return the data associated with a given index widget item
|
||||
*
|
||||
* @param it The index widget item handle
|
||||
* @param item The index widget item handle
|
||||
* @return The data associated with @p it
|
||||
* @deprecated Use elm_object_item_data_get() instead
|
||||
*
|
||||
|
@ -2977,7 +2977,7 @@ EINA_DEPRECATED EAPI const char *elm_toolbar_item_label_get(const Elm_Object_It
|
|||
* Set the label of item.
|
||||
*
|
||||
* @param it The item of toolbar.
|
||||
* @param text The label of item.
|
||||
* @param label The label of item.
|
||||
*
|
||||
* The label to be displayed by the item.
|
||||
* Label will be placed at icons bottom (if set).
|
||||
|
@ -3798,7 +3798,7 @@ EINA_DEPRECATED EAPI void elm_list_item_tooltip_style_se
|
|||
/**
|
||||
* Get the style for this item tooltip.
|
||||
*
|
||||
* @param item list item with tooltip already set.
|
||||
* @param it list item with tooltip already set.
|
||||
* @return style the theme style in use, defaults to "default". If the
|
||||
* object does not have a tooltip set, then NULL is returned.
|
||||
*
|
||||
|
|
|
@ -17,7 +17,7 @@
|
|||
*
|
||||
* 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_markup_filter_append() and related functions, inline "items" and
|
||||
|
|
|
@ -783,8 +783,8 @@ EAPI void elm_gengrid_page_relative_get(const Evas_Obje
|
|||
* Set a given gengrid widget's scrolling page size
|
||||
*
|
||||
* @param obj The gengrid object
|
||||
* @param h_pagerel The horizontal page size, in pixels
|
||||
* @param v_pagerel The vertical page size, in pixels
|
||||
* @param h_pagesize The horizontal page size, in pixels
|
||||
* @param v_pagesize The vertical page size, in pixels
|
||||
*
|
||||
* The gengrid's scroller is capable of binding scrolling by the
|
||||
* user to "pages". It means that, while scrolling and, specially
|
||||
|
|
|
@ -614,7 +614,7 @@ EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Obje
|
|||
* Enable/disable height-for-width mode.
|
||||
*
|
||||
* @param obj The genlist object
|
||||
* @param setting The height-for-width mode (@c EINA_TRUE = on,
|
||||
* @param height_for_width The height-for-width mode (@c EINA_TRUE = on,
|
||||
* @c EINA_FALSE = off). Default is @c EINA_FALSE.
|
||||
*
|
||||
* With height-for-width mode the item width will be fixed (restricted
|
||||
|
@ -1712,7 +1712,7 @@ EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const
|
|||
/**
|
||||
* Get the index of the item. It is only valid once displayed.
|
||||
*
|
||||
* @param item a genlist item
|
||||
* @param it a genlist item
|
||||
* @return the position inside the list of item.
|
||||
*
|
||||
* @ingroup Genlist
|
||||
|
@ -1740,8 +1740,8 @@ EAPI void elm_genlist_realized_items_update(Evas_Object
|
|||
/**
|
||||
* Activate a genlist mode on an item
|
||||
*
|
||||
* @param item The genlist item
|
||||
* @param mode Mode name
|
||||
* @param it The genlist item
|
||||
* @param mode_type Mode name
|
||||
* @param mode_set Boolean to define set or unset mode.
|
||||
*
|
||||
* A genlist mode is a different way of selecting an item. Once a mode is
|
||||
|
@ -1836,7 +1836,7 @@ EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Objec
|
|||
/**
|
||||
* Get the Item's Flags
|
||||
*
|
||||
* @param item The genlist item
|
||||
* @param it The genlist item
|
||||
* @return The item flags.
|
||||
*
|
||||
* This function returns the item's type. Normally the item's type.
|
||||
|
|
|
@ -475,7 +475,7 @@ EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *ob
|
|||
* Set animation mode of the icon.
|
||||
*
|
||||
* @param obj The icon object
|
||||
* @param anim @c EINA_TRUE if the object do animation job,
|
||||
* @param animated @c EINA_TRUE if the object do animation job,
|
||||
* @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
|
||||
*
|
||||
* Since the default animation mode is set to EINA_FALSE,
|
||||
|
|
|
@ -278,7 +278,7 @@ EAPI void elm_index_item_go(Evas_Object *obj, int level);
|
|||
/**
|
||||
* Get the letter (string) set on a given index widget item.
|
||||
*
|
||||
* @param it The index item handle
|
||||
* @param item The index item handle
|
||||
* @return The letter string set on @p it
|
||||
*
|
||||
* @ingroup Index
|
||||
|
|
|
@ -481,7 +481,7 @@ EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Obje
|
|||
* (longitude, latitude).
|
||||
*
|
||||
* @param obj The map object.
|
||||
* @param name The address.
|
||||
* @param address The address.
|
||||
* @return name A #Elm_Map_Name handle for this address.
|
||||
*
|
||||
* To get the longitude and latitude, elm_map_name_region_get()
|
||||
|
@ -521,7 +521,7 @@ EAPI void elm_map_canvas_to_geo_convert(const Evas_Object *obj,
|
|||
* @param obj The map object.
|
||||
* @param lon The longitude of the marker.
|
||||
* @param lat The latitude of the marker.
|
||||
* @param class The class, to use when marker @b isn't grouped to others.
|
||||
* @param clas The class, to use when marker @b isn't grouped to others.
|
||||
* @param class_group The class group, to use when marker is grouped to others
|
||||
* @param data The data passed to the callbacks.
|
||||
*
|
||||
|
@ -759,7 +759,7 @@ EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj);
|
|||
/**
|
||||
* Set the marker's style of a group class.
|
||||
*
|
||||
* @param class The group class.
|
||||
* @param clas The group class.
|
||||
* @param style The style to be used by markers.
|
||||
*
|
||||
* Each marker must be associated to a group class, and will use the style
|
||||
|
@ -780,7 +780,7 @@ EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *cl
|
|||
/**
|
||||
* Set the icon callback function of a group class.
|
||||
*
|
||||
* @param class The group class.
|
||||
* @param clas The group class.
|
||||
* @param icon_get The callback function that will return the icon.
|
||||
*
|
||||
* Each marker must be associated to a group class, and it can display a
|
||||
|
@ -796,7 +796,7 @@ EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *
|
|||
/**
|
||||
* Set the data associated to the group class.
|
||||
*
|
||||
* @param class The group class.
|
||||
* @param clas The group class.
|
||||
* @param data The new user data.
|
||||
*
|
||||
* This data will be passed for callback functions, like icon get callback,
|
||||
|
@ -1004,7 +1004,7 @@ EAPI const char **elm_map_source_names_get(const Evas_Object *obj);
|
|||
* Set the source of the map.
|
||||
*
|
||||
* @param obj The map object.
|
||||
* @param source The source to be used.
|
||||
* @param source_name The source to be used.
|
||||
*
|
||||
* Map widget retrieves images that composes the map from a web service.
|
||||
* This web service can be set with this method.
|
||||
|
|
|
@ -60,7 +60,7 @@ EAPI Evas_Object *elm_notify_add(Evas_Object *parent);
|
|||
* @brief Set the notify parent
|
||||
*
|
||||
* @param obj The notify object
|
||||
* @param content The new parent
|
||||
* @param parent The new parent
|
||||
*
|
||||
* Once the parent object is set, a previously set one will be disconnected
|
||||
* and replaced.
|
||||
|
@ -104,7 +104,7 @@ EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj);
|
|||
* hidden.
|
||||
*
|
||||
* @param obj The notify object
|
||||
* @param time The timeout in seconds
|
||||
* @param timeout The timeout in seconds
|
||||
*
|
||||
* This function sets a timeout and starts the timer controlling when the
|
||||
* notify is hidden. Since calling evas_object_show() on a notify restarts
|
||||
|
@ -132,7 +132,7 @@ EAPI double elm_notify_timeout_get(const Evas_Object *obj)
|
|||
* its area.
|
||||
*
|
||||
* @param obj The notify object
|
||||
* @param repeats EINA_TRUE Events are repeats, else no
|
||||
* @param repeat EINA_TRUE Events are repeats, else no
|
||||
*
|
||||
* When true if the user clicks outside the window the events will be caught
|
||||
* by the others widgets, else the events are blocked.
|
||||
|
|
|
@ -131,7 +131,7 @@ EAPI void elm_object_item_signal_emit(Elm_Object_Item *i
|
|||
/**
|
||||
* Set the disabled state of an widget item.
|
||||
*
|
||||
* @param obj The Elementary object item
|
||||
* @param it The Elementary object item
|
||||
* @param disabled The state to put in in: @c EINA_TRUE for
|
||||
* disabled, @c EINA_FALSE for enabled
|
||||
*
|
||||
|
@ -151,7 +151,7 @@ EAPI void elm_object_item_disabled_set(Elm_Object_Item *
|
|||
/**
|
||||
* Get the disabled state of an widget item.
|
||||
*
|
||||
* @param obj The Elementary object
|
||||
* @param it The Elementary object item
|
||||
* @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
|
||||
* if it's enabled (or on errors)
|
||||
*
|
||||
|
@ -166,7 +166,7 @@ EAPI Eina_Bool elm_object_item_disabled_get(const Elm_Object_
|
|||
* freed.
|
||||
*
|
||||
* @param it The item to set the callback on
|
||||
* @param func The function called
|
||||
* @param del_cb The function called
|
||||
*
|
||||
* That function will receive these parameters:
|
||||
* @li void * item data
|
||||
|
|
|
@ -46,7 +46,7 @@ EAPI Evas_Object *elm_panel_add(Evas_Object *parent);
|
|||
/**
|
||||
* @brief Sets the orientation of the panel
|
||||
*
|
||||
* @param parent The parent object
|
||||
* @param obj The panel object
|
||||
* @param orient The panel orientation. Can be one of the following:
|
||||
* @li ELM_PANEL_ORIENT_TOP
|
||||
* @li ELM_PANEL_ORIENT_LEFT
|
||||
|
@ -76,7 +76,7 @@ EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bo
|
|||
* @brief Get the state of the panel.
|
||||
*
|
||||
* @param obj The panel object
|
||||
* @param hidden If true, the panel is in the "hide" state
|
||||
* @return EINA_TRUE if it is hidden state
|
||||
*/
|
||||
EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj);
|
||||
|
||||
|
|
|
@ -376,7 +376,7 @@ EAPI Elm_Object_Item *elm_slideshow_item_current_get(const Evas_Object *obj
|
|||
* Get the real Evas object created to implement the view of a
|
||||
* given slideshow item
|
||||
*
|
||||
* @param item The slideshow item.
|
||||
* @param it The slideshow item.
|
||||
* @return the Evas object implementing this item's view.
|
||||
*
|
||||
* This returns the actual Evas object used to implement the
|
||||
|
|
|
@ -148,7 +148,7 @@ EAPI void elm_thumb_path_get(const Evas_Object *obj, cons
|
|||
* looping.
|
||||
*
|
||||
* @param obj The thumb object.
|
||||
* @param setting The animation setting.
|
||||
* @param s The animation setting.
|
||||
*
|
||||
* @see elm_thumb_file_set()
|
||||
*
|
||||
|
@ -231,7 +231,7 @@ EAPI Eina_Bool elm_thumb_ethumb_client_connected_get(void);
|
|||
* Make the thumbnail 'editable'.
|
||||
*
|
||||
* @param obj Thumb object.
|
||||
* @param set Turn on or off editability. Default is @c EINA_FALSE.
|
||||
* @param edit Turn on or off editability. Default is @c EINA_FALSE.
|
||||
*
|
||||
* This means the thumbnail is a valid drag target for drag and drop, and can be
|
||||
* cut or pasted too.
|
||||
|
|
|
@ -142,7 +142,7 @@ EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_O
|
|||
* Set whether the toolbar should always have an item selected.
|
||||
*
|
||||
* @param obj The toolbar object.
|
||||
* @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
|
||||
* @param always_select @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
|
||||
* disable it.
|
||||
*
|
||||
* This will cause the toolbar to always have an item selected, and clicking
|
||||
|
@ -174,7 +174,7 @@ EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_
|
|||
* Set whether the toolbar items' should be selected by the user or not.
|
||||
*
|
||||
* @param obj The toolbar object.
|
||||
* @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
|
||||
* @param no_select @c EINA_TRUE to disable selection or @c EINA_FALSE to
|
||||
* enable it.
|
||||
*
|
||||
* This will turn off the ability to select items entirely and they will
|
||||
|
@ -502,7 +502,6 @@ EAPI Elm_Object_Item *elm_toolbar_selected_item_get(const Evas_Objec
|
|||
/**
|
||||
* Set the icon associated with @p item.
|
||||
*
|
||||
* @param obj The parent of this item.
|
||||
* @param it The toolbar item.
|
||||
* @param icon A string with icon name or the absolute path of an image file.
|
||||
*
|
||||
|
|
|
@ -354,7 +354,7 @@ EAPI Evas_Object *elm_web_add(Evas_Object *parent);
|
|||
* Change useragent of a elm_web object
|
||||
*
|
||||
* @param obj The object
|
||||
* @param useragent String for useragent
|
||||
* @param user_agent String for useragent
|
||||
*
|
||||
*/
|
||||
EAPI void elm_web_useragent_set(Evas_Object *obj, const char *user_agent);
|
||||
|
@ -666,7 +666,7 @@ EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj
|
|||
* 0.0 and 1.0. This is an estimated progress accounting for all the frames
|
||||
* included in the page.
|
||||
*
|
||||
* @param The web object
|
||||
* @param obj The web object
|
||||
*
|
||||
* @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
|
||||
* failure
|
||||
|
|
Loading…
Reference in New Issue