stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=89de3ddd770ca1ab68868fee9746cec014220091
commit 89de3ddd770ca1ab68868fee9746cec014220091
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Thu Oct 27 16:45:19 2016 +0200
docs: elm: document missing structs
---
src/lib/elementary/efl_ui_box_flow.eo | 8 ++++----
src/lib/elementary/efl_ui_image.eo | 8 ++++----
src/lib/elementary/efl_ui_text.eo | 13 ++++++++-----
src/lib/elementary/elm_code_widget.eo | 4 ++--
src/lib/elementary/elm_general.eot | 1 +
src/lib/elementary/elm_toolbar_item.eo | 10 +++++-----
6 files changed, 24 insertions(+), 20 deletions(-)
diff --git a/src/lib/elementary/efl_ui_box_flow.eo
b/src/lib/elementary/efl_ui_box_flow.eo
index 6deefe4..7ea9f43 100644
--- a/src/lib/elementary/efl_ui_box_flow.eo
+++ b/src/lib/elementary/efl_ui_box_flow.eo
@@ -1,7 +1,7 @@
struct Efl.Ui.Box.Flow_Params {
[[Extra parameters for Box_Flow layout. Can be omitted.]]
- homogenous: bool;
- max_size: bool;
+ homogenous: bool; [[$true if the box flow layout is homogenous, $false
otherwise]]
+ max_size: bool; [[$true if the box flow layout has the maximal size, $false
otherwise]]
}
class Efl.Ui.Box.Flow (Efl.Ui.Box, Efl.Pack.Layout)
@@ -12,14 +12,14 @@ class Efl.Ui.Box.Flow (Efl.Ui.Box, Efl.Pack.Layout)
set {}
get {}
values {
- val: bool;
+ val: bool; [[$true if the box flow layout is homogenous, $false
otherwise]]
}
}
@property box_flow_max_size {
set {}
get {}
values {
- val: bool;
+ val: bool; [[$true if the box flow layout has the maximal size,
$false otherwise]]
}
}
}
diff --git a/src/lib/elementary/efl_ui_image.eo
b/src/lib/elementary/efl_ui_image.eo
index 8bdf134..ac52194 100644
--- a/src/lib/elementary/efl_ui_image.eo
+++ b/src/lib/elementary/efl_ui_image.eo
@@ -28,8 +28,8 @@ struct Efl.Ui.Image.Progress
Structure associated with smart callback 'download,progress'.
@since 1.8
]]
- now: double;
- total: double;
+ now: double; [[Current percentage]]
+ total: double; [[Total percentage]]
}
struct Efl.Ui.Image.Error
@@ -38,8 +38,8 @@ struct Efl.Ui.Image.Error
Structure associated with smart callback 'download,progress'.
@since 1.8
]]
- status: int;
- open_error: bool;
+ status: int; [[Error status of the download]]
+ open_error: bool; [[$true if the error happened when opening the file,
$false otherwise]]
}
class Efl.Ui.Image (Elm.Widget, Efl.Ui.Clickable, Efl.Ui.Draggable,
diff --git a/src/lib/elementary/efl_ui_text.eo
b/src/lib/elementary/efl_ui_text.eo
index 8fe5833..e71948c 100644
--- a/src/lib/elementary/efl_ui_text.eo
+++ b/src/lib/elementary/efl_ui_text.eo
@@ -4,6 +4,7 @@ import elm_entry;
struct Efl.Ui.Text.Anchor_Info
{
+ [[EFL UI text anchor information]]
name: string; [[The name of the anchor, as stated in its href.]]
button: int; [[The mouse button used to click on it.]]
x: Evas.Coord; [[Anchor geometry, relative to canvas.]]
@@ -14,17 +15,19 @@ struct Efl.Ui.Text.Anchor_Info
struct Efl.Ui.Text.Hover_Parent
{
- x: Evas.Coord;
- y: Evas.Coord;
- w: Evas.Coord;
- h: Evas.Coord;
+ [[EFL text hover parent]]
+ x: Evas.Coord; [[Hover parent X coordinate]]
+ y: Evas.Coord; [[Hover parent Y coordinate]]
+ w: Evas.Coord; [[Hover parent width]]
+ h: Evas.Coord; [[Hover parent height]]
}
struct Efl.Ui.Text.Anchor_Hover_Info
{
+ [[EFL text anchor hover information]]
anchor_info: const(Efl.Ui.Text.Anchor_Info)*; [[The actual anchor info.]]
hover: Elm.Hover; [[The hover object to use for the popup.]]
- hover_parent: Efl.Ui.Text.Hover_Parent;
+ hover_parent: Efl.Ui.Text.Hover_Parent; [[Hover parent widget]]
hover_left : bool; [[Hint indicating if there's space
for content on the left side of
the hover. Before calling the
diff --git a/src/lib/elementary/elm_code_widget.eo
b/src/lib/elementary/elm_code_widget.eo
index b23a073..08d09bb 100644
--- a/src/lib/elementary/elm_code_widget.eo
+++ b/src/lib/elementary/elm_code_widget.eo
@@ -3,8 +3,8 @@ import edje_types;
import elm_interface_scrollable;
import elm_general;
-struct @extern Elm_Code; /* The main interface currently defined in code */
-struct @extern Elm_Code_Line; /* Parts of the interface currently defined in
code */
+struct @extern Elm_Code; [[Elementary code main data structure]] /* The main
interface currently defined in code */
+struct @extern Elm_Code_Line; [[Elementary code line data structure]] /* Parts
of the interface currently defined in code */
class Elm.Code_Widget (Elm.Layout, Elm.Interface.Atspi.Text)
{
diff --git a/src/lib/elementary/elm_general.eot
b/src/lib/elementary/elm_general.eot
index 5598732..5e2fb0d 100644
--- a/src/lib/elementary/elm_general.eot
+++ b/src/lib/elementary/elm_general.eot
@@ -22,6 +22,7 @@ type Eina_Compare_Cb: __undefined_type;
/* FIXME: This shouldn't be here, we don't do functions in eolian!!! */
struct Elm.Gen.Item.Class.Functions
{
+ [[Elementary genlist/gengrid callback functions data structure]]
text_get: Elm_Gen_Item_Text_Get_Cb; [[ Text fetching class function for
genlist/gengrid item classes. ]]
content_get: Elm_Gen_Item_Content_Get_Cb; [[ Content fetching class function
diff --git a/src/lib/elementary/elm_toolbar_item.eo
b/src/lib/elementary/elm_toolbar_item.eo
index a2c94d4..5950c65 100644
--- a/src/lib/elementary/elm_toolbar_item.eo
+++ b/src/lib/elementary/elm_toolbar_item.eo
@@ -16,11 +16,11 @@ struct Elm.Toolbar.Item.State
State of a Elm_Toolbar_Item.
Can be created with elm_toolbar_item_state_add() and removed with
elm_toolbar_item_state_del().
]]
- label: string;
- icon_str: string;
- icon: Efl.Canvas.Object;
- func: Evas_Smart_Cb ;
- data: const(void_ptr);
+ label: string; [[Item label]]
+ icon_str: string; [[Item icon string]]
+ icon: Efl.Canvas.Object; [[Item icon]]
+ func: Evas_Smart_Cb ; [[Item callback function]]
+ data: const(void_ptr); [[Item data]]
}
class Elm.Toolbar.Item(Elm.Widget.Item)
--
