elm_widget: added internal documentation about elm_widget_sub_object_add() and elm_wi...
authorDaniel Juyung Seo <juyung.seo@samsung.com>
Fri, 20 Dec 2013 10:08:38 +0000 (19:08 +0900)
committerDaniel Juyung Seo <juyung.seo@samsung.com>
Fri, 20 Dec 2013 10:08:38 +0000 (19:08 +0900)
src/lib/elm_widget.c

index 6045f84..44559d1 100644 (file)
@@ -953,6 +953,13 @@ _elm_widget_on_show_region_hook_set(Eo *obj EINA_UNUSED, void *_pd, va_list *lis
    sd->on_show_region_data = data;
 }
 
+/*
+ * @internal
+ *
+ * Add myself as a sub object of parent object
+ *
+ * @see elm_widget_sub_object_add()
+ */
 EAPI Eina_Bool
 elm_widget_sub_object_parent_add(Evas_Object *sobj)
 {
@@ -965,6 +972,19 @@ elm_widget_sub_object_parent_add(Evas_Object *sobj)
    return ret;
 }
 
+/*
+ * @internal
+ *
+ * Add sobj to obj's sub object.
+ *
+ * What does elementary sub object mean? This is unique in elementary, it
+ * handles overall elementary policies between parent and sub objects.
+ *   focus, access, deletion, theme, scale, mirror, scrollable child get,
+ *   translate, name find, display mode set, orientation set, tree dump
+ *   AUTOMATICALLY.
+ *
+ * @see elm_widget_sub_object_parent_add()
+ */
 EAPI Eina_Bool
 elm_widget_sub_object_add(Evas_Object *obj,
                           Evas_Object *sobj)