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

elementary: use @cref where possible

This commit is contained in:
Daniel Kolesa 2017-11-01 12:10:05 +01:00
parent eab6f009e2
commit b4705ea968
12 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/lib/efl/interfaces/efl_gfx_buffer.eo
View File

@ -95,7 +95,7 @@ interface Efl.Gfx.Buffer ()
image object to be updated (redrawn) at the next rendering cycle. image object to be updated (redrawn) at the next rendering cycle.
]] ]]
params { params {
@in region: const(ptr(Eina.Rect)) @optional; [[The updated region.]] @cref region: Eina.Rect @optional; [[The updated region.]]
} }
} }
@ -131,7 +131,7 @@ interface Efl.Gfx.Buffer ()
params { params {
@in mode: Efl.Gfx.Buffer.Access_Mode; [[Specifies whether to map for read-only, @in mode: Efl.Gfx.Buffer.Access_Mode; [[Specifies whether to map for read-only,
write-only or read-write access (OR combination of flags).]] write-only or read-write access (OR combination of flags).]]
@in region: const(ptr(Eina.Rect)) @optional; [[The region to map.]] @cref region: Eina.Rect @optional; [[The region to map.]]
@in cspace: Efl.Gfx.Colorspace @optional; [[Requested colorspace. If different from the internal cspace, @in cspace: Efl.Gfx.Colorspace @optional; [[Requested colorspace. If different from the internal cspace,
map should try to convert the data into a new buffer. map should try to convert the data into a new buffer.
argb8888 by default.]] argb8888 by default.]]
@ -174,7 +174,7 @@ interface Efl.Gfx.Buffer ()
$slice should not be the return value of @.buffer_managed_get. $slice should not be the return value of @.buffer_managed_get.
]] ]]
params { params {
@in slice: ptr(const(Eina.Slice)) @nullable; [[If $null, allocates an empty buffer]] @cref slice: Eina.Slice @nullable; [[If $null, allocates an empty buffer]]
@in size: Eina.Size2D; [[The size in pixels.]] @in size: Eina.Size2D; [[The size in pixels.]]
@in stride: int @optional; [[If 0, automatically guessed from the $width.]] @in stride: int @optional; [[If 0, automatically guessed from the $width.]]
@in cspace: Efl.Gfx.Colorspace @optional; [[argb8888 by default.]] @in cspace: Efl.Gfx.Colorspace @optional; [[argb8888 by default.]]
@ -199,7 +199,7 @@ interface Efl.Gfx.Buffer ()
internally. internally.
]] ]]
params { params {
@in slice: ptr(const(Eina.Slice)) @nullable; [[If $null, detaches the previous buffer.]] @cref slice: Eina.Slice @nullable; [[If $null, detaches the previous buffer.]]
@in size: Eina.Size2D; [[The size in pixels.]] @in size: Eina.Size2D; [[The size in pixels.]]
@in stride: int @optional; [[If 0, automatically guessed from the $width.]] @in stride: int @optional; [[If 0, automatically guessed from the $width.]]
@in cspace: Efl.Gfx.Colorspace @optional; [[argb8888 by default.]] @in cspace: Efl.Gfx.Colorspace @optional; [[argb8888 by default.]]

2
src/lib/elementary/efl_access.eo
View File

@ -356,7 +356,7 @@ mixin Efl.Access (Efl.Interface, Efl.Object)
[[Emit event]] [[Emit event]]
params { params {
@in accessible: Efl.Access; [[Accessibility object.]] @in accessible: Efl.Access; [[Accessibility object.]]
@in event: ptr(const(Efl.Event.Description)); [[Accessibility event type.]] @cref event: Efl.Event.Description; [[Accessibility event type.]]
@in event_info: void_ptr; [[Accessibility event details.]] @in event_info: void_ptr; [[Accessibility event details.]]
} }
} }

2
src/lib/elementary/efl_ui_win.eo
View File

