NorwayFun
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

elementary: improve doc. 

Patch by Jérôme Pinot <ngc891@gmail.com>.

- #link on the beginning of a new line does give ugly output:
http://ngc891.blogdns.net/pub/projects/debug/doxygen-formating-eww.png
- some typos
- some missing @c
- in elm_web, convert remaining @li parameter lists to @param
- minor random fixes


SVN revision: 71486
This commit is contained in:
Cedric BAIL 2012-05-29 03:09:06 +00:00
parent 074e28cd4e
commit de165727bb
18 changed files with 183 additions and 184 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
legacy/elementary/doc/examples.dox
View File

@ -2420,10 +2420,10 @@
* We are just adding the list, so as you can see, defaults for it are: * We are just adding the list, so as you can see, defaults for it are:
* @li Items are displayed vertically. * @li Items are displayed vertically.
* @li Only one item can be selected. * @li Only one item can be selected.
* @li The list doesn't bouce. * @li The list doesn't bounce.
* *
* To add items, we are just appending it on a loop, using function * To add items, we are just appending it on a loop, using function
* elm_list_item_append(), that will be better exaplained on * elm_list_item_append(), that will be better explained on
* items management example. * items management example.
* @dontinclude list_example_01.c * @dontinclude list_example_01.c
* @skipline lbl[] * @skipline lbl[]

9
legacy/elementary/src/lib/elc_fileselector.h
View File

@ -276,11 +276,10 @@ EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj)
* (layout) file system entries in its view * (layout) file system entries in its view
* *
* @param obj The file selector object * @param obj The file selector object
* @param mode The mode of the fileselector, being it one of * @param mode The mode of the fileselector, being it one of #ELM_FILESELECTOR_LIST
* #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The * (default) or #ELM_FILESELECTOR_GRID. The first one, naturally, will display
* first one, naturally, will display the files in a list. The * the files in a list. The latter will make the widget to display its entries
* latter will make the widget to display its entries in a grid * in a grid form.
* form.
* *
* @note By using elm_fileselector_expandable_set(), the user may * @note By using elm_fileselector_expandable_set(), the user may
* trigger a tree view for that list. * trigger a tree view for that list.

18
legacy/elementary/src/lib/elc_popup.h
View File

@ -25,25 +25,25 @@
* *
* <pre> * <pre>
* *
* |-------------------- | |----------------- ---| |----------------- ---| * |---------------------| |---------------------| |---------------------|
* | Title Area | | Title Area | | Title Area | * | Title Area | | Title Area | | Title Area |
* |Icon| Text | |Icon| Text | |Icon| Text | * |Icon| Text | |Icon| Text | |Icon| Text |
* |------------------- -| |---------------- ----| |------------------ --| * |---------------------| |---------------------| |---------------------|
* | Item 1 | | | | | * | Item 1 | | | | |
* |------------------- -| | | | | * |---------------------| | | | |
* | Item 2 | | | | Description | * | Item 2 | | | | Description |
* |------------------ --| | Content | | | * |---------------------| | Content | | |
* | Item 3 | | | | | * | Item 3 | | | | |
* |------------------ --| | | | | * |---------------------| | | | |
* | . | |------------------ --| |------------------- -| * | . | |---------------------| |---------------------|
* | . | | Action Area | | Action Area | * | . | | Action Area | | Action Area |
* | . | | Btn1 |Btn2|. |Btn3 | | Btn1 |Btn2| |Btn3 | * | . | | Btn1 |Btn2|. |Btn3 | | Btn1 |Btn2| |Btn3 |
* |------------------ --| |------------------- -| |------------------- -| * |---------------------| |---------------------| |---------------------|
* | Item N | Content Based Layout Description based Layout * | Item N | Content Based Layout Description based Layout
* |------------------ --| * |---------------------|
* | Action Area | * | Action Area |
* | Btn1 |Btn2|. |Btn3 | * | Btn1 |Btn2|. |Btn3 |
* |------------------- -| * |---------------------|
* Item Based Layout * Item Based Layout
* *
* </pre> * </pre>

8
legacy/elementary/src/lib/elm_bg.h
View File

@ -53,7 +53,7 @@ typedef enum
* Add a new background to the parent * Add a new background to the parent
* *
* @param parent The parent object * @param parent The parent object
* @return The new object or NULL if it cannot be created * @return The new object or @c NULL if it cannot be created
* *
* @ingroup Bg * @ingroup Bg
*/ */
@ -77,7 +77,7 @@ EAPI Evas_Object *elm_bg_add(Evas_Object *parent);
* elm_bg_option_set(). * elm_bg_option_set().
* *
* @note Once the image of @p obj is set, a previously set one will be * @note Once the image of @p obj is set, a previously set one will be
* deleted, even if @p file is NULL. * deleted, even if @p file is @c NULL.
* *
* @note This will only affect the contents of one of the background's * @note This will only affect the contents of one of the background's
* swallow spots, namely @c "elm.swallow.background". If you want to * swallow spots, namely @c "elm.swallow.background". If you want to
@ -125,8 +125,8 @@ EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Opt
* Get the mode of display for a given background widget's image * Get the mode of display for a given background widget's image
* *
* @param obj The background object handle * @param obj The background object handle
* @return The image displaying mode in use for @a obj or * @return The image displaying mode in use for @a obj or #ELM_BG_OPTION_LAST,
* #ELM_BG_OPTION_LAST, on errors. * on errors.
* *
* @see elm_bg_option_set() for more details * @see elm_bg_option_set() for more details
* *

9
legacy/elementary/src/lib/elm_diskselector.h
View File

