doxygen docs: Fix invalid refs to Layout

All widgets copy&pasted the same description, including an invalid reference
to "Layout", which should be "Elm_Layout".
SOME of them had been fixed over the years but this commit fixes all of them.
This significantly reduces the number of Doxygen warnings and adds meaningful
links to the docs.
This commit is contained in:
Xavi Artigas 2020-04-27 15:15:12 +02:00
parent 9b4afc238a
commit bbba18d406
34 changed files with 61 additions and 61 deletions

View File

@ -115,11 +115,11 @@
* The whole widget is left aligned and its size grows horizontally depending
* on the current format and each field's visible/disabled state.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for Clock objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @b "changed" - whenever Clock field value is changed, this
* signal is sent.
* @li @b "language,changed" - whenever system locale changes, this

View File

@ -26,16 +26,16 @@
* linked Efl_Ui_Video so it will use the video decoder, if available. It also
* activates the "remember" function on the linked Efl_Ui_Video object.
*
* Both widgets inherit from the @ref Layout one, so that all the
* Both widgets inherit from the @ref Elm_Layout one, so that all the
* functions acting on it also work for video objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "focused" : When the video has received focus. (since 1.8)
* @li @c "unfocused" : When the video has lost focus. (since 1.8)
*
* The player widget emits the following signals, besides the ones
* sent from @ref Layout:
* sent from @ref Elm_Layout :
* - @c "forward,clicked" - the user clicked the forward button.
* - @c "info,clicked" - the user clicked the info button.
* - @c "next,clicked" - the user clicked the next button.

View File

@ -22,7 +22,7 @@
* functions acting on it also work for context popup objects (since 1.8).
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "dismissed" - This is called when 1. the outside of ctxpopup was clicked
* or 2. its parent area is changed or 3. the language is changed and also when
* 4. the parent object is resized due to the window rotation. Then ctxpopup is

View File

@ -38,7 +38,7 @@
* functions acting on it also work for file selector objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "activated" - the user activated a file. This can happen by
* double-clicking or pressing Enter key. (@p event_info is a
* pointer to the activated file path)

View File

@ -20,7 +20,7 @@
* is closed and the selected file's path string is exposed both as
* a smart event and as the new text on the entry.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for file selector entry objects (since 1.8).
*
* This widget encapsulates operations on its internal file

View File

@ -17,11 +17,11 @@
* emails/messages to a group of addresses, each of which is an item
* that can be clicked for further actions.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for multi-button entry objects (since 1.8).
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "item,selected" - this is called when an item is selected by
* api, user interaction, and etc. this is also called when a
* user press back space while cursor is on the first field of

View File

@ -55,7 +55,7 @@
*
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "transition,finished" - When the transition is finished in
* changing the item
* @li @c "title,transition,finished" - When the title area's transition

View File

@ -68,11 +68,11 @@
* evas_object_show on popup should be called after setting all the contents
* and buttons of popup.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for popup objects (since 1.8).
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "timeout" - whenever popup is closed as a result of timeout.
* @li @c "block,clicked" - whenever user taps on Blocked Event area.
* @li @c "focused" - When the popup has received focus. (since 1.8)

View File

@ -25,11 +25,11 @@
*
* @note By default all positions are set as enabled.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for actionslider objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "selected" - when user selects an enabled position (the
* label is passed as event info).
* @li @c "pos_changed" - when the indicator reaches any of the

View File

@ -17,7 +17,7 @@
* properties useful to a background, like setting it to tiled,
* centered, scaled or stretched.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for background objects.
*
* Default content parts of the bg widget that you can use for are:

View File

@ -32,11 +32,11 @@
* @li "bottom_left"
* @li "bottom_right"
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for bubble objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "clicked" - This is called when a user has clicked the bubble.
* @li @c "focused" - When the bubble has received focus. (since 1.8)
* @li @c "unfocused" - When the bubble has lost focus. (since 1.8)

View File

@ -33,11 +33,11 @@
* am/pm indicator may be optionally shown, too, when it will
* switch to 12h.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for clock objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "changed" - the clock's user changed the time
* - @c "focused" - When the clock ehas received focus. (since 1.8)
* - @c "unfocused" - When the clock has lost focus. (since 1.8)

View File

@ -174,11 +174,11 @@
*
* <b>export ELM_MODULES="datetime_input_ctxpopup>datetime/api"</b>
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for datetime objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @b "changed" - whenever Datetime field value is changed, this
* signal is sent.
* @li @b "language,changed" - whenever system locale changes, this

View File

@ -54,11 +54,11 @@
* the elm_object_part_content_set/get APIs thus providing a way to handle
* the different check styles for individual days.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for dayselector objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "dayselector,changed" - when the user changes the state of a day.
* @li @c "language,changed" - the program's language changed
*

View File

@ -26,7 +26,7 @@
* major release).
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "selected" - when item is selected, i.e. scroller stops.
* @li @c "clicked" - This is called when a user clicks an item (since 1.8)
* @li @c "scroll,anim,start" - scrolling animation has started

View File

@ -16,11 +16,11 @@
* so that it helps the user to reach an item which is distant from
* the current selection.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for flip selector objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "selected" - when the widget's selected text item is changed. The @c
* event_info parameter is the item that was selected.
* - @c "overflowed" - when the widget's current selection is changed

View File

@ -22,11 +22,11 @@
*
* Of all this styles only default shows the title.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for frame objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "clicked" - The user has clicked the frame's label
* - @c "language,changed" - the program's language changed (since 1.9)
*

View File

