docs: fill in all missing item documentation for efl_ui_focus_*
authorStefan Schmidt <stefan@osg.samsung.com>
Fri, 8 Dec 2017 13:47:34 +0000 (14:47 +0100)
committerStefan Schmidt <stefan@osg.samsung.com>
Fri, 8 Dec 2017 15:17:27 +0000 (16:17 +0100)
There has been gaps in various files. Makre sure we have them all
covered.

src/lib/elementary/efl_ui.eot
src/lib/elementary/efl_ui_focus_composition.eo
src/lib/elementary/efl_ui_focus_composition_adapter.eo
src/lib/elementary/efl_ui_focus_layer.eo
src/lib/elementary/efl_ui_focus_manager.eo
src/lib/elementary/efl_ui_focus_parent_provider.eo
src/lib/elementary/efl_ui_focus_parent_provider_gen.eo
src/lib/elementary/efl_ui_focus_parent_provider_standard.eo
src/lib/elementary/efl_ui_focus_rectangle.eo
src/lib/elementary/efl_ui_focus_util.eo

index 69afccc..f3efc84 100644 (file)
@@ -20,7 +20,7 @@ enum Efl.Ui.Focus.Direction
    down = 3,     [[ down direction ]]
    right = 4,    [[ right direction ]]
    left = 5,     [[ left direction ]]
-   last = 6
+   last = 6      [[ last direction ]]
 }
 
 enum Efl.Ui.Interest_Region_Mode
index dd7fcaa..8d56443 100644 (file)
@@ -39,7 +39,7 @@ mixin Efl.Ui.Focus.Composition (Efl.Interface, Elm.Widget ) {
            Set to $null to register them in the same manager as the implementor is
          ]]
          values {
-            custom_manager : Efl.Ui.Focus.Manager;
+            custom_manager : Efl.Ui.Focus.Manager; [[EFL focus manager]]
          }
       }
       @property logical_mode @protected {
index 016d5d9..b6e9fc9 100644 (file)
@@ -1,9 +1,11 @@
 class Efl.Ui.Focus.Composition.Adapter (Efl.Object, Efl.Ui.Focus.Object)
 {
+   [[EFL UI Focus Composition Adapter class]]
    methods {
       @property canvas_object {
+         [[Canvas Object Property]]
          values {
-            v : Efl.Canvas.Object;
+            v : Efl.Canvas.Object; [[EFL canvas object]]
          }
       }
    }
index 1728a7d..7063c13 100644 (file)
@@ -7,6 +7,7 @@ mixin Efl.Ui.Focus.Layer (Efl.Interface, Elm.Widget, Efl.Gfx, Efl.Ui.Focus.Manag
    ]]
    methods {
      @property enable @protected {
+        [[Enable property]]
         values {
            v : bool; [[$true to set enable the layer $false to disable it]]
         }
index 3d26ab2..60d7b8b 100644 (file)
@@ -14,7 +14,7 @@ struct Efl.Ui.Focus.Relations {
     parent : Efl.Ui.Focus.Object; [[Parent object]]
     redirect : Efl.Ui.Focus.Manager; [[Redirect manager]]
     node : Efl.Ui.Focus.Object; [[The node where this is the information from]]
-    logical : bool; [[true if this node is only logical]]
+    logical : bool; [[$true if this node is only logical]]
     position_in_history : int; [[The position in the history stack]]
 }
 
@@ -116,9 +116,9 @@ interface Efl.Ui.Focus.Manager {
               so you can call this function out of a prepare call.
             ]]
               params {
-                 child : Efl.Ui.Focus.Object;
+                 child : Efl.Ui.Focus.Object; [[Parent for returned child]]
               }
-              return : Efl.Ui.Focus.Object;
+              return : Efl.Ui.Focus.Object; [[Child of passed parameter]]
         }
         fetch {
             [[This will fetch the data from a registered node.
index 13d4638..04fa38a 100644 (file)
@@ -1,11 +1,12 @@
 interface Efl.Ui.Focus.Parent_Provider {
+   [[EFL UI Focus Parent Provider interface]]
    methods {
       find_logical_parent {
         [[Called to get the logical parent of widget]]
         params {
-           widget : Efl.Ui.Focus.Object;
+           widget : Efl.Ui.Focus.Object; [[Object to find parent for]]
         }
-        return : Efl.Ui.Focus.Object;
+        return : Efl.Ui.Focus.Object; [[Parent of parameter object]]
       }
    }
 }
index a863b62..fbdf7d2 100644 (file)
@@ -1,13 +1,16 @@
 class Efl.Ui.Focus.Parent_Provider.Gen(Efl.Object, Efl.Ui.Focus.Parent_Provider) {
+   [[EFL UI Focus Parent Provider Gen class]]
    methods {
       @property content_item_map {
+         [[Content item map property]]
          values {
-            map : hash<Elm.Widget, Elm.Widget.Item>;
+            map : hash<Elm.Widget, Elm.Widget.Item>; [[Item map]]
          }
       }
       @property container {
+         [[Container property]]
          values {
-            container : Elm.Widget;
+            container : Elm.Widget; [[Container widget]]
          }
       }
    }
index 9daa4ae..3696bcb 100644 (file)
@@ -1,4 +1,5 @@
 class Efl.Ui.Focus.Parent_Provider.Standard(Efl.Object, Efl.Ui.Focus.Parent_Provider) {
+   [[EFL UI Focus Parent Provider Standard Class]]
    implements {
       Efl.Ui.Focus.Parent_Provider.find_logical_parent;
    }
index 63d9ca9..fdfb145 100644 (file)
@@ -1,5 +1,6 @@
 class Efl.Ui.Focus.Rectangle (Efl.Canvas.Rectangle, Efl.Ui.Focus.Object)
 {
+   [[EFL UI Focus Rectangle class]]
    implements {
       Efl.Ui.Focus.Object.focus_geometry {get;}
       Efl.Ui.Focus.Object.focus {set; get;}
index 969afda..651193b 100644 (file)
@@ -1,8 +1,10 @@
 class Efl.Ui.Focus.Util(Efl.Object) {
+   [[EFL UI Focus Util class]]
    methods {
       focus @class {
+         [[Focus helper method]]
          params {
-            focus_elem : Efl.Ui.Focus.Object;
+            focus_elem : Efl.Ui.Focus.Object; [[Focus element]]
          }
       }
    }