From cc6b7466858376d73e2c7371a1f5fecda8ff9d92 Mon Sep 17 00:00:00 2001 From: Stefan Schmidt Date: Tue, 1 Nov 2016 14:11:52 +0100 Subject: [PATCH] docs: efl_gfx: add missing docs for efl_gfx_* interfaces --- src/lib/efl/interfaces/efl_gfx_buffer.eo | 26 +++++++++++------------ src/lib/efl/interfaces/efl_gfx_fill.eo | 1 + src/lib/efl/interfaces/efl_gfx_filter.eo | 10 ++++----- src/lib/efl/interfaces/efl_gfx_gradient.eo | 7 +++--- src/lib/efl/interfaces/efl_gfx_gradient_linear.eo | 9 ++++---- src/lib/efl/interfaces/efl_gfx_gradient_radial.eo | 11 +++++----- src/lib/efl/interfaces/efl_gfx_size_hint.eo | 5 +++-- src/lib/efl/interfaces/efl_gfx_stack.eo | 12 ++++++----- src/lib/efl/interfaces/efl_gfx_view.eo | 4 +++- 9 files changed, 47 insertions(+), 38 deletions(-) diff --git a/src/lib/efl/interfaces/efl_gfx_buffer.eo b/src/lib/efl/interfaces/efl_gfx_buffer.eo index bde430a..1b8f6b1 100644 --- a/src/lib/efl/interfaces/efl_gfx_buffer.eo +++ b/src/lib/efl/interfaces/efl_gfx_buffer.eo @@ -46,7 +46,7 @@ interface Efl.Gfx.Buffer () ]] } values { - cspace: Efl.Gfx.Colorspace; + cspace: Efl.Gfx.Colorspace; [[Colorspace]] } } @property alpha { @@ -85,7 +85,7 @@ interface Efl.Gfx.Buffer () ]] get {} values { - stride: int; + stride: int; [[Stride]] } } @@ -135,18 +135,18 @@ interface Efl.Gfx.Buffer () params { @out slice: Eina.Rw_Slice; [[Pointer to the top-left pixel data.]] @in mode: Efl.Gfx.Buffer.Access_Mode; [[Specifies whether to map for read-only, - write-only or read-write access (OR combinaison of flags).]] + write-only or read-write access (OR combination of flags).]] @in x: int @optional; [[X position of the top-left pixel to map, defaults to 0.]] @in y: int @optional; [[Y position of the top-left pixel to map, defaults to 0.]] @in w: int @optional; [[If 0, defaults to the buffer width.]] @in h: int @optional; [[If 0, defaults to the buffer height.]] - @in cspace: Efl.Gfx.Colorspace @optional; [[Requested colorspace. If differen 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. argb8888 by default.]] @in plane: int @optional; [[Plane ID. 0 by default. Useful for planar formats only.]] @out stride: int @optional; [[Returns the length in bytes of a mapped line]] } - return: bool; + return: bool; [[$true on success, $false otherwise]] } buffer_unmap { [[Unmap a region of this buffer, and update the internal data if needed. @@ -161,7 +161,7 @@ interface Efl.Gfx.Buffer () params { @in slice: const(Eina.Rw_Slice)*; [[Data slice returned by a previous call to map.]] } - return: bool; + return: bool; [[$true on success, $false otherwise]] } buffer_copy_set { [[Set the pixels for this buffer by copying them, or allocate @@ -182,13 +182,13 @@ interface Efl.Gfx.Buffer () ]] params { @in slice: const(Eina.Slice)* @nullable; [[If $null, allocates an empty buffer]] - @in width: int; - @in height: int; + @in width: int; [[Width]] + @in height: int; [[Height]] @in stride: int @optional; [[If 0, automatically guessed from the $width.]] @in cspace: Efl.Gfx.Colorspace @optional; [[argb8888 by default.]] @in plane: int @optional; [[Plane ID. 0 by default. Useful for planar formats only.]] } - return: bool; + return: bool; [[$true on success, $false otherwise]] } buffer_managed_set { [[Set the pixels for this buffer, managed externally by the client. @@ -208,13 +208,13 @@ interface Efl.Gfx.Buffer () ]] params { @in slice: const(Eina.Slice)* @nullable; [[If $null, detaches the previous buffer.]] - @in width: int; - @in height: int; + @in width: int; [[Width]] + @in height: int; [[Height]] @in stride: int @optional; [[If 0, automatically guessed from the $width.]] @in cspace: Efl.Gfx.Colorspace @optional; [[argb8888 by default.]] @in plane: int @optional; [[Plane ID. 0 by default. Useful for planar formats only.]] } - return: bool; + return: bool; [[$true on success, $false otherwise]] } buffer_managed_get { [[Get a direct pointer to the internal pixel data, if available. @@ -227,7 +227,7 @@ interface Efl.Gfx.Buffer () @out slice: Eina.Slice; @in plane: int @optional; [[Plane ID. 0 by default. Useful for planar formats only.]] } - return: bool; + return: bool; [[$true on success, $false otherwise]] } /* Note: border, span and buffer flags not imported from ector buffer */ } diff --git a/src/lib/efl/interfaces/efl_gfx_fill.eo b/src/lib/efl/interfaces/efl_gfx_fill.eo index 8260a7b..f0280c0 100644 --- a/src/lib/efl/interfaces/efl_gfx_fill.eo +++ b/src/lib/efl/interfaces/efl_gfx_fill.eo @@ -1,4 +1,5 @@ interface Efl.Gfx.Fill { + [[Efl graphics fill interface]] methods { @property fill_auto { [[Binds the object's @.fill property to its actual geometry. diff --git a/src/lib/efl/interfaces/efl_gfx_filter.eo b/src/lib/efl/interfaces/efl_gfx_filter.eo index 29a9644..efb57f8 100644 --- a/src/lib/efl/interfaces/efl_gfx_filter.eo +++ b/src/lib/efl/interfaces/efl_gfx_filter.eo @@ -60,17 +60,17 @@ interface Efl.Gfx.Filter [[Required padding to apply this filter without cropping. Read-only property that can be used to calculate the object's final - geometry. This can be overriden (set) from inside the filter program + geometry. This can be overridden (set) from inside the filter program by using the function 'padding_set' in the Lua program. ]] get { [[Gets the padding required to apply this filter.]] } values { - l: int; - r: int; - t: int; - b: int; + l: int; [[Padding on the left]] + r: int; [[Padding on the ight]] + t: int; [[Padding on the top]] + b: int; [[Padding on the bottom]] } } @property filter_source { diff --git a/src/lib/efl/interfaces/efl_gfx_gradient.eo b/src/lib/efl/interfaces/efl_gfx_gradient.eo index 724b09d..80a33b2 100644 --- a/src/lib/efl/interfaces/efl_gfx_gradient.eo +++ b/src/lib/efl/interfaces/efl_gfx_gradient.eo @@ -2,6 +2,7 @@ import efl_gfx_types; interface Efl.Gfx.Gradient { + [[Efl graphics gradient interface]] eo_prefix: efl_gfx_gradient; methods { @property stop { @@ -12,8 +13,8 @@ interface Efl.Gfx.Gradient [[Get the list of color stops.]] } values { - colors: const(Efl.Gfx.Gradient.Stop) *; [[color stops list]] - length: uint; [[length of the list]] + colors: const(Efl.Gfx.Gradient.Stop) *; [[Color stops list]] + length: uint; [[Length of the list]] } } @property spread { @@ -26,7 +27,7 @@ interface Efl.Gfx.Gradient ]] } values { - s: Efl.Gfx.Gradient.Spread; [[spread type to be used]] + s: Efl.Gfx.Gradient.Spread; [[Spread type to be used]] } } } diff --git a/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo b/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo index 8dd4f75..b416929 100644 --- a/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo +++ b/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo @@ -1,5 +1,6 @@ interface Efl.Gfx.Gradient.Linear (Efl.Gfx.Gradient) { + [[Efl graphics gradient linear interface]] methods { @property start { set { @@ -9,8 +10,8 @@ interface Efl.Gfx.Gradient.Linear (Efl.Gfx.Gradient) [[Gets the start point of this linear gradient.]] } values { - x: double; [[x co-ordinate of start point]] - y: double; [[y co-ordinate of start point]] + x: double; [[X co-ordinate of start point]] + y: double; [[Y co-ordinate of start point]] } } @property end { @@ -21,8 +22,8 @@ interface Efl.Gfx.Gradient.Linear (Efl.Gfx.Gradient) [[Gets the end point of this linear gradient.]] } values { - x: double; [[x co-ordinate of end point]] - y: double; [[y co-ordinate of end point]] + x: double; [[X co-ordinate of end point]] + y: double; [[Y co-ordinate of end point]] } } } diff --git a/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo b/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo index bcae3af..40a0bf2 100644 --- a/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo +++ b/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo @@ -1,5 +1,6 @@ interface Efl.Gfx.Gradient.Radial (Efl.Gfx.Gradient) { + [[Efl graphics gradient radial interface]] methods { @property center { set { @@ -9,8 +10,8 @@ interface Efl.Gfx.Gradient.Radial (Efl.Gfx.Gradient) [[Gets the center of this radial gradient.]] } values { - x: double; [[x co-ordinate of center point]] - y: double; [[y co-ordinate of center point]] + x: double; [[X co-ordinate of center point]] + y: double; [[Y co-ordinate of center point]] } } @property radius { @@ -21,7 +22,7 @@ interface Efl.Gfx.Gradient.Radial (Efl.Gfx.Gradient) [[Gets the center radius of this radial gradient.]] } values { - r: double; [[center radius]] + r: double; [[Center radius]] } } @property focal { @@ -32,8 +33,8 @@ interface Efl.Gfx.Gradient.Radial (Efl.Gfx.Gradient) [[Gets the focal point of this radial gradient.]] } values { - x: double; [[x co-ordinate of focal point]] - y: double; [[y co-ordinate of focal point]] + x: double; [[X co-ordinate of focal point]] + y: double; [[Y co-ordinate of focal point]] } } } diff --git a/src/lib/efl/interfaces/efl_gfx_size_hint.eo b/src/lib/efl/interfaces/efl_gfx_size_hint.eo index 2363479..fcd3f94 100644 --- a/src/lib/efl/interfaces/efl_gfx_size_hint.eo +++ b/src/lib/efl/interfaces/efl_gfx_size_hint.eo @@ -2,6 +2,7 @@ import efl_gfx_types; interface Efl.Gfx.Size.Hint { + [[Efl graphics size hint interface]] event_prefix: efl_gfx; methods { @property hint_base { @@ -55,8 +56,8 @@ interface Efl.Gfx.Size.Hint */ values { mode: Efl.Gfx.Size.Hint.Aspect; [[Mode of interpretation.]] - w: int; - h: int; + w: int; [[Width]] + h: int; [[Height]] /* FIXME: do we want min/max like Edje instead?? min: double; [[Default: 0.0 (no preference).]] diff --git a/src/lib/efl/interfaces/efl_gfx_stack.eo b/src/lib/efl/interfaces/efl_gfx_stack.eo index 13188ee..72cba17 100644 --- a/src/lib/efl/interfaces/efl_gfx_stack.eo +++ b/src/lib/efl/interfaces/efl_gfx_stack.eo @@ -1,4 +1,6 @@ -interface Efl.Gfx.Stack { +interface Efl.Gfx.Stack +{ + [[Efl graphics stack interface]] event_prefix: efl_gfx; methods { @property layer { @@ -38,7 +40,7 @@ interface Efl.Gfx.Stack { objects on layers below the one $obj is placed at. See also @.layer.get(), @.layer.set() and @.below.get()]] - return: Efl.Gfx.Stack @warn_unused; [[the #Efl_Gfx_Stack directly below $obj, if any, + return: Efl.Gfx.Stack @warn_unused; [[The #Efl_Gfx_Stack directly below $obj, if any, or $null, if none]] } } @@ -50,7 +52,7 @@ interface Efl.Gfx.Stack { objects on layers above the one $obj is placed at. See also @.layer.get(), @.layer.set() and @.below.get()]] - return: Efl.Gfx.Stack @warn_unused; [[the #Efl_Gfx_Stack directly below $obj, if any, + return: Efl.Gfx.Stack @warn_unused; [[The #Efl_Gfx_Stack directly below $obj, if any, or $null, if none]] } } @@ -76,7 +78,7 @@ interface Efl.Gfx.Stack { See also @.layer.get(), @.layer.set() and @.stack_below()]] params { - @in below: Efl.Gfx.Stack @nonull; [[the object below which to stack]] + @in below: Efl.Gfx.Stack @nonull; [[The object below which to stack]] } } raise { @@ -110,7 +112,7 @@ interface Efl.Gfx.Stack { See also @.layer.get(), @.layer.set() and @.stack_below()]] params { - @in above: Efl.Gfx.Stack @nonull; [[the object above which to stack]] + @in above: Efl.Gfx.Stack @nonull; [[The object above which to stack]] } } lower { diff --git a/src/lib/efl/interfaces/efl_gfx_view.eo b/src/lib/efl/interfaces/efl_gfx_view.eo index c172fae..677cfa8 100644 --- a/src/lib/efl/interfaces/efl_gfx_view.eo +++ b/src/lib/efl/interfaces/efl_gfx_view.eo @@ -1,4 +1,6 @@ -interface Efl.Gfx.View { +interface Efl.Gfx.View +{ + [[Efl graphics view interface]] eo_prefix: efl_gfx; methods { @property view_size { -- 2.7.4