@ -228,6 +228,7 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Efl.Access.Window,
]] ]]
legacy: elm_win_wm_rotation_available_rotations_set; legacy: elm_win_wm_rotation_available_rotations_set;
values { values {
/* FIXME: array */
rotations: ptr(const(int)); [[The array of rotation value.]] rotations: ptr(const(int)); [[The array of rotation value.]]
count: uint; [[The size of the rotations array.]] count: uint; [[The size of the rotations array.]]
} }
@ -843,7 +844,6 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Efl.Access.Window,
Efl.Gfx.Size.Hint.hint_base { get; set; } Efl.Gfx.Size.Hint.hint_base { get; set; }
Efl.Gfx.Size.Hint.hint_step { get; set; } Efl.Gfx.Size.Hint.hint_step { get; set; }
Efl.Gfx.Size.Hint.hint_aspect { set; } Efl.Gfx.Size.Hint.hint_aspect { set; }
Efl.Gfx.Size.Hint.hint_weight { set; }
Efl.Gfx.Size.Hint.hint_max { set; } Efl.Gfx.Size.Hint.hint_max { set; }
Efl.Text.text { get; set; } Efl.Text.text { get; set; }
Efl.Canvas.pointer_position { get; } Efl.Canvas.pointer_position { get; }

4
src/lib/elementary/elm_calendar.eo
View File

