stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=7e98403912dfaf9419916e5b478edc945b51fa81
commit 7e98403912dfaf9419916e5b478edc945b51fa81
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Tue Nov 1 14:18:26 2016 +0100
docs: add missing docs for the rest of efl interfaces
---
src/lib/efl/interfaces/efl_config.eo | 13 +++++++------
src/lib/efl/interfaces/efl_container.eo | 14 +++++++-------
src/lib/efl/interfaces/efl_control.eo | 1 +
src/lib/efl/interfaces/efl_file.eo | 7 ++++---
src/lib/efl/interfaces/efl_flipable.eo | 14 ++++++--------
src/lib/efl/interfaces/efl_input_device.eo | 12 ++++++------
src/lib/efl/interfaces/efl_model.eo | 5 +++--
src/lib/efl/interfaces/efl_orientation.eo | 13 +++++++------
src/lib/efl/interfaces/efl_pack.eo | 14 +++++++-------
src/lib/efl/interfaces/efl_player.eo | 12 +++++++-----
src/lib/efl/interfaces/efl_screen.eo | 4 +++-
src/lib/efl/interfaces/efl_vpath_core.eo | 2 +-
12 files changed, 59 insertions(+), 52 deletions(-)
diff --git a/src/lib/efl/interfaces/efl_config.eo
b/src/lib/efl/interfaces/efl_config.eo
index 1d9722b..0a5b119 100644
--- a/src/lib/efl/interfaces/efl_config.eo
+++ b/src/lib/efl/interfaces/efl_config.eo
@@ -5,24 +5,25 @@ interface Efl.Config ()
/* FIXME: make this a property -- @own is a problem */
config_set {
params {
- name: string;
- val: const(generic_value)*;
+ name: string; [[Configuration option name]]
+ val: const(generic_value)*; [[Configuration option value]]
}
return: bool; [[$false in case of error: value type was invalid, the
config can't be changed, config does not exist...]]
}
config_get @const {
params {
- name: string;
+ name: string; [[Configuration option name]]
}
- return: free(own(generic_value *), eina_value_free);
+ return: free(own(generic_value *), eina_value_free); [[Configuration
option value]]
}
config_list_get @const {
[[Returns a list of generic values under a given key.]]
params {
- @in name: string;
+ @in name: string; [[Configuration option name]]
}
- return: free(own(iterator<generic_value*>), eina_iterator_free);
+ return: free(own(iterator<generic_value*>), eina_iterator_free); [[
+ List of configuration option values]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_container.eo
b/src/lib/efl/interfaces/efl_container.eo
index 73489e8..1bf98e1 100644
--- a/src/lib/efl/interfaces/efl_container.eo
+++ b/src/lib/efl/interfaces/efl_container.eo
@@ -8,30 +8,30 @@ interface Efl.Container (Efl.Gfx)
[[The name of the part under which an object is swallowed.]]
get {}
keys {
- content: Efl.Gfx;
+ content: Efl.Gfx; [[Swallowed object]]
}
values {
- name: string;
+ name: string; [[Part name]]
}
}
@property content {
[[Swallowed sub-object contained in this object.]]
set {
- return: bool;
+ return: bool; [[$true on success, $false otherwise]]
}
get {}
values {
- content: Efl.Gfx; [[the object to swallow.]]
+ content: Efl.Gfx; [[The object to swallow.]]
}
}
content_unset {
[[Unswallow the object in the current container and return it.]]
- return: Efl.Gfx;
+ return: Efl.Gfx; [[Unswallowed object]]
}
content_remove {
[[Unswallow an object from this container.]]
params {
- @in content: Efl.Gfx;
+ @in content: Efl.Gfx; [[To be removed content]]
}
return: bool; [[$false if $content was not a child or can not be
removed.]]
}
@@ -41,7 +41,7 @@ interface Efl.Container (Efl.Gfx)
}
content_count {
[[Returns the number of UI elements packed in this container.]]
- return: int;
+ return: int; [[Number of packed UI elements]]
}
}
events {
diff --git a/src/lib/efl/interfaces/efl_control.eo
b/src/lib/efl/interfaces/efl_control.eo
index 148f21d..39d327e 100644
--- a/src/lib/efl/interfaces/efl_control.eo
+++ b/src/lib/efl/interfaces/efl_control.eo
@@ -1,6 +1,7 @@
/* FIXME: Rename */
interface Efl.Control {
+ [[Efl control interface]]
methods {
@property priority {
[[Control the priority of the object.]]
diff --git a/src/lib/efl/interfaces/efl_file.eo
b/src/lib/efl/interfaces/efl_file.eo
index 41cf5df..7696070 100644
--- a/src/lib/efl/interfaces/efl_file.eo
+++ b/src/lib/efl/interfaces/efl_file.eo
@@ -1,6 +1,7 @@
import eina_types;
interface Efl.File {
+ [[Efl file interface]]
methods {
@property mmap {
set {
@@ -13,7 +14,7 @@ interface Efl.File {
@since 1.8]]
- return: bool; [[$true = success, $false = error]]
+ return: bool; [[$true on success, $false otherwise]]
}
get {
[[Get the source mmaped file from where an image object must fetch
the real
@@ -62,7 +63,7 @@ interface Efl.File {
* @endcode
*/
- return: bool;
+ return: bool; [[$true on success, $false otherwise]]
}
get {
[[Retrieve the source file from where an image object is to fetch
the
@@ -91,7 +92,7 @@ interface Efl.File {
acceptable flags are $quality and $compress. Eg.:
"quality=100 compress=9"]]
- return: bool;
+ return: bool; [[$true on success, $false otherwise]]
params {
@in file: string @nonull; [[The filename to be used to save the
image (extension
obligatory).]]
diff --git a/src/lib/efl/interfaces/efl_flipable.eo
b/src/lib/efl/interfaces/efl_flipable.eo
index 5910851..c915127 100644
--- a/src/lib/efl/interfaces/efl_flipable.eo
+++ b/src/lib/efl/interfaces/efl_flipable.eo
@@ -1,16 +1,14 @@
enum Efl.Flip
{
- [[Flip
-
- See also @Efl.Flipable
- ]]
- none = 0, [[no flip]]
- horizontal = 1, [[flip image horizontally]]
- vertical = 2 [[flip image vertically]]
+ [[Flip, See also @Efl.Flipable]]
+ none = 0, [[No flip]]
+ horizontal = 1, [[Flip image horizontally]]
+ vertical = 2 [[Flip image vertically]]
}
interface Efl.Flipable
{
+ [[Efl flipable interface]]
eo_prefix: efl_flip;
methods {
@property flip {
@@ -24,7 +22,7 @@ interface Efl.Flipable
get {
}
values {
- flip: Efl.Flip; [[Flip]]
+ flip: Efl.Flip; [[Flip method]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_input_device.eo
b/src/lib/efl/interfaces/efl_input_device.eo
index 35052ca..8e8dd04 100644
--- a/src/lib/efl/interfaces/efl_input_device.eo
+++ b/src/lib/efl/interfaces/efl_input_device.eo
@@ -51,34 +51,34 @@ class Efl.Input.Device (Efl.Object)
/* FIXME: device_class makes compilation error because of class_get() */
@property device_type {
values {
- klass: Efl.Input.Device.Class;
+ klass: Efl.Input.Device.Class; [[Input device class]]
}
}
@property device_subtype {
values {
- klass: Efl.Input.Device.Sub_Class;
+ klass: Efl.Input.Device.Sub_Class; [[Input device sub-class]]
}
}
@property source {
values {
- src: Efl.Input.Device;
+ src: Efl.Input.Device; [[Input device]]
}
}
@property name {
values {
- name: string;
+ name: string; [[Input device name]]
}
}
@property description {
values {
- desc: string;
+ desc: string; [[Input device description]]
}
}
@property parent {
set {}
get {}
values {
- parent: Efl.Input.Device;
+ parent: Efl.Input.Device; [[Parent input device]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_model.eo
b/src/lib/efl/interfaces/efl_model.eo
index 546e690..1a654a5 100644
--- a/src/lib/efl/interfaces/efl_model.eo
+++ b/src/lib/efl/interfaces/efl_model.eo
@@ -6,6 +6,7 @@ struct Efl.Model.Property_Event {
interface Efl.Model ()
{
+ [[Efl model interface]]
eo_prefix: efl_model;
methods {
@property properties {
@@ -23,7 +24,7 @@ interface Efl.Model ()
]]
}
values {
- properties: const(array<string>); [[array of current
properties]]
+ properties: const(array<string>); [[Array of current
properties]]
}
}
property_set {
@@ -125,7 +126,7 @@ interface Efl.Model ()
@since 1.14
]]
- return: Efl.Object;
+ return: Efl.Object; [[Child object]]
}
child_del {
[[Remove a child.
diff --git a/src/lib/efl/interfaces/efl_orientation.eo
b/src/lib/efl/interfaces/efl_orientation.eo
index 3a756e2..cf709ce 100644
--- a/src/lib/efl/interfaces/efl_orientation.eo
+++ b/src/lib/efl/interfaces/efl_orientation.eo
@@ -4,18 +4,19 @@ enum Efl.Orient
See also @Efl.Orientation
]]
- none = 0, [[default, same as up]]
+ none = 0, [[Default, same as up]]
up = 0, [[orient up]]
- right = 90, [[orient right]]
- down = 180, [[orient down]]
- left = 270, [[orient left]]
- vertical = 0, [[orient vertical]]
- horizontal = 90 [[orient horizontal]]
+ right = 90, [[Orient right]]
+ down = 180, [[Orient down]]
+ left = 270, [[Orient left]]
+ vertical = 0, [[Orient vertical]]
+ horizontal = 90 [[Orient horizontal]]
}
interface Efl.Orientation
{
+ [[Efl orientation interface]]
methods {
@property orientation{
[[Control the orientation of a given widget
diff --git a/src/lib/efl/interfaces/efl_pack.eo
b/src/lib/efl/interfaces/efl_pack.eo
index 26d8ca1..d1079a4 100644
--- a/src/lib/efl/interfaces/efl_pack.eo
+++ b/src/lib/efl/interfaces/efl_pack.eo
@@ -7,14 +7,14 @@ interface Efl.Pack (Efl.Container)
{
pack_clear {
[[Removes all packed contents, and unreferences them.]]
- return: bool;
+ return: bool; [[$true on success, $false otherwise]]
}
unpack_all {
[[Removes all packed contents, without unreferencing them.
Use with caution.
]]
- return: bool;
+ return: bool; [[$true on success, $false otherwise]]
}
unpack {
[[Removes an existing item from the container, without deleting it.]]
@@ -43,8 +43,8 @@ interface Efl.Pack (Efl.Container)
set {}
get {}
values {
- align_horiz: double;
- align_vert: double;
+ align_horiz: double; [[Horizontal alignment]]
+ align_vert: double; [[Vertical alignment]]
}
}
@property pack_padding {
@@ -52,9 +52,9 @@ interface Efl.Pack (Efl.Container)
set {}
get {}
values {
- pad_horiz: double;
- pad_vert: double;
- scalable: bool;
+ pad_horiz: double; [[Horizontal padding]]
+ pad_vert: double; [[Vertical padding]]
+ scalable: bool; [[$true if scalable, $false otherwise]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_player.eo
b/src/lib/efl/interfaces/efl_player.eo
index b95780a..86c2c52 100644
--- a/src/lib/efl/interfaces/efl_player.eo
+++ b/src/lib/efl/interfaces/efl_player.eo
@@ -1,11 +1,13 @@
-interface Efl.Player {
+interface Efl.Player
+{
+ [[Efl media player interface]]
methods {
@property playable {
[[Whether or not the object data can be played.]]
get {
}
values {
- play: bool; [[true if the object have playable data, false
otherwise]]
+ play: bool; [[$true if the object have playable data, $false
otherwise]]
}
}
@property play {
@@ -21,7 +23,7 @@ interface Efl.Player {
[[Get play/pause state of the media file.]]
}
values {
- play: bool; [[true if playing, false otherwise.]]
+ play: bool; [[$true if playing, $false otherwise.]]
}
}
@property position {
@@ -95,7 +97,7 @@ interface Efl.Player {
get {
}
values {
- mute: bool; [[The mute state. True or false.]]
+ mute: bool; [[The mute state. $true or $false.]]
}
}
@property length {
@@ -111,7 +113,7 @@ interface Efl.Player {
get {
}
values {
- seekable: bool; [[True if seekable.]]
+ seekable: bool; [[$true if seekable.]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_screen.eo
b/src/lib/efl/interfaces/efl_screen.eo
index 1050acf..75e3552 100644
--- a/src/lib/efl/interfaces/efl_screen.eo
+++ b/src/lib/efl/interfaces/efl_screen.eo
@@ -1,6 +1,8 @@
import eina_types;
-interface Efl.Screen {
+interface Efl.Screen
+{
+ [[Efl screen interface]]
methods {
@property screen_size {
get {
diff --git a/src/lib/efl/interfaces/efl_vpath_core.eo
b/src/lib/efl/interfaces/efl_vpath_core.eo
index 98a667b..0e238a0 100644
--- a/src/lib/efl/interfaces/efl_vpath_core.eo
+++ b/src/lib/efl/interfaces/efl_vpath_core.eo
@@ -22,7 +22,7 @@ class Efl.Vpath.Core (Efl.Object, Efl.Vpath)
params {
key: string; [[ The magic path key being looked up ]]
}
- return: string;
+ return: string; [[Real file path]]
}
}
implements {
--
