efl_ui_factory: improve docs

Summary:
and remove TAAABS
Depends on D10038

Reviewers: segfaultxavi

Reviewed By: segfaultxavi

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D10042

diff --git a/src/lib/efl/interfaces/efl_ui_factory.eo b/src/lib/efl/interfaces/efl_ui_factory.eo
index 3a531af..eded76f 100644 (file)
--- a/src/lib/efl/interfaces/efl_ui_factory.eo
+++ b/src/lib/efl/interfaces/efl_ui_factory.eo
@@ -6,7 +6,12 @@ struct @beta Efl.Ui.Factory_Item_Created_Event {
 
 interface @beta Efl.Ui.Factory extends Efl.Ui.Property_Bind, Efl.Ui.Factory_Bind
 {
-   [[Efl UI factory interface]]
+   [[Interface for factory-pattern object creation.
+
+     This object represents a Factory in the factory pattern. Objects should be created via the method
+     @Efl.Ui.View_Factory.create_with_event, which will in turn call the necessary APIs from this interface.
+     Objects created this way should be removed using @.release.
+   ]]
    methods {
       create @protected {
          [[Create a UI object from the necessary properties in the specified model.
@@ -16,14 +21,14 @@ interface @beta Efl.Ui.Factory extends Efl.Ui.Property_Bind, Efl.Ui.Factory_Bind
          params {
             models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item.
                                            It should remain valid until the end of the function call.]]
-            parent: Efl.Gfx.Entity; [[Efl canvas]]
+            parent: Efl.Gfx.Entity; [[Efl canvas.]]
          }
-         return: future<Efl.Gfx.Entity>; [[Created UI object]]
+         return: future<Efl.Gfx.Entity>; [[Created UI object.]]
       }
       release {
          [[Release a UI object and disconnect from models.]]
          params {
-            ui_view: Efl.Gfx.Entity; [[Efl canvas]]
+            ui_view: Efl.Gfx.Entity; [[Object to remove.]]
          }
       }
       building @const {

diff --git a/src/lib/efl/interfaces/efl_ui_view_factory.eo b/src/lib/efl/interfaces/efl_ui_view_factory.eo
index 94db98b..bb1e4a4 100644 (file)
--- a/src/lib/efl/interfaces/efl_ui_view_factory.eo
+++ b/src/lib/efl/interfaces/efl_ui_view_factory.eo
@@ -8,13 +8,13 @@ class @beta Efl.Ui.View_Factory
            the factory when the object is done building. This function must be use by all @Efl.Ui.View that need to
            create object. They should not use @Efl.Ui.Factory.create directly.]]
          params {
-           factory: Efl.Ui.Factory; [[The factory to use for requesting the new object from and generating the created
+            factory: Efl.Ui.Factory; [[The factory to use for requesting the new object from and generating the created
                                  event onto.]]
-           models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item. It should
+            models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item. It should
                                      remain valid until the end of the function call.]]
-           parent: Efl.Gfx.Entity; [[Efl canvas]]
+            parent: Efl.Gfx.Entity; [[Efl canvas]]
          }
-        return: future<Efl.Gfx.Entity>; [[Created UI object]]
+         return: future<Efl.Gfx.Entity>; [[Created UI object]]
       }
    }
 }