@ -215,14 +215,13 @@ EAPI void elm_diskselector_scroller_policy_get(const Evas_Obje
* @param policy_h Horizontal scrollbar policy. * @param policy_h Horizontal scrollbar policy.
* @param policy_v Vertical scrollbar policy. * @param policy_v Vertical scrollbar policy.
* *
* This sets the scrollbar visibility policy for the given scroller. * This sets the scrollbar visibility policy for the given
* #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it * scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if
* is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns * it is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
* it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off. * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
* This applies respectively for the horizontal and vertical scrollbars. * This applies respectively for the horizontal and vertical scrollbars.
* *
* The both are disabled by default, i.e., are set to * The both are disabled by default, i.e., are set to #ELM_SCROLLER_POLICY_OFF.
* #ELM_SCROLLER_POLICY_OFF.
* *
* @ingroup Diskselector * @ingroup Diskselector
*/ */

14
legacy/elementary/src/lib/elm_entry.h
View File

@ -1639,14 +1639,13 @@ typedef enum {
* Control pasting of text and images for the widget. * Control pasting of text and images for the widget.
* *
* Normally the entry allows both text and images to be pasted. * Normally the entry allows both text and images to be pasted.
* By setting cnp_mode to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past. * By setting cnp_mode to be #ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
* By setting cnp_mode to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text . * By setting cnp_mode to be #ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
* *
* @note this only changes the behaviour of text. * @note this only changes the behaviour of text.
* *
* @param obj The entry object * @param obj The entry object
* @param cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, * @param cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
* #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
* *
* @ingroup Entry * @ingroup Entry
*/ */
@ -1659,8 +1658,7 @@ EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_Cnp_Mode cnp_mode
* This gets the copy & paste mode of the entry. * This gets the copy & paste mode of the entry.
* *
* @param obj The entry object * @param obj The entry object
* @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, * @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
* #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
* *
* @ingroup Entry * @ingroup Entry
*/ */
@ -1699,7 +1697,7 @@ EAPI Evas_Object *elm_entry_anchor_hover_parent_get(const Evas_Ob
* When creating the popup hover, entry will request that it's * When creating the popup hover, entry will request that it's
* themed according to @p style. * themed according to @p style.
* *
* Setting style no NULL means disabling automatic hover. * Setting style no @c NULL means disabling automatic hover.
* *
* @param obj The entry object * @param obj The entry object
* @param style The style to use for the underlying hover * @param style The style to use for the underlying hover
@ -1716,7 +1714,7 @@ EAPI void elm_entry_anchor_hover_style_set(Evas_Object *o
* Get the style, the hover created by entry will use. * Get the style, the hover created by entry will use.
* *
* @param obj The entry object * @param obj The entry object
* @return The style to use by the hover. NULL means the default is used. * @return The style to use by the hover. @c NULL means the default is used.
* *
* @see elm_object_style_set() * @see elm_object_style_set()
* *

6
legacy/elementary/src/lib/elm_general.h
View File

@ -274,9 +274,9 @@ EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
* @return @c EINA_TRUE on success or @c EINA_FALSE, on error. * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
* *
* Elementary policies define applications' behavior, * Elementary policies define applications' behavior,
* somehow. These behaviors are divided in policy groups (see * somehow. These behaviors are divided in policy groups
* #Elm_Policy enumeration). This call will emit the Ecore event * (see #Elm_Policy enumeration). This call will emit the Ecore
* #ELM_EVENT_POLICY_CHANGED, which can be hooked at with * event #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
* handlers. An #Elm_Event_Policy_Changed struct will be passed, * handlers. An #Elm_Event_Policy_Changed struct will be passed,
* then. * then.
* *

17
legacy/elementary/src/lib/elm_gengrid.h
View File

@ -72,8 +72,8 @@
* object itself, while the @c part one is the name string of one * object itself, while the @c part one is the name string of one
* of the existing text parts in the Edje group implementing the * of the existing text parts in the Edje group implementing the
* item's theme. This function @b must return a strdup'()ed string, * item's theme. This function @b must return a strdup'()ed string,
* as the caller will free() it when done. See * as the caller will free() it when done.
* #Elm_Gengrid_Item_Text_Get_Cb. * See #Elm_Gengrid_Item_Text_Get_Cb.
* - @c func.content_get - This function is called when an item object * - @c func.content_get - This function is called when an item object
* is actually created. The @c data parameter will point to the * is actually created. The @c data parameter will point to the
* same data passed to elm_gengrid_item_append() and related item * same data passed to elm_gengrid_item_append() and related item
@ -117,8 +117,8 @@
* If an item changes (internal (boolean) state, text or content * If an item changes (internal (boolean) state, text or content
* changes), then use elm_gengrid_item_update() to have gengrid * changes), then use elm_gengrid_item_update() to have gengrid
* update the item with the new state. A gengrid will re-"realize" * update the item with the new state. A gengrid will re-"realize"
* the item, thus calling the functions in the * the item, thus calling the functions in the #Elm_Gengrid_Item_Class
* #Elm_Gengrid_Item_Class set for that item. * set for that item.
* *
* To programmatically (un)select an item, use * To programmatically (un)select an item, use
* elm_gengrid_item_selected_set(). To get its selected state use * elm_gengrid_item_selected_set(). To get its selected state use
@ -635,11 +635,10 @@ EAPI Elm_Object_Item *elm_gengrid_last_item_get(const Evas_Object *o
* *
* This sets the scrollbar visibility policy for the given gengrid * This sets the scrollbar visibility policy for the given gengrid
* scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is * scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is
* made visible if it is needed, and otherwise kept hidden. * made visible if it is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON
* #ELM_SCROLLER_POLICY_ON turns it on all the time, and * turns it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
* #ELM_SCROLLER_POLICY_OFF always keeps it off. This applies * This applies respectively for the horizontal and vertical scrollbars.
* respectively for the horizontal and vertical scrollbars. Default is * Default is #ELM_SCROLLER_POLICY_AUTO
* #ELM_SCROLLER_POLICY_AUTO
* *
* @see elm_gengrid_scroller_policy_get() * @see elm_gengrid_scroller_policy_get()
* *

30
legacy/elementary/src/lib/elm_genlist.h
View File

@ -57,8 +57,8 @@
* existing (content) swallow parts in the Edje group implementing the item's * existing (content) swallow parts in the Edje group implementing the item's
* theme. It must return @c NULL, when no content is desired, or a valid * theme. It must return @c NULL, when no content is desired, or a valid
* object handle, otherwise. The object will be deleted by the genlist on * object handle, otherwise. The object will be deleted by the genlist on
* its deletion or when the item is "unrealized". See * its deletion or when the item is "unrealized".
* #Elm_Genlist_Item_Content_Get_Cb. * See #Elm_Genlist_Item_Content_Get_Cb.
* - @c func.state_get - The @c part parameter is the name string of one of * - @c func.state_get - The @c part parameter is the name string of one of
* the state parts in the Edje group implementing the item's theme. Return * the state parts in the Edje group implementing the item's theme. Return
* @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
@ -120,15 +120,14 @@
* the applications internal data (eg. the struct with the original item * the applications internal data (eg. the struct with the original item
* data). The parent parameter is the parent genlist item this belongs to if * data). The parent parameter is the parent genlist item this belongs to if
* it is a tree or an indexed group, and NULL if there is no parent. The * it is a tree or an indexed group, and NULL if there is no parent. The
* flags can be a bitmask of #ELM_GENLIST_ITEM_NONE, * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE, #ELM_GENLIST_ITEM_TREE
* #ELM_GENLIST_ITEM_TREE and #ELM_GENLIST_ITEM_GROUP. If * and #ELM_GENLIST_ITEM_GROUP. If #ELM_GENLIST_ITEM_TREE is set then this
* #ELM_GENLIST_ITEM_TREE is set then this item is displayed as an item * item is displayed as an item that is able to expand and have child items.
* that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP * If #ELM_GENLIST_ITEM_GROUP is set then this item is group index item that
* is set then this item is group index item that is displayed at the top * is displayed at the top until the next group comes. The func parameter is
* until the next group comes. The func parameter is a convenience callback * a convenience callback that is called when the item is selected and the
* that is called when the item is selected and the data parameter will be * data parameter will be the func_data parameter, @c obj be the genlist
* the func_data parameter, obj be the genlist object and event_info will be * object and event_info will be the genlist item.
* the genlist item.
* *
* elm_genlist_item_append() adds an item to the end of the list, or if * elm_genlist_item_append() adds an item to the end of the list, or if
* there is a parent, to the end of all the child items of the parent. * there is a parent, to the end of all the child items of the parent.
@ -792,11 +791,10 @@ EAPI Elm_Object_Item *elm_genlist_last_item_get(const Evas_Object *o
* *
* This sets the scrollbar visibility policy for the given genlist * This sets the scrollbar visibility policy for the given genlist
* scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is * scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is
* made visible if it is needed, and otherwise kept hidden. * made visible if it is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON
* #ELM_SCROLLER_POLICY_ON turns it on all the time, and * turns it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
* #ELM_SCROLLER_POLICY_OFF always keeps it off. This applies * This applies respectively for the horizontal and vertical scrollbars.
* respectively for the horizontal and vertical scrollbars. Default is * Default is #ELM_SCROLLER_POLICY_AUTO
* #ELM_SCROLLER_POLICY_AUTO
* *
* @see elm_genlist_scroller_policy_get() * @see elm_genlist_scroller_policy_get()
* *

4
legacy/elementary/src/lib/elm_label.h
View File

@ -110,7 +110,7 @@ EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj
* will be shown at the end of the widget. * will be shown at the end of the widget.
* *
* @warning This doesn't work with slide(elm_label_slide_set()) or if the * @warning This doesn't work with slide(elm_label_slide_set()) or if the
* chosen wrap method was ELM_WRAP_WORD. * chosen wrap method was #ELM_WRAP_WORD.
* *
* @ingroup Label * @ingroup Label
*/ */
@ -157,7 +157,7 @@ EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool
EAPI Eina_Bool elm_label_slide_get(const Evas_Object *obj); EAPI Eina_Bool elm_label_slide_get(const Evas_Object *obj);
/** /**
* @brief Set the slide duration(speed) of the label * @brief Set the slide duration (speed) of the label
* *
* @param obj The label object * @param obj The label object
* @param duration The duration in seconds in moving text from slide begin position * @param duration The duration in seconds in moving text from slide begin position

27
legacy/elementary/src/lib/elm_layout.c
View File

@ -219,8 +219,28 @@ _parts_text_fix(Elm_Layout_Smart_Data *sd)
EINA_LIST_FOREACH (sd->subs, l, sub_d) EINA_LIST_FOREACH (sd->subs, l, sub_d)
{ {
if (sub_d->type == TEXT) if (sub_d->type == TEXT)
edje_object_part_text_escaped_set {
(ELM_WIDGET_DATA(sd)->resize_obj, sub_d->part, sub_d->p.text.text); edje_object_part_text_escaped_set
(ELM_WIDGET_DATA(sd)->resize_obj, sub_d->part, sub_d->p.text.text);
}
}
}
static void
_parts_table_fix(Elm_Layout_Smart_Data *sd)
{
const Eina_List *l;
Elm_Layout_Sub_Object_Data *sub_d;
EINA_LIST_FOREACH (sd->subs, l, sub_d)
{
if (sub_d->type == TABLE_PACK)
{
edje_object_part_table_pack
(ELM_WIDGET_DATA(sd)->resize_obj, sub_d->part, sub_d->obj,
sub_d->p.table.col, sub_d->p.table.row,
sub_d->p.table.colspan, sub_d->p.table.rowspan);
}
} }
} }
@ -284,8 +304,9 @@ static void
_visuals_refresh(Evas_Object *obj, _visuals_refresh(Evas_Object *obj,
Elm_Layout_Smart_Data *sd) Elm_Layout_Smart_Data *sd)
{ {
_parts_signals_emit(sd); _parts_table_fix(sd);
_parts_text_fix(sd); _parts_text_fix(sd);
_parts_signals_emit(sd);
_parts_cursors_apply(sd); _parts_cursors_apply(sd);
ELM_LAYOUT_CLASS(ELM_WIDGET_DATA(sd)->api)->sizing_eval(obj); ELM_LAYOUT_CLASS(ELM_WIDGET_DATA(sd)->api)->sizing_eval(obj);

18
legacy/elementary/src/lib/elm_list.h
View File

@ -156,8 +156,7 @@ EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *o
* Set which mode to use for the list object. * Set which mode to use for the list object.
* *
* @param obj The list object * @param obj The list object
* @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
* #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
* *
* Set list's resize behavior, transverse axis scroll and * Set list's resize behavior, transverse axis scroll and
* items cropping. See each mode's description for more details. * items cropping. See each mode's description for more details.
@ -177,8 +176,7 @@ EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_M
* Get the mode the list is at. * Get the mode the list is at.
* *
* @param obj The list object * @param obj The list object
* @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
* #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
* *
* @note see elm_list_mode_set() for more information. * @note see elm_list_mode_set() for more information.
* *
@ -299,14 +297,12 @@ EAPI void elm_list_bounce_get(const Evas_Object *obj, Ei
* @param policy_h Horizontal scrollbar policy. * @param policy_h Horizontal scrollbar policy.
* @param policy_v Vertical scrollbar policy. * @param policy_v Vertical scrollbar policy.
* *
* This sets the scrollbar visibility policy for the given scroller. * This sets the scrollbar visibility policy for the given scroller. #ELM_SCROLLER_POLICY_AUTO
* #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it * means the scrollbar is made visible if it is needed, and otherwise kept
* is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns * hidden. #ELM_SCROLLER_POLICY_ON turns it on all the time, and #ELM_SCROLLER_POLICY_OFF
* it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off. * always keeps it off. This applies respectively for the horizontal and vertical scrollbars.
* This applies respectively for the horizontal and vertical scrollbars.
* *
* The both are disabled by default, i.e., are set to * The both are disabled by default, i.e., are set to #ELM_SCROLLER_POLICY_OFF.
* #ELM_SCROLLER_POLICY_OFF.
* *
* @ingroup List * @ingroup List
*/ */

27
legacy/elementary/src/lib/elm_map.h
View File

@ -131,7 +131,7 @@ typedef enum
typedef enum typedef enum
{ {
ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should prioritize time. */ ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should prioritize time. */
ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should prioritized distance. */ ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should prioritize distance. */
ELM_MAP_ROUTE_METHOD_LAST ELM_MAP_ROUTE_METHOD_LAST
} Elm_Map_Route_Method; } Elm_Map_Route_Method;
@ -217,9 +217,8 @@ EAPI Evas_Object *elm_map_add(Evas_Object *parent);
* *
* By default these values are 0 (world map) and 18 (maximum zoom). * By default these values are 0 (world map) and 18 (maximum zoom).
* *
* This function should be used when zoom mode is set to * This function should be used when zoom mode is set to #ELM_MAP_ZOOM_MODE_MANUAL.
* #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set * This is the default mode, and can be set with elm_map_zoom_mode_set().
* with elm_map_zoom_mode_set().
* *
* @see elm_map_zoom_mode_set() * @see elm_map_zoom_mode_set()
* @see elm_map_zoom_get() * @see elm_map_zoom_get()
@ -250,9 +249,8 @@ EAPI int elm_map_zoom_get(const Evas_Object *obj);
* Set the zoom mode used by the map object. * Set the zoom mode used by the map object.
* *
* @param obj The map object. * @param obj The map object.
* @param mode The zoom mode of the map, being it one of * @param mode The zoom mode of the map, being it one of #ELM_MAP_ZOOM_MODE_MANUAL
* #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT, * (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT, or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
* or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
* *
* This sets the zoom mode to manual or one of the automatic levels. * This sets the zoom mode to manual or one of the automatic levels.
* Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
@ -277,9 +275,8 @@ EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_
* Get the zoom mode used by the map object. * Get the zoom mode used by the map object.
* *
* @param obj The map object. * @param obj The map object.
* @return The zoom mode of the map, being it one of * @return The zoom mode of the map, being it one of #ELM_MAP_ZOOM_MODE_MANUAL
* #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT, * (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT, or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
* or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
* *
* This function returns the current zoom mode used by the map object. * This function returns the current zoom mode used by the map object.
* *
@ -993,7 +990,7 @@ EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_G
* *
* You can change the state (hidden, paused, etc.) or set the content * You can change the state (hidden, paused, etc.) or set the content
* or icon of the group overlays by chaning the state of the class overlay. * or icon of the group overlays by chaning the state of the class overlay.
* Do not modifty the group overlay itself. * Do not modify the group overlay itself.
* *
* Also these changes have a influence on the overlays in the same class * Also these changes have a influence on the overlays in the same class
* even if each overlay is alone and is not grouped. * even if each overlay is alone and is not grouped.
@ -1181,7 +1178,7 @@ EAPI Elm_Map_Overlay * elm_map_overlay_route_add(Evas_Object *obj, const Elm
* @param tlon The destination longitude. * @param tlon The destination longitude.
* @param tlat The destination latitude. * @param tlat The destination latitude.
* @return The created overlay or @c NULL upon failure. * @return The created overlay or @c NULL upon failure.
* *
* Overlay created with this method can be deleted with elm_map_overlay_del(). * Overlay created with this method can be deleted with elm_map_overlay_del().
* *
* @see elm_map_overlay_del() * @see elm_map_overlay_del()
@ -1374,8 +1371,8 @@ EAPI const char *elm_map_source_get(const Evas_Object *obj, Elm_Map_So
* *
* It will take @p type on consideration to define the route, * It will take @p type on consideration to define the route,
* depending if the user will be walking or driving, the route may vary. * depending if the user will be walking or driving, the route may vary.
* One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE,
* #ELM_MAP_ROUTE_TYPE_FOOT need to be used. * or #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
* *
* Another parameter is what the route should prioritize, the minor distance * Another parameter is what the route should prioritize, the minor distance
* or the less time to be spend on the route. So @p method should be one * or the less time to be spend on the route. So @p method should be one
@ -1447,7 +1444,7 @@ EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route
* @return name A #Elm_Map_Name handle for this coordinate. * @return name A #Elm_Map_Name handle for this coordinate.
* *
* If you want to get address from geographic coordinates, set input @p address * If you want to get address from geographic coordinates, set input @p address
* as NULL and set @p lon, @p lat as you want to convert. * as @c NULL and set @p lon, @p lat as you want to convert.
* If address is set except NULL, @p lon and @p lat are checked. * If address is set except NULL, @p lon and @p lat are checked.
* *
* To get the string for this address, elm_map_name_address_get() * To get the string for this address, elm_map_name_address_get()

6
legacy/elementary/src/lib/elm_slideshow.h
View File

@ -29,8 +29,8 @@
* - @c func.get - When an item is displayed, this function is * - @c func.get - When an item is displayed, this function is
* called, and it's where one should create the item object, de * called, and it's where one should create the item object, de
* facto. For example, the object can be a pure Evas image object * facto. For example, the object can be a pure Evas image object
* or an Elementary @ref Photocam "photocam" widget. See * or an Elementary @ref Photocam "photocam" widget.
* #SlideshowItemGetFunc. * See #SlideshowItemGetFunc.
* - @c func.del - When an item is no more displayed, this function * - @c func.del - When an item is no more displayed, this function
* is called, where the user must delete any data associated to * is called, where the user must delete any data associated to
* the item. See #SlideshowItemDelFunc. * the item. See #SlideshowItemDelFunc.
@ -82,7 +82,7 @@ struct _Elm_Slideshow_Item_Class
SlideshowItemGetFunc get; SlideshowItemGetFunc get;
SlideshowItemDelFunc del; SlideshowItemDelFunc del;
} func; } func;
}; /**< #Elm_Slideshow_Item_Class member definitions */ }; /**< member definitions of #Elm_Slideshow_Item_Class */
/** /**
* Add a new slideshow widget to the given parent Elementary * Add a new slideshow widget to the given parent Elementary

4
legacy/elementary/src/lib/elm_toolbar.h
View File

@ -346,8 +346,8 @@ EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Ite
* @param it The toolbar item. * @param it The toolbar item.
* @param priority The item priority. The default is zero. * @param priority The item priority. The default is zero.
* *
* This is used only when the toolbar shrink mode is set to * This is used only when the toolbar shrink mode is set
* #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE. * to #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
* When space is less than required, items with low priority * When space is less than required, items with low priority
* will be removed from the toolbar and added to a dynamically-created menu, * will be removed from the toolbar and added to a dynamically-created menu,
* while items with higher priority will remain on the toolbar, * while items with higher priority will remain on the toolbar,

16
legacy/elementary/src/lib/elm_video.h
View File

@ -138,7 +138,7 @@ EAPI void elm_video_stop(Evas_Object *video);
* @brief Is the video actually playing. * @brief Is the video actually playing.
* *
* @param video The video object to proceed the request on. * @param video The video object to proceed the request on.
* @return EINA_TRUE if the video is actually playing. * @return @c EINA_TRUE if the video is actually playing.
* *
* You should consider watching event on the object instead of polling * You should consider watching event on the object instead of polling
* the object state. * the object state.
@ -151,7 +151,7 @@ EAPI Eina_Bool elm_video_is_playing_get(const Evas_Object *video);
* @brief Is it possible to seek inside the video. * @brief Is it possible to seek inside the video.
* *
* @param video The video object to proceed the request on. * @param video The video object to proceed the request on.
* @return EINA_TRUE if is possible to seek inside the video. * @return @c EINA_TRUE if is possible to seek inside the video.
* *
* @ingroup Video * @ingroup Video
*/ */
@ -161,7 +161,7 @@ EAPI Eina_Bool elm_video_is_seekable_get(const Evas_Object *video);
* @brief Is the audio muted. * @brief Is the audio muted.
* *
* @param video The video object to proceed the request on. * @param video The video object to proceed the request on.
* @return EINA_TRUE if the audio is muted. * @return @c EINA_TRUE if the audio is muted.
* *
* @ingroup Video * @ingroup Video
*/ */
@ -202,7 +202,7 @@ EAPI void elm_video_audio_level_set(Evas_Object *video, double v
* Elm_Video object. * Elm_Video object.
* *
* @param video The video object. * @param video The video object.
* @return the time(in seconds) since the beginning of the media file. * @return The time (in seconds) since the beginning of the media file.
* *
* @ingroup Video * @ingroup Video
*/ */
@ -213,7 +213,7 @@ EAPI double elm_video_play_position_get(const Evas_Object *video);
* Elm_Video object. * Elm_Video object.
* *
* @param video The video object. * @param video The video object.
* @param position the time(in seconds) since the beginning of the media file. * @param position The time (in seconds) since the beginning of the media file.
* *
* @ingroup Video * @ingroup Video
*/ */
@ -222,7 +222,7 @@ EAPI void elm_video_play_position_set(Evas_Object *video, double
* @brief Get the total playing time (in seconds) of the Elm_Video object. * @brief Get the total playing time (in seconds) of the Elm_Video object.
* *
* @param video The video object. * @param video The video object.
* @return the total duration(in seconds) of the media file. * @return The total duration (in seconds) of the media file.
* *
* @ingroup Video * @ingroup Video
*/ */
@ -244,7 +244,7 @@ EAPI void elm_video_remember_position_set(Evas_Object *video, Ei
* @brief Set whether the object can remember the last played position. * @brief Set whether the object can remember the last played position.
* *
* @param video The video object. * @param video The video object.
* @return whether the object remembers the last played position (EINA_TRUE) * @return whether the object remembers the last played position (@c EINA_TRUE)
* or not. * or not.
* *
* @note This API only serves as indication. System support is required. * @note This API only serves as indication. System support is required.
@ -254,7 +254,7 @@ EAPI void elm_video_remember_position_set(Evas_Object *video, Ei
EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video); EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
/** /**
* @brief Get the title (for ex. DVD title) from this emotion object. * @brief Get the title (for instance DVD title) from this emotion object.
* *
* @param video The Elm_Video object. * @param video The Elm_Video object.
* @return A string containing the title. * @return A string containing the title.

138
legacy/elementary/src/lib/elm_web.h
View File

@ -233,19 +233,17 @@ typedef enum
/** /**
* Callback type for the create_window hook. * Callback type for the create_window hook.
* *
* The function parameters are: * @param data User data pointer set when setting the hook function.
* @li @p data User data pointer set when setting the hook function * @param obj The elm_web object requesting the new window.
* @li @p obj The elm_web object requesting the new window * @param js Set to @c EINA_TRUE if the request was originated from
* @li @p js Set to @c EINA_TRUE if the request was originated from
* JavaScript. @c EINA_FALSE otherwise. * JavaScript. @c EINA_FALSE otherwise.
* @li @p window_features A pointer of #Elm_Web_Window_Features indicating * @param window_features A pointer of #Elm_Web_Window_Features indicating
* the features requested for the new window. * the features requested for the new window.
* *
* The returned value of the function should be the @c elm_web widget where * @return The @c elm_web widget where the request will be loaded. That is,
* the request will be loaded. That is, if a new window or tab is created, * if a new window or tab is created, the elm_web widget in it should be
* the elm_web widget in it should be returned, and @b NOT the window * returned, and @b NOT the window object. Returning @c NULL should cancel
* object. * the request.
* Returning @c NULL should cancel the request.
* *
* @see elm_web_window_create_hook_set() * @see elm_web_window_create_hook_set()
* *
@ -256,12 +254,11 @@ typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_B
/** /**
* Callback type for the JS alert hook. * Callback type for the JS alert hook.
* *
* The function parameters are: * @param data User data pointer set when setting the hook function.
* @li @p data User data pointer set when setting the hook function * @param obj The elm_web object requesting the new window.
* @li @p obj The elm_web object requesting the new window * @param message The message to show in the alert dialog.
* @li @p message The message to show in the alert dialog
* *
* The function should return the object representing the alert dialog. * @return The object representing the alert dialog.
* Elm_Web will run a second main loop to handle the dialog and normal * Elm_Web will run a second main loop to handle the dialog and normal
* flow of the application will be restored when the object is deleted, so * flow of the application will be restored when the object is deleted, so
* the user should handle the popup properly in order to delete the object * the user should handle the popup properly in order to delete the object
@ -277,14 +274,13 @@ typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const
/** /**
* Callback type for the JS confirm hook. * Callback type for the JS confirm hook.
* *
* The function parameters are: * @param data User data pointer set when setting the hook function.
* @li @p data User data pointer set when setting the hook function * @param obj The elm_web object requesting the new window.
* @li @p obj The elm_web object requesting the new window * @param message The message to show in the confirm dialog.
* @li @p message The message to show in the confirm dialog * @param ret Pointer to store the user selection. @c EINA_TRUE if
* @li @p ret Pointer to store the user selection. @c EINA_TRUE if
* the user selected @c Ok, @c EINA_FALSE otherwise. * the user selected @c Ok, @c EINA_FALSE otherwise.
* *
* The function should return the object representing the confirm dialog. * @return The object representing the confirm dialog.
* Elm_Web will run a second main loop to handle the dialog and normal * Elm_Web will run a second main loop to handle the dialog and normal
* flow of the application will be restored when the object is deleted, so * flow of the application will be restored when the object is deleted, so
* the user should handle the popup properly in order to delete the object * the user should handle the popup properly in order to delete the object
@ -300,17 +296,16 @@ typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, con
/** /**
* Callback type for the JS prompt hook. * Callback type for the JS prompt hook.
* *
* The function parameters are: * @param data User data pointer set when setting the hook function.
* @li @p data User data pointer set when setting the hook function * @param obj The elm_web object requesting the new window.
* @li @p obj The elm_web object requesting the new window * @param message The message to show in the prompt dialog.
* @li @p message The message to show in the prompt dialog * @param def_value The default value to present the user in the entry
* @li @p def_value The default value to present the user in the entry * @param value Pointer to store the value given by the user. Must
* @li @p value Pointer to store the value given by the user. Must
* be a malloc'ed string or @c NULL if the user canceled the popup. * be a malloc'ed string or @c NULL if the user canceled the popup.
* @li @p ret Pointer to store the user selection. @c EINA_TRUE if * @param ret Pointer to store the user selection. @c EINA_TRUE if
* the user selected @c Ok, @c EINA_FALSE otherwise. * the user selected @c Ok, @c EINA_FALSE otherwise.
* *
* The function should return the object representing the prompt dialog. * @return The object representing the prompt dialog.
* Elm_Web will run a second main loop to handle the dialog and normal * Elm_Web will run a second main loop to handle the dialog and normal
* flow of the application will be restored when the object is deleted, so * flow of the application will be restored when the object is deleted, so
* the user should handle the popup properly in order to delete the object * the user should handle the popup properly in order to delete the object
@ -326,19 +321,17 @@ typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, cons
/** /**
* Callback type for the JS file selector hook. * Callback type for the JS file selector hook.
* *
* The function parameters are: * @param data User data pointer set when setting the hook function.
* @li @p data User data pointer set when setting the hook function * @param obj The elm_web object requesting the new window.
* @li @p obj The elm_web object requesting the new window * @param allows_multiple @c EINA_TRUE if multiple files can be selected.
* @li @p allows_multiple @c EINA_TRUE if multiple files can be selected. * @param accept_types Mime types accepted.
* @li @p accept_types Mime types accepted * @param selected Pointer to store the list of malloc'ed strings
* @li @p selected Pointer to store the list of malloc'ed strings
* containing the path to each file selected. Must be @c NULL if the file * containing the path to each file selected. Must be @c NULL if the file
* dialog is canceled * dialog is canceled.
* @li @p ret Pointer to store the user selection. @c EINA_TRUE if * @param ret Pointer to store the user selection. @c EINA_TRUE if
* the user selected @c Ok, @c EINA_FALSE otherwise. * the user selected @c Ok, @c EINA_FALSE otherwise.
* *
* The function should return the object representing the file selector * @return The object representing the file selector dialog.
* dialog.
* Elm_Web will run a second main loop to handle the dialog and normal * Elm_Web will run a second main loop to handle the dialog and normal
* flow of the application will be restored when the object is deleted, so * flow of the application will be restored when the object is deleted, so
* the user should handle the popup properly in order to delete the object * the user should handle the popup properly in order to delete the object
@ -358,12 +351,11 @@ typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *ob
* console message hook will be called for the user to handle. There is no * console message hook will be called for the user to handle. There is no
* default implementation of this hook. * default implementation of this hook.
* *
* The function parameters are: * @param data User data pointer set when setting the hook function.
* @li @p data User data pointer set when setting the hook function * @param obj The elm_web object that originated the message.
* @li @p obj The elm_web object that originated the message * @param message The message sent.
* @li @p message The message sent * @param line_number The line number.
* @li @p line_number The line number * @param source_id Source id.
* @li @p source_id Source id
* *
* @see elm_web_console_message_hook_set() * @see elm_web_console_message_hook_set()
* *
@ -375,7 +367,7 @@ typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char
* Add a new web object to the parent. * Add a new web object to the parent.
* *
* @param parent The parent object. * @param parent The parent object.
* @return The new object or NULL if it cannot be created. * @return The new object or @c NULL if it cannot be created.
* *
* @see elm_web_uri_set() * @see elm_web_uri_set()
* @see elm_web_webkit_view_get() * @see elm_web_webkit_view_get()
@ -413,7 +405,7 @@ EAPI const char* elm_web_useragent_get(const Evas_Object *obj);
* interfere with elm_web behavior. * interfere with elm_web behavior.
* *
* @param obj The web object. * @param obj The web object.
* @return The internal ewk_view object or NULL if it does not * @return The internal ewk_view object or @c NULL if it does not
* exist. (Failure to create or Elementary compiled without * exist. (Failure to create or Elementary compiled without
* ewebkit) * ewebkit)
* *
@ -527,7 +519,7 @@ EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_We
* Gets the status of the tab propagation * Gets the status of the tab propagation
* *
* @param obj The web object to query * @param obj The web object to query
* @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise * @return @c EINA_TRUE if tab propagation is enabled, @c EINA_FALSE otherwise
* *
* @see elm_web_tab_propagate_set() * @see elm_web_tab_propagate_set()
* *
@ -559,7 +551,7 @@ EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool pro
* *
* @param obj The web object * @param obj The web object
* @param uri The URI to set * @param uri The URI to set
* @return EINA_TRUE if the URI could be set, EINA_FALSE if an error occurred * @return @c EINA_TRUE if the URI could be set, @c EINA_FALSE if an error occurred.
* *
* @ingroup Web * @ingroup Web
*/ */
@ -572,7 +564,7 @@ EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
* stringshared. * stringshared.
* *
* @param obj The web object * @param obj The web object
* @return A stringshared internal string with the current URI, or NULL on * @return A stringshared internal string with the current URI, or @c NULL on
* failure * failure
* *
* @ingroup Web * @ingroup Web
@ -586,7 +578,7 @@ EAPI const char *elm_web_uri_get(const Evas_Object *obj);
* stringshared. * stringshared.
* *
* @param obj The web object * @param obj The web object
* @return A stringshared internal string with the current title, or NULL on * @return A stringshared internal string with the current title, or @c NULL on
* failure * failure
* *
* @ingroup Web * @ingroup Web
@ -631,7 +623,7 @@ EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int
* The string returned must be freed by the user when it's done with it. * The string returned must be freed by the user when it's done with it.
* *
* @param obj The web object * @param obj The web object
* @return A newly allocated string, or NULL if nothing is selected or an * @return A newly allocated string, or @c NULL if nothing is selected or an
* error occurred * error occurred
* *
* @ingroup Web * @ingroup Web
@ -663,7 +655,7 @@ EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
* any memory and objects related to this popup can be freed. * any memory and objects related to this popup can be freed.
* *
* @param obj The web object * @param obj The web object
* @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE * @return @c EINA_TRUE if the menu was successfully destroyed, or @c EINA_FALSE
* if there was no menu to destroy * if there was no menu to destroy
* *
* @ingroup Web * @ingroup Web
@ -706,7 +698,7 @@ EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *s
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE on success, EINA_FALSE otherwise * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */
@ -721,7 +713,7 @@ EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
* @param obj The web object * @param obj The web object
* @param highlight Whether to highlight the marks or not * @param highlight Whether to highlight the marks or not
* *
* @return EINA_TRUE on success, EINA_FALSE otherwise * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */
@ -732,7 +724,7 @@ EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE * @return @c EINA_TRUE is marks are set to be highlighted, @c EINA_FALSE
* otherwise * otherwise
* *
* @ingroup Web * @ingroup Web
@ -760,11 +752,11 @@ EAPI double elm_web_load_progress_get(const Evas_Object *obj);
* *
* Cancels the loading of the current page in the web object. This will * Cancels the loading of the current page in the web object. This will
* cause a "load,error" signal to be emitted, with the is_cancellation * cause a "load,error" signal to be emitted, with the is_cancellation
* flag set to EINA_TRUE. * flag set to @c EINA_TRUE.
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise * @return @c EINA_TRUE if the cancel was successful, @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */
@ -775,7 +767,7 @@ EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE on success, EINA_FALSE otherwise * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */
@ -786,7 +778,7 @@ EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE on success, EINA_FALSE otherwise * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */
@ -799,7 +791,7 @@ EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE on success, EINA_FALSE otherwise * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
* *
* @see elm_web_history_enabled_set() * @see elm_web_history_enabled_set()
* @see elm_web_back_possible() * @see elm_web_back_possible()
@ -817,7 +809,7 @@ EAPI Eina_Bool elm_web_back(Evas_Object *obj);
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE on success, EINA_FALSE otherwise * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
* *
* @see elm_web_history_enabled_set() * @see elm_web_history_enabled_set()
* @see elm_web_forward_possible_get() * @see elm_web_forward_possible_get()
@ -837,7 +829,7 @@ EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
* @param obj The web object * @param obj The web object
* @param steps The number of steps to jump * @param steps The number of steps to jump
* *
* @return EINA_TRUE on success, EINA_FALSE on error or if not enough * @return @c EINA_TRUE on success, @c EINA_FALSE on error or if not enough
* history exists to jump the given number of steps * history exists to jump the given number of steps
* *
* @see elm_web_history_enabled_set() * @see elm_web_history_enabled_set()
@ -853,7 +845,7 @@ EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE if it's possible to back in history, EINA_FALSE * @return @c EINA_TRUE if it's possible to back in history, @c EINA_FALSE
* otherwise * otherwise
* *
* @ingroup Web * @ingroup Web
@ -865,7 +857,7 @@ EAPI Eina_Bool elm_web_back_possible_get(Evas_Object *obj);
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE if it's possible to forward in history, EINA_FALSE * @return @c EINA_TRUE if it's possible to forward in history, @c EINA_FALSE
* otherwise * otherwise
* *
* @ingroup Web * @ingroup Web
@ -881,8 +873,8 @@ EAPI Eina_Bool elm_web_forward_possible_get(Evas_Object *obj);
* @param obj The web object * @param obj The web object
* @param steps The number of steps to check for * @param steps The number of steps to check for
* *
* @return EINA_TRUE if enough history exists to perform the given jump, * @return @c EINA_TRUE if enough history exists to perform the given jump,
* EINA_FALSE otherwise * @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */
@ -893,7 +885,7 @@ EAPI Eina_Bool elm_web_navigate_possible_get(Evas_Object *obj, int steps
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE if history is enabled, EINA_FALSE otherwise * @return @c EINA_TRUE if history is enabled, @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */
@ -967,8 +959,8 @@ EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode
* *
* @param obj The web object * @param obj The web object
* *
* @return The current zoom mode set for the object, or * @return The current zoom mode set for the object,
* ::ELM_WEB_ZOOM_MODE_LAST on error * or ::ELM_WEB_ZOOM_MODE_LAST on error
* *
* @ingroup Web * @ingroup Web
*/ */
@ -1011,7 +1003,7 @@ EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, i
* normal separated window. * normal separated window.
* *
* @param obj The web object * @param obj The web object
* @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window * @param value @c EINA_TRUE to use Inwin, @c EINA_FALSE to use a normal window
* *
* @ingroup Web * @ingroup Web
*/ */
@ -1022,7 +1014,7 @@ EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value)
* *
* @param obj The web object * @param obj The web object
* *
* @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise * @return @c EINA_TRUE if Inwin mode is set, @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */
@ -1038,7 +1030,7 @@ EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf
* @param wf The web window features object * @param wf The web window features object
* @param flag The web window feature flag whose value is required. * @param flag The web window feature flag whose value is required.
* *
* @return EINA_TRUE if the flag is set, EINA_FALSE otherwise * @return @c EINA_TRUE if the flag is set, @c EINA_FALSE otherwise
* *
* @ingroup Web * @ingroup Web
*/ */

12
legacy/elementary/src/lib/elm_win.h
View File

@ -227,11 +227,11 @@ typedef enum
* @param name The name of the window * @param name The name of the window
* @param type The window type, one of #Elm_Win_Type. * @param type The window type, one of #Elm_Win_Type.
* *
* The @p parent parameter can be @c NULL for every window @p type except * The @p parent parameter can be @c NULL for every window @p type
* #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on * except #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the
* which the image object will be created. * canvas on which the image object will be created.
* *
* @return The created object, or NULL on failure * @return The created object, or @c NULL on failure
* *
* @ingroup Win * @ingroup Win
*/ */
@ -245,10 +245,10 @@ EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, El
* *
* This creates a window like elm_win_add() but also puts in a standard * This creates a window like elm_win_add() but also puts in a standard
* background with elm_bg_add(), as well as setting the window title to * background with elm_bg_add(), as well as setting the window title to
* @p title. The window type created is of type ELM_WIN_BASIC, with NULL * @p title. The window type created is of type ELM_WIN_BASIC, with @c NULL
* as the parent widget. * as the parent widget.
* *
* @return The created object, or NULL on failure * @return The created object, or @c NULL on failure
* *
* @see elm_win_add() * @see elm_win_add()
* *