@ -16,7 +16,7 @@
* view) or via the keyboard, navigating through item with the
* arrow keys.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for gengrid objects.
*
* This widget implements the @ref elm-scrollable-interface
@ -162,7 +162,7 @@
* @section Gengrid_Smart_Events Gengrid smart events
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "activated" - The user has double-clicked or pressed
* (enter|return|spacebar) on an item. The @p event_info parameter
* is the gengrid item that was activated.

View File

@ -19,7 +19,7 @@
* trying to be both expansive, powerful and efficient. First we will begin
* an overview on the theory behind genlist.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for genlist objects.
*
* This widget implements the @ref elm-scrollable-interface
@ -250,7 +250,7 @@
* @section Genlist_Smart_Events Genlist smart events
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "activated" - The user has double-clicked or pressed
* (enter|return|spacebar) on an item. The @p event_info parameter is the
* item that was activated.

View File

@ -27,11 +27,11 @@
* @li menu
* @li hoversel_vertical
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for hover objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "clicked" - the user clicked the empty space in the hover to dismiss
* @li @c "dismissed" - the user clicked the empty space in the hover to dismiss (since 1.8)
* @li @c "smart,changed" - a content object placed under the "smart"

View File

@ -31,9 +31,9 @@
* possible, but it's sized vertically the most it needs to fit its\
* contents.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for inner windown objects. It also
* emits the signals inherited from @ref Layout.
* emits the signals inherited from @ref Elm_Layout.
*
* Default content parts of the inwin that you can use for are:
* @li "default" A content of the inwin

View File

@ -28,11 +28,11 @@
* Custom themes can of course invent new markup tags and style them any way
* they like.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for label objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "language,changed": The program's language changed.
* @li @c "slide,end": The slide is end.
*

View File

@ -19,11 +19,11 @@
* A list is a very simple type of list widget. For more robust lists,
* @ref Genlist should probably be used.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for list objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "activated" - The user has double-clicked or pressed
* (enter|return|spacebar) on an item. The @p event_info parameter
* is the item that was activated.

View File

@ -18,11 +18,11 @@
* @li #ELM_PANEL_ORIENT_RIGHT
* @li #ELM_PANEL_ORIENT_BOTTOM
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for panel objects (since 1.8).
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "toggled" : When the panel has been toggled. (since 1.18)
* @li @c "scroll" : When the content has been scrolled (moved). (since 1.10)
* This signal is emitted only when the panel is scrollable.

View File

@ -17,11 +17,11 @@
* Panes can be split vertically or horizontally, and contents
* size proportion can be customized (homogeneous by default).
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for panes objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "press" - The panes has been pressed (button wasn't released yet).
* - @c "unpress" - The panes was released after being pressed.
* - @c "clicked" - The panes has been clicked>

View File

@ -30,11 +30,11 @@
* Applications can query the progress bar for its value with
* elm_progressbar_value_get().
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for progress bar objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "changed" - when the value is changed (since 1.7)
* @li @c "focused" - When the progressbar has received focus. (since 1.8)
* @li @c "unfocused" - When the progressbar has lost focus. (since 1.8)

View File

@ -33,11 +33,11 @@
* The radio objects will modify this directly. That implies the pointer must
* point to valid memory for as long as the radio objects exist.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for radio objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* @li @c "changed" - This is called when the radio object is selected. If you
* want to trace the state change of a radio group, you should add this callback
* to all the radio objects in that group.

View File

@ -12,7 +12,7 @@
* always have a small minimum size by default as it won't be limited
* by the contents of the scroller.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for scroller objects.
*
* This widget emits the following signals, besides the ones sent from

View File

@ -21,11 +21,11 @@
* Only one segment item can be at selected state. A segment item can display
* combination of Text and any Evas_Object like Images or other widget.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for segment control objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "changed" - When the user clicks on a segment item which is not
* previously selected and get selected. The event_info parameter is the
* segment item pointer.

View File

@ -9,10 +9,10 @@
*
* A separator can be vertical or horizontal.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for separator objects.
*
* This widget emits the signals coming from @ref Layout.
* This widget emits the signals coming from @ref Elm_Layout.
*
* @ref tutorial_separator is a good example of how to use a separator.
* @{

View File

@ -29,11 +29,11 @@
* the object or applications scaling factor. At any point code can query the
* slider for its value with elm_slider_value_get().
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for slider objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "changed" - Whenever the slider value is changed by the user.
* - @c "slider,drag,start" - dragging the slider indicator around has started.
* - @c "slider,drag,stop" - dragging the slider indicator around has stopped.

View File

@ -48,11 +48,11 @@
* cached @b before and @b after the current item, in the widget's
* item list.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for slideshow objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "changed" - when the slideshow switches its view to a new
* item. event_info parameter in callback contains the current visible item
* - @c "transition,end" - when a slide transition ends. event_info parameter

View File

@ -21,11 +21,11 @@
*
* It also allows specific values to be replaced by pre-defined labels.
*
* This widget inherits from the @ref Layout one, so that all the
* This widget inherits from the @ref Elm_Layout one, so that all the
* functions acting on it also work for spinner objects.
*
* This widget emits the following signals, besides the ones sent from
* @ref Layout:
* @ref Elm_Layout :
* - @c "changed" - Whenever the spinner value is changed.
* - @c "delay,changed" - A short time after the value is changed by
* the user. This will be called only when the user stops dragging

View File

@ -15,7 +15,7 @@
*
* @section elm-layout-class The Elementary Layout Class
*
* Elementary, besides having the @ref Layout widget, exposes its
* Elementary, besides having the @ref Elm_Layout widget, exposes its
* foundation -- the Elementary Layout Class -- in order to create
* other widgets which are, basically, a certain layout with some more
* logic on top.