enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

elm: update new-style docs across elm so they validate right

This commit is contained in:
Daniel Kolesa 2015-07-08 15:49:38 +01:00
parent e5e148ba6e
commit 84025861af
26 changed files with 147 additions and 206 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
legacy/elementary/src/lib/elm_actionslider.eo
View File

@ -1,9 +1,6 @@
enum Elm.Actionslider.Pos
{
[[
@ingroup Actionslider
A position for indicators, magnets, and enabled items.
]]
[[A position for indicators, magnets, and enabled items.]]
legacy: elm_actionslider;
none = 0, [[No position is set.]]

4
legacy/elementary/src/lib/elm_bg.eo
View File

@ -1,12 +1,10 @@
enum Elm.Bg.Option
{
[[
@addtogroup Bg
Identifiers on how a background widget is to display its image --
if it was set to use an image file.
@see elm_bg_option_set()
@see elm_bg_option_get()
See also @Elm.Bg.option.set, @Elm.Bg.option.get.
]]
center, [[Center the background image.]]
scale, [[Scale the background image, retaining aspect ratio (default).]]

8
legacy/elementary/src/lib/elm_bubble.eo
View File

@ -1,11 +1,9 @@
enum Elm.Bubble.Pos
{
[[
@addtogroup Bubble
Defines the corner values for a bubble.
[[Defines the corner values for a bubble.
The corner will be used to determine where the arrow of the
bubble points to.
The corner will be used to determine where the arrow of the
bubble points to.
]]
invalid = -1, [[Invalid corner.]]
top_left, [[The arrow of the bubble points to the top left corner.]]

29
legacy/elementary/src/lib/elm_calendar.eo
View File

@ -1,11 +1,8 @@
enum Elm.Calendar.Mark.Repeat.Type
{
[[
@addtogroup Calendar
@enum Elm_Calendar_Mark_Repeat_Type
Event periodicity, used to define if a mark should be repeated
@b beyond event's day. It's set when a mark is added.
beyond event's day. It's set when a mark is added.
So, for a mark added to 13th May with periodicity set to WEEKLY,
there will be marks every week after this date. Marks will be displayed
@ -13,7 +10,7 @@ enum Elm.Calendar.Mark.Repeat.Type
Values don't work as bitmask, only one can be chosen.
@see elm_calendar_mark_add()
See also @Elm.Calendar.mark_add.
]]
legacy: elm_calendar;
unique, [[Default value. Marks will be displayed only on event day.]]
@ -21,17 +18,17 @@ enum Elm.Calendar.Mark.Repeat.Type
weekly, [[Marks will be displayed every week after event day (inclusive) - i.e. each seven days.]]
monthly, [[Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar.]]
annually, [[Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013.]]
last_day_of_month [[Marks will be displayed every last day of month after event day (inclusive). @since 1.7]]
last_day_of_month [[Marks will be displayed every last day of month after event day (inclusive).
@since 1.7]]
}
enum Elm.Calendar.Weekday
{
[[
@addtogroup Calendar
@enum Elm_Calendar_Weekday
A weekday
@see elm_calendar_first_day_of_week_set()
See also @Elm.Calendar.first_day_of_week.set.
]]
legacy: elm_day;
sunday,
@ -47,12 +44,9 @@ enum Elm.Calendar.Weekday
enum Elm.Calendar.Select.Mode
{
[[
@addtogroup Calendar
@enum Elm_Calendar_Select_Mode
The mode, who determine how user could select a day
@see elm_calendar_select_mode_set()
See also @Elm.Calendar.select_mode.set()
]]
default = 0, [[Default value. a day is always selected.]]
always, [[A day is always selected.]]
@ -63,14 +57,11 @@ enum Elm.Calendar.Select.Mode
enum Elm.Calendar.Selectable
{
[[
@addtogroup Calendar
@Elm_Calendar_Selectable
A bitmask used to define which fields of a @b tm struct will be taken into
A bitmask used to define which fields of a $tm struct will be taken into
account, when elm_calendar_selected_time_set() is invoked.
@see elm_calendar_selectable_set()
@see elm_calendar_selected_time_set()
See also @Elm.Calendar.selectable.set, @Elm.Calendar.selected_time_set.
@since 1.8
]]
none = 0,

4
legacy/elementary/src/lib/elm_check.eo
View File

@ -7,7 +7,7 @@ class Elm.Check (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
[[Set the on/off state of the check object
This sets the state of the check. If set with
@elm_check_state_pointer_set, the state of that variable is also
@.state_pointer.set, the state of that variable is also
changed. Calling this doesn't cause the "changed" signal to
be emitted.
]]
@ -28,7 +28,7 @@ class Elm.Check (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
object pointed to simply use null as the "statep" parameter.
If "statep" is not null, then when this is called, the check
objects state will also be modified to reflect the value of the
boolean "statep" points to, just like calling @elm_check_state_set.
boolean "statep" points to, just like calling @.state.set.
]]
}
values {

9
legacy/elementary/src/lib/elm_clock.eo
View File

@ -1,15 +1,10 @@
enum Elm.Clock.Edit_Mode
{
[[
@addtogroup Clock
@enum Elm_Clock_Edit_Mode
Identifiers for which clock digits should be editable, when a
[[Identifiers for which clock digits should be editable, when a
clock widget is in edition mode. Values may be OR-ed together to
make a mask, naturally.
@see elm_clock_edit_set()
@see elm_clock_edit_mode_set()
See also @Elm.Clock.edit.set, @Elm.Clock.edit_mode.set.
]]
legacy: elm_clock_edit;

9
legacy/elementary/src/lib/elm_colorselector.eo
View File

@ -1,13 +1,8 @@
enum Elm.Colorselector.Mode
{
[[
@addtogroup Datetime
@enum Elm_Colorselector_Mode
[[Different modes supported by Colorselector
Different modes supported by Colorselector
@see elm_colorselector_mode_set()
@see elm_colorselector_mode_get()
See also @Elm.Colorselector.mode.set, @Elm.Colorselector.mode.get.
]]
legacy: elm_colorselector;
palette = 0, [[Only color palette is displayed.]]

5
legacy/elementary/src/lib/elm_ctxpopup.eo
View File

@ -1,9 +1,6 @@
enum Elm.Ctxpopup.Direction
{
[[
@ingroup Ctxpopup
Direction in which to show the popup.
]]
[[Direction in which to show the popup.]]
down, [[Ctxpopup show appear below clicked area.]]
right, [[Ctxpopup show appear to the right of the clicked area.]]
left, [[Ctxpopup show appear to the left of the clicked area.]]

6
legacy/elementary/src/lib/elm_datetime.eo
View File

@ -1,9 +1,7 @@
enum Elm.Datetime.Field_Type
{
[[
@addtogroup Datetime
Identifies a Datetime field, The widget supports 6 fields : Year, month,
Date, Hour, Minute, AM/PM
[[Identifies a Datetime field, The widget supports 6 fields : Year, month,
Date, Hour, Minute, AM/PM
]]
legacy: elm_datetime;

11
legacy/elementary/src/lib/elm_dayselector.eo
View File

@ -1,12 +1,9 @@
enum Elm.Dayselector.Day
{
[[
@addtogroup Dayselector
Identifies the day of the week.
API can call the selection/unselection of day with this as a parameter.
[[Identifies the day of the week. API can call the selection/unselection
of day with this as a parameter.
@see elm_dayselector_day_selected_set()
@see elm_dayselector_day_selected_get()
See also @Elm.Dayselector.day_selected_set, @Elm.Dayselector.day_selected_get.
]]
legacy: elm_dayselector;
@ -17,7 +14,7 @@ enum Elm.Dayselector.Day
thu, [[Indicates Thursday.]]
fri, [[Indicates Friday.]]
sat, [[Indicates Saturday.]]
max [[Sentinel value, @b don't use.]]
max [[Sentinel value, don't use.]]
}
class Elm.Dayselector (Elm.Layout)

72
legacy/elementary/src/lib/elm_entry.eo
View File

@ -3,7 +3,8 @@ import elm_general;
enum Elm.Text_Format
{
[[Text Format types.
@see elm_entry_file_text_format()
See also @Elm.Entry.file_text_format.
]]
plain_utf8, [[ Plain UTF8 type ]]
markup_utf8 [[ Markup UTF8 type ]]
@ -11,11 +12,9 @@ enum Elm.Text_Format
enum Elm.Input.Panel.Layout
{
[[
@addtogroup Entry
Input panel (virtual keyboard) layout types.
[[Input panel (virtual keyboard) layout types.
Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired.
@see elm_entry_input_panel_layout_set()
See also @Elm.Entry.input_panel_layout.set.
]]
normal, [[Default layout.]]
number, [[Number layout.]]
@ -29,17 +28,19 @@ enum Elm.Input.Panel.Layout
hex, [[Hexadecimal layout.]]
terminal, [[Command-line terminal layout including esc, alt, ctrl key, so on (no auto-correct, no auto-capitalization).]]
password, [[Like normal, but no auto-correct, no auto-capitalization etc.]]
datetime, [[Date and time layout @since 1.8]]
emoticon [[Emoticon layout @since 1.10]]
datetime, [[Date and time layout
@since 1.8]]
emoticon [[Emoticon layout
@since 1.10]]
}
enum Elm.Input.Panel.Lang
{
[[
@addtogroup Entry
Input panel (virtual keyboard) language modes.
[[Input panel (virtual keyboard) language modes.
@see elm_entry_input_panel_language_set()
See also @Elm.Entry.input_panel_language.set.
]]
automatic, [[Automatic]]
alphabet [[Alphabet]]
@ -47,12 +48,10 @@ enum Elm.Input.Panel.Lang
enum Elm.Autocapital.Type
{
[[
@addtogroup Entry
Autocapitalization Types.
[[Autocapitalization Types.
Choose method of auto-capitalization.
@see elm_entry_autocapital_type_set()
See also @Elm.Entry.autocapital_type.set.
]]
none, [[No auto-capitalization when typing.]]
word, [[Autocapitalize each word typed.]]
@ -62,10 +61,8 @@ enum Elm.Autocapital.Type
enum Elm.Input.Panel.Return_Key.Type
{
[[
@addtogroup Entry
"Return" Key types on the input panel (virtual keyboard).
@see elm_entry_input_panel_return_key_type_set()
[["Return" Key types on the input panel (virtual keyboard).
See also @Elm.Entry.input_panel_return_key_type.set.
]]
default, [[Default.]]
@ -76,20 +73,27 @@ enum Elm.Input.Panel.Return_Key.Type
next, [[Next.]]
search, [[Search string or magnifier icon.]]
send, [[Send.]]
signin [[Sign-in @since 1.8]]
signin [[Sign-in
@since 1.8]]
}
enum Elm.Input.Hints
{
[[
@addtogroup Entry
@brief Enumeration that defines the types of Input Hints.
@since 1.12
[[Enumeration that defines the types of Input Hints.
@since 1.12
]]
legacy: elm_input_hint;
none = 0, [[No active hints @since 1.12.]]
auto_complete = 1 << 0, [[Suggest word auto completion @since 1.12.]]
sensitive_data = 1 << 1, [[Typed text should not be stored. @since 1.12.]]
none = 0, [[No active hints
@since 1.12]]
auto_complete = 1 << 0, [[Suggest word auto completion
@since 1.12]]
sensitive_data = 1 << 1, [[Typed text should not be stored.
@since 1.12]]
}
class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
@ -196,20 +200,16 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
@property file_text_format {
[[Text format used to load and save the file, which could be plain text or markup text.
Default is @c ELM_TEXT_FORMAT_PLAIN_UTF8, if you want to use
@c ELM_TEXT_FORMAT_MARKUP_UTF8 then you need to set the text format
before calling @ref efl_file_set.
Default is $ELM_TEXT_FORMAT_PLAIN_UTF8, if you want to use
$ELM_TEXT_FORMAT_MARKUP_UTF8 then you need to set the text format
before calling @Efl.File.file.set.
You could also set it before a call to @ref elm_obj_entry_file_save
You could also set it before a call to @.file_save
in order to save with the given format.
@ingroup Entry
]]
set {
[[Use it before calling @ref efl_file_set or @ref elm_obj_entry_file_save.
@ingroup Entry
]]
[[Use it before calling @Efl.File.file.set or @.file_save.]]
}
values {
format: Elm.Text_Format(Elm.Text_Format.plain_utf8); [[ The file format ]]

4
legacy/elementary/src/lib/elm_fileselector.eo
View File

@ -13,14 +13,14 @@ class Elm.Fileselector (Elm.Layout, Elm_Interface_Fileselector,
"done" smart event, and is only usable if one is just hooking
to the other two events.
See also @elm_fileselector_buttons_ok_cancel_get.
See also @.buttons_ok_cancel.get.
]]
}
get {
[[Get whether the "ok" and "cancel" buttons on a given file
selector widget are being shown.
See also @elm_fileselector_buttons_ok_cancel_set for more details.
See also @.buttons_ok_cancel.set for more details.
]]
}
values {

14
legacy/elementary/src/lib/elm_fileselector_button.eo
View File

@ -9,8 +9,8 @@ class Elm.Fileselector_Button (Elm.Button, Elm_Interface_Fileselector)
dedicated Elementary window. By default, it depends on the
current profile.
See @elm_win_inwin_add for more information on inner windows.
See also @elm_fileselector_button_inwin_mode_get.
See \@ref elm_win_inwin_add for more information on inner windows.
See also @.inwin_mode.get.
]]
}
get {
@ -18,7 +18,7 @@ class Elm.Fileselector_Button (Elm.Button, Elm_Interface_Fileselector)
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window.
See also @elm_fileselector_button_inwin_mode_set for more details.
See also @.inwin_mode.set for more details.
]]
}
values {
@ -35,7 +35,7 @@ class Elm.Fileselector_Button (Elm.Button, Elm_Interface_Fileselector)
widget is not under "inwin mode". The default size for the
window (when applicable) is 400x400 pixels.
See also @elm_fileselector_button_window_size_get.
See also @.window_size.get.
]]
}
get {
@ -45,7 +45,7 @@ class Elm.Fileselector_Button (Elm.Button, Elm_Interface_Fileselector)
Note: Use null pointers on the size values you're not
interested in: they'll be ignored by the function.
See also @elm_fileselector_button_window_size_set for more
See also @.window_size.set for more
details.
]]
}
@ -65,14 +65,14 @@ class Elm.Fileselector_Button (Elm.Button, Elm_Interface_Fileselector)
Note: It will only take effect if the file selector
button widget is not under "inwin mode".
See also @elm_fileselector_button_window_title_get.
See also @.window_title.get.
]]
}
get {
[[Get the title for a given file selector button widget's
window
See also @elm_fileselector_button_window_title_set for more
See also @.window_title.set for more
details.
]]
}

20
legacy/elementary/src/lib/elm_general.eot
View File

@ -10,12 +10,12 @@ enum Elm.Policy
{
[[Policy identifiers.]]
quit, [[under which circumstances the application should quit automatically.
See also @Elm_Policy_Quit.]]
exit, [[defines elm_exit() behaviour. See also @Elm_Policy_Exit.
See also @Elm.Policy.quit.]]
exit, [[defines elm_exit() behaviour. See also @Elm.Policy.exit.
@since 1.8
]]
throttle, [[defines how throttling should work. See also @Elm_Policy_Throttle
throttle, [[defines how throttling should work. See also @Elm.Policy.throttle
@since 1.8
]]
@ -27,7 +27,9 @@ enum Elm.Policy.Quit
[[Possible values for the #ELM_POLICY_QUIT policy]]
none = 0, [[never quit the application automatically]]
last_window_closed, [[quit when the application's last window is closed]]
last_window_hidden [[quit when the application's last window is hidden @since 1.14]]
last_window_hidden [[quit when the application's last window is hidden
@since 1.14]]
}
enum Elm.Policy.Exit
@ -90,13 +92,11 @@ enum Elm.Object.Multi_Select_Mode
enum Elm.Wrap.Type
{
[[
@addtogroup Entry
Line wrapping types.
[[Line wrapping types.
Type of word or character wrapping to use.
@see elm_entry_line_wrap_set()
@see elm_popup_content_text_wrap_type_set
@see elm_label_line_wrap_set()
See also \@ref elm_entry_line_wrap_set, \@ref
elm_popup_content_text_wrap_type_set, \@ref elm_label_line_wrap_set.
]]
legacy: elm_wrap;

15
legacy/elementary/src/lib/elm_gengrid_item.eo
View File

@ -2,11 +2,7 @@ import elm_general;
enum Elm.Gengrid.Item.Scrollto_Type
{
[[
Defines where to position the item in the genlist.
@ingroup Gengrid
]]
[[Defines where to position the item in the genlist.]]
legacy: elm_gengrid_item_scrollto;
none = 0, [[No scrollto.]]
in = (1 << 0), [[To the nearest viewport.]]
@ -16,13 +12,8 @@ enum Elm.Gengrid.Item.Scrollto_Type
enum Elm.Gengrid.Item.Field_Type
{
[[
Defines the type of the item part
Used while updating item's parts
It can be used at updating multi fields.
@ingroup Gengrid
]]
[[Defines the type of the item part Used while updating item's parts.
It can be used at updating multi fields.]]
legacy: elm_gengrid_item_field;
all = 0,
text = (1 << 0),

19
legacy/elementary/src/lib/elm_genlist_item.eo
View File

@ -2,10 +2,8 @@ import elm_general;
enum Elm.Genlist.Item.Type
{
[[
Defines if the item is of any special type (has subitems or it's the
index of a group), or is just a simple item.
@ingroup Genlist
[[Defines if the item is of any special type (has subitems or it's the
index of a group), or is just a simple item.
]]
legacy: elm_genlist_item;
none = 0, [[Simple item.]]
@ -16,11 +14,9 @@ enum Elm.Genlist.Item.Type
enum Elm.Genlist.Item.Field_Type
{
[[
Defines the type of the item part
Used while updating item's parts
It can be used at updating multi fields.
@ingroup Genlist
[[Defines the type of the item part
Used while updating item's parts
It can be used at updating multi fields.
]]
legacy: elm_genlist_item_field;
all = 0,
@ -31,10 +27,7 @@ enum Elm.Genlist.Item.Field_Type
enum Elm.Genlist.Item.Scrollto_Type
{
[[
Defines where to position the item in the genlist.
@ingroup Genlist
]]
[[Defines where to position the item in the genlist.]]
legacy: elm_genlist_item_scrollto;
none = 0, [[No scrollto.]]
in = (1 << 0), [[To the nearest viewport.]]

5
legacy/elementary/src/lib/elm_hover.eo
View File

@ -1,9 +1,6 @@
enum Elm.Hover.Axis
{
[[
@addtogroup Hover
The orientation axis for the hover object
]]
[[The orientation axis for the hover object]]
none, [[ELM_HOVER_AXIS_NONE -- no preferred orientation.]]
horizontal, [[ELM_HOVER_AXIS_HORIZONTAL -- horizontal.]]
vertical, [[ELM_HOVER_AXIS_VERTICAL -- vertical.]]

25
legacy/elementary/src/lib/elm_icon.eo
View File

@ -8,13 +8,8 @@ enum Elm.Icon.Type
enum Elm.Icon.Lookup_Order
{
[[
@addtogroup Icon
@enum Elm_Icon_Lookup_Order
@typedef Elm_Icon_Lookup_Order
Lookup order used by elm_icon_standard_set(). Should look for icons in the
theme, FDO paths, or both?
[[Lookup order used by elm_icon_standard_set(). Should look for icons in
the theme, FDO paths, or both?
]]
legacy: elm_icon_lookup;
fdo_theme, [[Icon look up order: freedesktop, theme.]]
@ -32,13 +27,13 @@ class Elm.Icon (Elm.Image)
set {
[[Sets the icon lookup order used by elm_icon_standard_set().
See also @elm_icon_order_lookup_get, @Elm_Icon_Lookup_Order.
See also @.order_lookup.get, @Elm.Icon.Lookup_Order.
]]
}
get {
[[Get the icon lookup order.
See also @elm_icon_order_lookup_set, @Elm_Icon_Lookup_Order.
See also @.order_lookup.set, @Elm.Icon.Lookup_Order.
]]
}
values {
@ -59,17 +54,17 @@ class Elm.Icon (Elm.Image)
match those icon keys. The "name" given as parameter is one of
these "keys", and will be used to look in the freedesktop.org
paths and elementary theme. One can change the lookup order
with @elm_icon_order_lookup_set.
with @.order_lookup.set.
If name is not found in any of the expected locations and it is
the absolute path of an image file, this image will be used.
Note: The icon image set by this function can be changed by
@elm_image_file_set.
@Efl.File.file.set.
Note: This function does not accept relative icon path.
See also @elm_icon_standard_get.
See also @.standard.get.
]]
return: bool; [[true on success, false on error]]
}
@ -77,7 +72,7 @@ class Elm.Icon (Elm.Image)
[[Get the icon name set by icon standard names.
If the icon image was set using elm_image_file_set() instead of
@elm_icon_standard_set, then this function will return null.
@.standard.set, then this function will return null.
]]
}
values {
@ -89,12 +84,10 @@ class Elm.Icon (Elm.Image)
[[Set the file that will be used, but use a generated thumbnail.
This functions like elm_image_file_set() but requires the Ethumb
library support to be enabled successfully with @elm_need_ethumb.
library support to be enabled successfully with $elm_need_ethumb.
When set the file indicated has a thumbnail generated and cached
on disk for future use or will directly use an existing cached
thumbnail if it is valid.
See also @elm_image_file_set.
]]
}
values {

6
legacy/elementary/src/lib/elm_interface_fileselector.eo
View File

@ -1,9 +1,7 @@
enum Elm.Fileselector.Mode
{
[[
@addtogroup Fileselector
Defines how a file selector widget is to layout its contents
(file system entries).
[[Defines how a file selector widget is to layout its contents
(file system entries).
]]
legacy: elm_fileselector;
list = 0, [[Layout as a list.]]

5
legacy/elementary/src/lib/elm_label.eo
View File

@ -2,10 +2,7 @@ import elm_general;
enum Elm.Label.Slide_Mode
{
[[
@addtogroup Label
Slide mode of a label widget
]]
[[Slide mode of a label widget]]
none = 0, [[No slide effect.]]
auto, [[Slide only if the label area is bigger than the text width length.]]
always [[Slide always.]]

35
legacy/elementary/src/lib/elm_list.eo
View File

@ -2,24 +2,37 @@ import elm_general;
enum Elm.List.Mode
{
[[
@addtogroup List
Set list's resizing behavior, transverse axis scrolling and items
[[Set list's resizing behavior, transverse axis scrolling and items
cropping. See each mode's description for more details.
@note Default value is #ELM_LIST_SCROLL.
Note: Default value is @Elm.List.Mode.scroll.
Values here @b don't work as bitmasks -- only one can be chosen at
Values here don't work as bitmasks -- only one can be chosen at
a time.
@see elm_list_mode_set()
@see elm_list_mode_get()
See also @Elm.List.mode.set, @Elm.List.mode.get.
]]
legacy: elm_list;
compress = 0, [[The list @b won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zeroed dimensions. The list will respect the container's geometry and, if any of its items won't fit into its @b transverse axis, one won't be able to scroll it in that direction.]]
scroll, [[Default value. This is the same as #ELM_LIST_COMPRESS, with the exception that if any of its items won't fit into its transverse axis, one @b will be able to scroll it in that direction.]]
limit, [[Sets a minimum size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a @b minimum size hint will be set for its @b transverse axis, so that the @b largest item in that direction fits well. This is naturally bound by the list object's maximum size hints, set externally.]]
expand, [[Besides setting a minimum size on the transverse axis, just like on #ELM_LIST_LIMIT, the list will set a minimum size on the @b longitudinal axis, trying to reserve space to all its children to be visible at a time. . This is naturally bound by the list object's maximum size hints, set externally.]]
compress = 0, [[The list won't set any of its size hints to inform how a
possible container should resize it. Then, if it's not
created as a "resize object", it might end with zeroed
dimensions. The list will respect the container's geometry
and, if any of its items won't fit into its transverse axis,
one won't be able to scroll it in that direction.]]
scroll, [[Default value. This is the same as #ELM_LIST_COMPRESS, with the
exception that if any of its items won't fit into its transverse
axis, one will be able to scroll it in that direction.]]
limit, [[Sets a minimum size hint on the list object, so that containers may
respect it (and resize itself to fit the child properly). More
specifically, a minimum size hint will be set for its transverse
axis, so that the largest item in that direction fits well. This
is naturally bound by the list object's maximum size hints, set
externally.]]
expand, [[Besides setting a minimum size on the transverse axis, just like
on @Elm.List.Mode.limit, the list will set a minimum size on th
longitudinal axis, trying to reserve space to all its children to
be visible at a time. . This is naturally bound by the list
object's maximum size hints, set externally.]]
last [[Indicates error if returned by elm_list_mode_get().]]
}

6
legacy/elementary/src/lib/elm_photo.eo
View File

@ -39,15 +39,15 @@ class Elm.Photo (Elm.Widget, Efl.File, Evas.Clickable_Interface, Evas.Draggable_
option will fix this original aspect, and the way that the
photo is fit into the object's area.
See also @elm_photo_aspect_fixed_get.
See also @.aspect_fixed.get.
]]
}
get {
[[Get if the object keeps the original aspect ratio.]]
}
values {
fixed: bool; [[true if the photo should fix the aspect,
false otherwise.]]
fixed: bool; [[$true if the photo should fix the aspect,
$false otherwise.]]
}
}
@property size {

7
legacy/elementary/src/lib/elm_popup.eo
View File

@ -2,13 +2,12 @@ import elm_general;
enum Elm.Popup.Orient
{
[[
@brief Possible orient values for popup.
[[Possible orient values for popup.
These values should be used in conjunction to elm_popup_orient_set() to
set the position in which the popup should appear(relative to its parent)
and in conjunction with elm_popup_orient_get() to know where the popup
is appearing.
@ingroup Popup
]]
top = 0, [[Popup should appear in the top of parent, default.]]
@ -20,7 +19,7 @@ enum Elm.Popup.Orient
top_right, [[Popup should appear in the top right of parent.]]
bottom_left, [[Popup should appear in the bottom left of parent.]]
bottom_right, [[Notify should appear in the bottom right of parent.]]
last [[Sentinel value, @b don't use.]]
last [[Sentinel value, don't use.]]
}

6
legacy/elementary/src/lib/elm_scroller.eo
View File

@ -2,7 +2,7 @@ enum Elm.Scroller.Policy
{
[[Type that controls when scrollbars should appear.
See also @elm_scroller_policy_set.
See also @Elm_Interface_Scrollable.policy.set.
]]
auto = 0, [[Show scrollbars as needed]]
on, [[Always show scrollbars]]
@ -14,7 +14,7 @@ enum Elm.Scroller.Single_Direction
{
[[Type that controls how the content is scrolled.
See also @elm_scroller_single_direction_set.
See also @Elm_Interface_Scrollable.single_direction.set.
]]
none = 0, [[Scroll every direction]]
soft, [[Scroll single direction if the direction is certain]]
@ -26,8 +26,6 @@ enum Elm.Scroller.Movement_Block
{
[[Type that blocks the scroll movement in one or more direction.
See also @elm_scroller_movement_block.
@since 1.8
]]
legacy: elm_scroller_movement;

2
legacy/elementary/src/lib/elm_toolbar.eo
View File

@ -10,7 +10,7 @@ enum Elm.Toolbar.Shrink_Mode
Values don't work as bitmask, only one can be chosen.
See also @elm_toobar_shrink_mode_set, @elm_toolbar_shrink_mode_get.
See also @Elm.Toolbar.shrink_mode.set, @Elm.Toolbar.shrink_mode.get.
]]
legacy: elm_toolbar_shrink;

22
legacy/elementary/src/lib/elm_win.eo
View File

@ -24,7 +24,7 @@ enum Elm.Win.Type
utility, [[A persistent utility window, like a toolbox or palette.]]
splash, [[Splash window for a starting up application.]]
dropdown_menu, [[The window is a dropdown menu, as when an entry in a
menubar is clicked. Typically used with @elm_win_override_set.
menubar is clicked. Typically used with @Elm.Win.override.set.
This hint exists for completion only, as the EFL way of
implementing a menu would not normally use a separate
window for its contents.]]
@ -32,7 +32,7 @@ enum Elm.Win.Type
right-clicking an object.]]
tooltip, [[The window is a tooltip. A short piece of explanatory text that
typically appear after the mouse cursor hovers over an object
for a while. Typically used with @elm_win_override_set and also
for a while. Typically used with @Elm.Win.override.set and also
not very commonly used in the EFL.]]
notification, [[A notification window, like a warning about battery life or
a new E-Mail received.]]
@ -46,9 +46,9 @@ enum Elm.Win.Type
all of its contents will be rendered to an image buffer.
This allows to have children window inside a parent one
just like any other object would be, and do other things
like applying @Evas_Map effects to it. This is the only
like applying \@ref Evas_Map effects to it. This is the only
type of window that requires the parent parameter of
@elm_win_add to be a valid @Evas_Object.]]
\@ref elm_win_add to be a valid @Evas.Object.]]
socket_image, [[The window is rendered onto an image buffer and can be shown
other process's plug image object. No actual window is
created for this type, instead the window and all of its
@ -214,20 +214,16 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
@property autohide {
[[Window's autohide state.
This property works similarly to @c autodel, automatically handling
"delete,request" signals when set to @c EINA_TRUE, with the difference
This property works similarly to @.autodel, automatically handling
"delete,request" signals when set to $trze, with the difference
that it will hide the window, instead of destroying it.
It is specially designed to work together with @c ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN
It is specially designed to work together with $ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN
which allows exiting Elementary's main loop when all the windows
are hidden.
@see elm_win_autodel_set()
@note @c autodel and @c autohide are not mutually exclusive. The window
will be deleted if both are set to @c EINA_TRUE.
@ingroup Win
Note: @.autodel and $autohide are not mutually exclusive. The window
will be deleted if both are set to $true.
]]
set {