efl_ui/layout: improve docs

Summary: add doc notes for these classes

Reviewers: segfaultxavi

Reviewed By: segfaultxavi

Subscribers: cedric, #reviewers, #committers

Tags: #efl

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

diff --git a/src/lib/elementary/efl_ui_layout.eo b/src/lib/elementary/efl_ui_layout.eo
index 0ebbb4e..f8ff7a9 100644 (file)
--- a/src/lib/elementary/efl_ui_layout.eo
+++ b/src/lib/elementary/efl_ui_layout.eo
@@ -2,7 +2,7 @@ import efl_ui;
 
 class Efl.Ui.Layout extends Efl.Ui.Layout_Base implements Efl.File
 {
-   [[Elementary layout class
+   [[EFL layout widget class.
 
      When loading layouts from a file, use the @Efl.File.key property to specify
      the group that the data belongs to, in case it's an EET file

diff --git a/src/lib/elementary/efl_ui_layout_base.eo b/src/lib/elementary/efl_ui_layout_base.eo
index 61c5fca..5ba44f3 100644 (file)
--- a/src/lib/elementary/efl_ui_layout_base.eo
+++ b/src/lib/elementary/efl_ui_layout_base.eo
@@ -5,7 +5,19 @@ abstract Efl.Ui.Layout_Base extends Efl.Ui.Widget implements Efl.Container,
                      Efl.Layout.Calc, Efl.Layout.Signal,
                      Efl.Layout.Group
 {
-   [[Elementary layout abstract
+   [[EFL layout widget abstract.
+
+     A "layout" in the context of EFL is an object which interfaces with the internal layout engine.
+     Layouts are created using the EDC language, and any widget which implements this abstract must
+     have a corresponding theme group to load in order to graphically display anything.
+
+     Theme groups for EFL widgets must be versioned. This means having a "version" $[data.item] key in
+     the theme group for the widget. If the loaded theme group for a widget has version info which
+     is lower than the currently-running EFL version, a warning will be printed to notify the user that
+     new features may be available. If the loaded theme group for a widget has no version info, an
+     error will be generated. If the loaded theme group for a widget has a version that is newer than
+     the currently-running EFL version, a critical error will be printed to notify the user that
+     the theme may not be compatible.
 
      @since 1.22
    ]]