stefan pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=85ed25c682628a5648db28e603b4f610ba0e866f
commit 85ed25c682628a5648db28e603b4f610ba0e866f Author: Stefan Schmidt <[email protected]> Date: Thu Nov 17 12:16:01 2016 +0100 docs: efl_interfaces: fill gaps in efl interfaces eo file documentation --- src/lib/efl/interfaces/efl_canvas.eo | 4 ++-- src/lib/efl/interfaces/efl_config.eo | 2 ++ src/lib/efl/interfaces/efl_container.eo | 2 +- src/lib/efl/interfaces/efl_input_device.eo | 6 ++++++ src/lib/efl/interfaces/efl_io_buffer.eo | 6 +++--- src/lib/efl/interfaces/efl_io_positioner.eo | 6 ++++-- src/lib/efl/interfaces/efl_io_queue.eo | 8 ++++---- src/lib/efl/interfaces/efl_io_sizer.eo | 2 ++ src/lib/efl/interfaces/efl_model.eo | 2 +- src/lib/efl/interfaces/efl_observer.eo | 1 + src/lib/efl/interfaces/efl_orientation.eo | 2 +- src/lib/efl/interfaces/efl_pack.eo | 4 ++-- src/lib/efl/interfaces/efl_pack_grid.eo | 7 ++++--- src/lib/efl/interfaces/efl_pack_linear.eo | 10 +++++----- 14 files changed, 38 insertions(+), 24 deletions(-) diff --git a/src/lib/efl/interfaces/efl_canvas.eo b/src/lib/efl/interfaces/efl_canvas.eo index 030fa6f..bd05337 100644 --- a/src/lib/efl/interfaces/efl_canvas.eo +++ b/src/lib/efl/interfaces/efl_canvas.eo @@ -1,6 +1,6 @@ interface Efl.Canvas () { - [[Common interface for Window and some internal classes in EFL.]] + [[Common interface for window and some internal classes in EFL.]] methods { @property image_max_size { get { @@ -97,7 +97,7 @@ interface Efl.Canvas () objects, acting only on the ones at the "top level", with regard to object parenting. ]] - return: free(own(iterator<Efl.Gfx>), eina_iterator_free) @warn_unused; [[List of objects]] + return: free(own(iterator<Efl.Gfx>), eina_iterator_free) @warn_unused; [[Iterator to objects]] params { @in x: int; [[ The top left corner's horizontal coordinate for the diff --git a/src/lib/efl/interfaces/efl_config.eo b/src/lib/efl/interfaces/efl_config.eo index 2052c57..33c4d1a 100644 --- a/src/lib/efl/interfaces/efl_config.eo +++ b/src/lib/efl/interfaces/efl_config.eo @@ -4,6 +4,7 @@ interface Efl.Config () methods { /* FIXME: make this a property -- @own is a problem */ config_set { + [[Set configuration]] params { name: string; [[Configuration option name]] val: ptr(const(generic_value)); [[Configuration option value]] @@ -12,6 +13,7 @@ interface Efl.Config () config can't be changed, config does not exist...]] } config_get @const { + [[Get configuration]] params { name: string; [[Configuration option name]] } diff --git a/src/lib/efl/interfaces/efl_container.eo b/src/lib/efl/interfaces/efl_container.eo index 1bf98e1..b39d1d4 100644 --- a/src/lib/efl/interfaces/efl_container.eo +++ b/src/lib/efl/interfaces/efl_container.eo @@ -37,7 +37,7 @@ interface Efl.Container (Efl.Gfx) } content_iterate { [[Begin iterating over this object's contents.]] - return: free(own(iterator<Efl.Gfx>), eina_iterator_free) @warn_unused; + return: free(own(iterator<Efl.Gfx>), eina_iterator_free) @warn_unused; [[Iterator to object content]] } content_count { [[Returns the number of UI elements packed in this container.]] diff --git a/src/lib/efl/interfaces/efl_input_device.eo b/src/lib/efl/interfaces/efl_input_device.eo index 45056c4..5d17c21 100644 --- a/src/lib/efl/interfaces/efl_input_device.eo +++ b/src/lib/efl/interfaces/efl_input_device.eo @@ -50,31 +50,37 @@ class Efl.Input.Device (Efl.Object) methods { /* FIXME: device_class makes compilation error because of class_get() */ @property device_type { + [[Device type property]] values { klass: Efl.Input.Device.Class; [[Input device class]] } } @property device_subtype { + [[Device subtype property]] values { klass: Efl.Input.Device.Sub_Class; [[Input device sub-class]] } } @property source { + [[Device source property]] values { src: Efl.Input.Device; [[Input device]] } } @property name { + [[device name property]] values { name: string; [[Input device name]] } } @property description { + [[device description property]] values { desc: string; [[Input device description]] } } @property parent { + [[Device parent property]] set {} get {} values { diff --git a/src/lib/efl/interfaces/efl_io_buffer.eo b/src/lib/efl/interfaces/efl_io_buffer.eo index 1b3f11f..5912858 100644 --- a/src/lib/efl/interfaces/efl_io_buffer.eo +++ b/src/lib/efl/interfaces/efl_io_buffer.eo @@ -86,9 +86,9 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Ef called in those situations. ]] params { - @out slice: Eina.Slice; [[slice of the current buffer, may be invalidated if @Efl.Io.Writer.write, @Efl.Io.Closer.close or @Efl.Io.Sizer.resize are called. It is the full slice, not a partial one starting at current position.]] + @out slice: Eina.Slice; [[Slice of the current buffer, may be invalidated if @Efl.Io.Writer.write, @Efl.Io.Closer.close or @Efl.Io.Sizer.resize are called. It is the full slice, not a partial one starting at current position.]] } - return: bool (false); + return: bool (false); [[$true on success, $false otherwise]] } binbuf_steal { @@ -96,7 +96,7 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Ef The returned memory must be freed with eina_binbuf_free(). ]] - return: free(own(ptr(Eina.Binbuf)), eina_binbuf_free) @warn_unused; + return: free(own(ptr(Eina.Binbuf)), eina_binbuf_free) @warn_unused; [[Binbuf]] } } diff --git a/src/lib/efl/interfaces/efl_io_positioner.eo b/src/lib/efl/interfaces/efl_io_positioner.eo index 9e17f22..b0e7d7e 100644 --- a/src/lib/efl/interfaces/efl_io_positioner.eo +++ b/src/lib/efl/interfaces/efl_io_positioner.eo @@ -17,14 +17,16 @@ mixin Efl.Io.Positioner { methods { seek @virtual_pure { + [[Seek in data]] params { - @in offset: int64; [[offset in byte relative to whence]] - @in whence: Efl.Io.Positioner.Whence; + @in offset: int64; [[Offset in byte relative to whence]] + @in whence: Efl.Io.Positioner.Whence; [[Whence]] } return: Eina.Error; [[0 on succeed, a mapping of errno otherwise]] } @property position { + [[Position property]] get @virtual_pure { } set { [[Try to set position object, relative to start of file. See @.seek()]] diff --git a/src/lib/efl/interfaces/efl_io_queue.eo b/src/lib/efl/interfaces/efl_io_queue.eo index 59dfa62..748d580 100644 --- a/src/lib/efl/interfaces/efl_io_queue.eo +++ b/src/lib/efl/interfaces/efl_io_queue.eo @@ -15,7 +15,7 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) { preallocate { [[Immediately pre-allocate a buffer of at least a given size.]] params { - @in size: size; [[amount of bytes to pre-allocate.]] + @in size: size; [[Amount of bytes to pre-allocate.]] } } @@ -41,7 +41,7 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) { [[How many bytes are available for read]] get { } values { - usage: size; + usage: size; [[Bytes available to read]] } } @@ -53,9 +53,9 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) { called in those situations. ]] params { - @out slice: Eina.Slice; [[slice of the current buffer, may be invalidated if @Efl.Io.Writer.write, @Efl.Io.Closer.close or @Efl.Io.Reader.read are called. It is the full slice available for reading.]] + @out slice: Eina.Slice; [[Slice of the current buffer, may be invalidated if @Efl.Io.Writer.write, @Efl.Io.Closer.close or @Efl.Io.Reader.read are called. It is the full slice available for reading.]] } - return: bool (false); + return: bool (false); [[$true on success, $false otherwise]] } clear { diff --git a/src/lib/efl/interfaces/efl_io_sizer.eo b/src/lib/efl/interfaces/efl_io_sizer.eo index 97c0fa5..1e378b8 100644 --- a/src/lib/efl/interfaces/efl_io_sizer.eo +++ b/src/lib/efl/interfaces/efl_io_sizer.eo @@ -13,6 +13,7 @@ mixin Efl.Io.Sizer { methods { resize @virtual_pure { + [[Resize object]] params { @in size: uint64; [[Object size]] } @@ -20,6 +21,7 @@ mixin Efl.Io.Sizer { } @property size { + [[Size property]] get @virtual_pure { } set { [[Try to resize the object, check with get if the value was accepted or not.]] diff --git a/src/lib/efl/interfaces/efl_model.eo b/src/lib/efl/interfaces/efl_model.eo index a4ecbde..4111945 100644 --- a/src/lib/efl/interfaces/efl_model.eo +++ b/src/lib/efl/interfaces/efl_model.eo @@ -114,7 +114,7 @@ interface Efl.Model () @since 1.14 ]] - return: future<uint>; + return: future<uint>; [[Future of the children count]] } child_add { [[Add a new child. diff --git a/src/lib/efl/interfaces/efl_observer.eo b/src/lib/efl/interfaces/efl_observer.eo index a0d4ffe..f89bd39 100644 --- a/src/lib/efl/interfaces/efl_observer.eo +++ b/src/lib/efl/interfaces/efl_observer.eo @@ -1,4 +1,5 @@ interface Efl.Observer { + [[Efl observer interface]] methods { update @virtual_pure { [[Update observer according to the changes of observable object. diff --git a/src/lib/efl/interfaces/efl_orientation.eo b/src/lib/efl/interfaces/efl_orientation.eo index cf709ce..ff7f207 100644 --- a/src/lib/efl/interfaces/efl_orientation.eo +++ b/src/lib/efl/interfaces/efl_orientation.eo @@ -5,7 +5,7 @@ enum Efl.Orient See also @Efl.Orientation ]] none = 0, [[Default, same as up]] - up = 0, [[orient up]] + up = 0, [[Orient up]] right = 90, [[Orient right]] down = 180, [[Orient down]] left = 270, [[Orient left]] diff --git a/src/lib/efl/interfaces/efl_pack.eo b/src/lib/efl/interfaces/efl_pack.eo index d1079a4..53f4055 100644 --- a/src/lib/efl/interfaces/efl_pack.eo +++ b/src/lib/efl/interfaces/efl_pack.eo @@ -19,7 +19,7 @@ interface Efl.Pack (Efl.Container) unpack { [[Removes an existing item from the container, without deleting it.]] params { - subobj: own(Efl.Gfx); + subobj: own(Efl.Gfx); [[Unpacked object]] } return: bool; [[$false if $subobj wasn't a child or can't be removed]] } @@ -34,7 +34,7 @@ interface Efl.Pack (Efl.Container) failed, the object will be unrefed. ]] params { - subobj: own(Efl.Gfx); + subobj: own(Efl.Gfx); [[Packed object]] } return: bool; [[$false if $subobj could not be packed.]] } diff --git a/src/lib/efl/interfaces/efl_pack_grid.eo b/src/lib/efl/interfaces/efl_pack_grid.eo index 2268f2e..5d8a353 100644 --- a/src/lib/efl/interfaces/efl_pack_grid.eo +++ b/src/lib/efl/interfaces/efl_pack_grid.eo @@ -6,8 +6,9 @@ interface Efl.Pack.Grid (Efl.Pack.Linear) eo_prefix: efl_pack; methods { pack_grid { + [[Pack object on the grid]] params { - subobj: own(Efl.Gfx); + subobj: own(Efl.Gfx); [[Object]] col: int; [[Column number]] row: int; [[Row number]] colspan: int @optional; [[0 means 1, -1 means @.grid_columns]] @@ -41,8 +42,8 @@ interface Efl.Pack.Grid (Efl.Pack.Linear) values { col: int; [[Column number]] row: int; [[Row number]] - colspan: int; - rowspan: int; + colspan: int; [[Column span]] + rowspan: int; [[Row span]] } } @property grid_size { diff --git a/src/lib/efl/interfaces/efl_pack_linear.eo b/src/lib/efl/interfaces/efl_pack_linear.eo index 948c1fa..58ce717 100644 --- a/src/lib/efl/interfaces/efl_pack_linear.eo +++ b/src/lib/efl/interfaces/efl_pack_linear.eo @@ -26,8 +26,8 @@ interface Efl.Pack.Linear (Efl.Pack) pack_before { [[Prepend item before other sub object.]] params { - @in subobj: own(Efl.Gfx); [[Item to pack.]] - @in existing: const(Efl.Gfx); [[Item to refer to.]] + @in subobj: own(Efl.Gfx); [[Item to pack.]] + @in existing: const(Efl.Gfx); [[Item to refer to.]] } return: bool; [[$false if $existing could not be found or $subobj could not be packed]] @@ -35,8 +35,8 @@ interface Efl.Pack.Linear (Efl.Pack) pack_after { [[Append item after other sub object.]] params { - @in subobj: own(Efl.Gfx); [[Item to pack.]] - @in existing: const(Efl.Gfx); [[Item to refer to.]] + @in subobj: own(Efl.Gfx); [[Item to pack.]] + @in existing: const(Efl.Gfx); [[Item to refer to.]] } return: bool; [[$false if $existing could not be found or $subobj could not be packed]] @@ -49,7 +49,7 @@ interface Efl.Pack.Linear (Efl.Pack) ]] params { @in subobj: own(Efl.Gfx); [[Item to pack.]] - @in index: int; [[A position.]] + @in index: int; [[A position.]] } return: bool; [[$false if $subobj could not be packed]] } --