@ -252,7 +252,7 @@ class Elm.Calendar (Efl.Ui.Layout, Efl.Ui.Focus.Composition, Elm.Interface.Atspi
]] ]]
} }
values { values {
min: const(ptr(Efl.Time)); [[A tm struct to point to minimum date.]] @cref min: Efl.Time; [[A tm struct to point to minimum date.]]
} }
} }
@property date_max { @property date_max {
@ -280,7 +280,7 @@ class Elm.Calendar (Efl.Ui.Layout, Efl.Ui.Focus.Composition, Elm.Interface.Atspi
]] ]]
} }
values { values {
max: const(ptr(Efl.Time)); [[A tm struct to point to maximum date.]] @cref max: Efl.Time; [[A tm struct to point to maximum date.]]
} }
} }
selected_time_set { selected_time_set {

10
src/lib/elementary/elm_gengrid.eo
View File

@ -377,7 +377,7 @@ class Elm.Gengrid (Efl.Ui.Layout, Efl.Ui.Focus.Composition, Elm.Interface_Scroll
]] ]]
return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]] return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]]
params { params {
@in itc: ptr(const(Elm.Gengrid.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Gengrid.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in relative: Elm.Widget.Item; [[The item to place this new one before.]] @in relative: Elm.Widget.Item; [[The item to place this new one before.]]
@in func: Evas_Smart_Cb @optional; [[Convenience function called @in func: Evas_Smart_Cb @optional; [[Convenience function called
@ -403,7 +403,7 @@ class Elm.Gengrid (Efl.Ui.Layout, Efl.Ui.Focus.Composition, Elm.Interface_Scroll
]] ]]
return: Elm.Widget.Item; [[A handle to the item added or $null on error.]] return: Elm.Widget.Item; [[A handle to the item added or $null on error.]]
params { params {
@in itc: ptr(const(Elm.Gengrid.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Gengrid.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in relative: Elm.Widget.Item; [[The item to place this new one after.]] @in relative: Elm.Widget.Item; [[The item to place this new one after.]]
@in func: Evas_Smart_Cb @optional; [[Convenience function called @in func: Evas_Smart_Cb @optional; [[Convenience function called
@ -451,7 +451,7 @@ class Elm.Gengrid (Efl.Ui.Layout, Efl.Ui.Focus.Composition, Elm.Interface_Scroll
]] ]]
return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]] return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]]
params { params {
@in itc: ptr(const(Elm.Gengrid.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Gengrid.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in func: Evas_Smart_Cb @optional; [[Convenience function called @in func: Evas_Smart_Cb @optional; [[Convenience function called
when the item is selected.]] when the item is selected.]]
@ -465,7 +465,7 @@ class Elm.Gengrid (Efl.Ui.Layout, Efl.Ui.Focus.Composition, Elm.Interface_Scroll
]] ]]
return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]] return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]]
params { params {
@in itc: ptr(const(Elm.Gengrid.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Gengrid.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in func: Evas_Smart_Cb @optional; [[Convenience function called @in func: Evas_Smart_Cb @optional; [[Convenience function called
when the item is selected.]] when the item is selected.]]
@ -490,7 +490,7 @@ class Elm.Gengrid (Efl.Ui.Layout, Efl.Ui.Focus.Composition, Elm.Interface_Scroll
]] ]]
return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]] return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]]
params { params {
@in itc: ptr(const(Elm.Gengrid.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Gengrid.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in comp: Eina_Compare_Cb; [[User defined comparison function @in comp: Eina_Compare_Cb; [[User defined comparison function
that defines the sort order based that defines the sort order based

4
src/lib/elementary/elm_gengrid_item.eo
View File

@ -80,7 +80,7 @@ class Elm.Gengrid.Item(Elm.Widget.Item, Efl.Ui.Focus.Object)
the function pointers and item_style.]] the function pointers and item_style.]]
} }
values { values {
itc: ptr(const(Elm.Gengrid.Item.Class)); [[Gengrid Item class for the given item]] @cref itc: Elm.Gengrid.Item.Class; [[Gengrid Item class for the given item]]
} }
} }
@property index { @property index {
@ -219,7 +219,7 @@ class Elm.Gengrid.Item(Elm.Widget.Item, Efl.Ui.Focus.Object)
displayed. After changing the item class, elm_gengrid_item_update() is displayed. After changing the item class, elm_gengrid_item_update() is
called on the item $it.]] called on the item $it.]]
params { params {
@in itc: ptr(const(Elm.Gengrid.Item.Class)); [[The gengrid item class describing the function pointers and the item style.]] @cref itc: Elm.Gengrid.Item.Class; [[The gengrid item class describing the function pointers and the item style.]]
} }
} }
all_contents_unset{ all_contents_unset{

10
src/lib/elementary/elm_genlist.eo
View File

@ -346,7 +346,7 @@ class Elm.Genlist (Efl.Ui.Layout, Elm.Interface_Scrollable, Efl.Ui.Clickable,
]] ]]
return: Elm.Widget.Item; [[Handle to inserted item]] return: Elm.Widget.Item; [[Handle to inserted item]]
params { params {
@in itc: ptr(const(Elm.Genlist.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Genlist.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]] @in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]]
@in before_it: Elm.Widget.Item; [[The item to place this new one before.]] @in before_it: Elm.Widget.Item; [[The item to place this new one before.]]
@ -374,7 +374,7 @@ class Elm.Genlist (Efl.Ui.Layout, Elm.Interface_Scrollable, Efl.Ui.Clickable,
]] ]]
return: Elm.Widget.Item; [[Handle to inserted item]] return: Elm.Widget.Item; [[Handle to inserted item]]
params { params {
@in itc: ptr(const(Elm.Genlist.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Genlist.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]] @in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]]
@in after_it: Elm.Widget.Item; [[The item to place this new one after.]] @in after_it: Elm.Widget.Item; [[The item to place this new one after.]]
@ -454,7 +454,7 @@ class Elm.Genlist (Efl.Ui.Layout, Elm.Interface_Scrollable, Efl.Ui.Clickable,
]] ]]
return: Elm.Widget.Item; [[Handle to prepended item]] return: Elm.Widget.Item; [[Handle to prepended item]]
params { params {
@in itc: ptr(const(Elm.Genlist.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Genlist.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]] @in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]]
@in type: Elm.Genlist.Item.Type; [[Item type.]] @in type: Elm.Genlist.Item.Type; [[Item type.]]
@ -476,7 +476,7 @@ class Elm.Genlist (Efl.Ui.Layout, Elm.Interface_Scrollable, Efl.Ui.Clickable,
]] ]]
return: Elm.Widget.Item; [[Handle to appended item]] return: Elm.Widget.Item; [[Handle to appended item]]
params { params {
@in itc: ptr(const(Elm.Genlist.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Genlist.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]] @in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]]
@in type: Elm.Genlist.Item.Type; [[Item type.]] @in type: Elm.Genlist.Item.Type; [[Item type.]]
@ -493,7 +493,7 @@ class Elm.Genlist (Efl.Ui.Layout, Elm.Interface_Scrollable, Efl.Ui.Clickable,
]] ]]
return: Elm.Widget.Item; [[Handle to inserted item]] return: Elm.Widget.Item; [[Handle to inserted item]]
params { params {
@in itc: ptr(const(Elm.Genlist.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Genlist.Item.Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item data.]] @in data: const(void_ptr); [[The item data.]]
@in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]] @in parent: Elm.Widget.Item @nullable; [[The parent item, or $null if none.]]
@in type: Elm.Genlist.Item.Type; [[Item type.]] @in type: Elm.Genlist.Item.Type; [[Item type.]]

4
src/lib/elementary/elm_genlist_item.eo
View File

@ -172,7 +172,7 @@ class Elm.Genlist.Item(Elm.Widget.Item)
]] ]]
} }
values { values {
itc: ptr(const(Elm.Genlist.Item.Class)); [[Genlist Item class for the given item.]] @cref itc: Elm.Genlist.Item.Class; [[Genlist Item class for the given item.]]
} }
} }
@property index { @property index {
@ -399,7 +399,7 @@ class Elm.Genlist.Item(Elm.Widget.Item)
@.update is called on the item $it. @.update is called on the item $it.
]] ]]
params { params {
@in itc: ptr(const(Elm.Genlist.Item.Class)); [[The item class for the item.]] @cref itc: Elm.Genlist.Item.Class; [[The item class for the item.]]
} }
} }
decorate_mode_set { decorate_mode_set {

2
src/lib/elementary/elm_interface_atspi_widget_action.eo
View File

@ -11,7 +11,7 @@ mixin Elm.Interface.Atspi_Widget_Action (Efl.Access.Action)
get @pure_virtual { get @pure_virtual {
} }
values { values {
actions: ptr(const(Elm_Atspi_Action)); [[NULL-terminated array of Elm_Atspi_Action]] @cref actions: Elm_Atspi_Action; [[NULL-terminated array of Elm_Atspi_Action]]
} }
} }
} }

2
src/lib/elementary/elm_map.eo
View File

@ -566,7 +566,7 @@ class Elm.Map (Elm.Widget, Elm.Interface_Scrollable,
]] ]]
return: ptr(Elm_Map_Overlay); [[The created overlay or $null upon failure.]] return: ptr(Elm_Map_Overlay); [[The created overlay or $null upon failure.]]
params { params {
@in route: ptr(const(Elm_Map_Route)); [[The route object to make a overlay.]] @cref route: Elm_Map_Route; [[The route object to make a overlay.]]
} }
} }
overlay_scale_add { overlay_scale_add {

4
src/lib/elementary/elm_slideshow.eo
View File

@ -276,7 +276,7 @@ class Elm.Slideshow (Efl.Ui.Layout, Elm.Interface.Atspi_Widget_Action)
]] ]]
return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]] return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]]
params { params {
@in itc: ptr(const(Elm_Slideshow_Item_Class)); [[The item class for the item.]] @cref itc: Elm_Slideshow_Item_Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item's data.]] @in data: const(void_ptr); [[The item's data.]]
} }
} }
@ -294,7 +294,7 @@ class Elm.Slideshow (Efl.Ui.Layout, Elm.Interface.Atspi_Widget_Action)
return: Elm.Widget.Item; [[Returns The slideshow item handle, return: Elm.Widget.Item; [[Returns The slideshow item handle,
on success, or $null on errors.]] on success, or $null on errors.]]
params { params {
@in itc: ptr(const(Elm_Slideshow_Item_Class)); [[The item class for the item.]] @cref itc: Elm_Slideshow_Item_Class; [[The item class for the item.]]
@in data: const(void_ptr); [[The item's data.]] @in data: const(void_ptr); [[The item's data.]]
@in func: Eina_Compare_Cb; [[The comparing function to be used to sort the slideshow @in func: Eina_Compare_Cb; [[The comparing function to be used to sort the slideshow
items by #Elm_Slideshow_Item_Class item handles.]] items by #Elm_Slideshow_Item_Class item handles.]]

2
src/lib/elementary/elm_widget.eo
View File

@ -108,7 +108,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Efl.Access,
makes sure other widgets will not also process this input event. makes sure other widgets will not also process this input event.
]] ]]
params { params {
@in eo_event: const(ptr(Efl.Event)); @cref eo_event: Efl.Event;
[[EO event struct with an Efl.Input.Event as info.]] [[EO event struct with an Efl.Input.Event as info.]]
@in source: Efl.Canvas.Object; @in source: Efl.Canvas.Object;
[[Source object where the event originated. Often same as this.]] [[Source object where the event originated. Often same as this.]]