more docs!

SVN revision: 41239

legacy/elementary/src/lib/elm_box.c

@@ -1,6 +1,11 @@
 #include <Elementary.h>
 #include "elm_priv.h"
 
+/**
+ * @defgroup Box Box
+ *
+ * BLAH
+ */
 typedef struct _Widget_Data Widget_Data;
 
 struct _Widget_Data
@@ -55,6 +60,15 @@ _sub_del(void *data, Evas_Object *obj, void *event_info)
    _sizing_eval(obj);
 }
 
+
+/**
+ * Add a new box to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Box
+ */
 EAPI Evas_Object *
 elm_box_add(Evas_Object *parent)
 {
@@ -80,6 +94,18 @@ elm_box_add(Evas_Object *parent)
    return obj;
 }
 
+/**
+ * Set the horizontal orientation
+ * 
+ * By default box object arrange their contents vertically from top to bottom.
+ * By calling this and providing @p orizontal as true, the box will become
+ * horizontal arranging contents left to right.
+ *
+ * @param obj The box object
+ * @param horizontal The horizontal flag (1 = horizontal, 0 = vertical)
+ *
+ * @ingroup Box
+ */
 EAPI void
 elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
 {
@@ -87,6 +113,17 @@ elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
    _els_smart_box_orientation_set(wd->box, horizontal);
 }
 
+/**
+ * Set homogenous layout
+ * 
+ * If enabled, homogenous layout makes all items the same size. This size is
+ * of course governed by the size of the largest item in the box.
+ *
+ * @param obj The box object
+ * @param homogenous The homogenous flag (1 = on, 2 = off)
+ *
+ * @ingroup Box
+ */
 EAPI void
 elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous)
 {
@@ -94,6 +131,17 @@ elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous)
    _els_smart_box_homogenous_set(wd->box, homogenous);
 }
 
+/**
+ * This adds a box at the start of the box (top or left based on orientation)
+ *
+ * This will add the @p subobj to the box object indicated at the beginning
+ * of the box (the left or top end).
+ * 
+ * @param obj The box object
+ * @param subobj The object to add to the box
+ * 
+ * @ingroup Box
+ */
 EAPI void
 elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj)
 {
@@ -102,6 +150,17 @@ elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj)
    _els_smart_box_pack_start(wd->box, subobj);
 }
 
+/**
+ * This adds a box at the end of the box (bottom or right based on orientation)
+ *
+ * This will add the @p subobj to the box object indicated at the end
+ * of the box (the right or bottom end).
+ * 
+ * @param obj The box object
+ * @param subobj The object to add to the box
+ * 
+ * @ingroup Box
+ */
 EAPI void
 elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj)
 {
@@ -110,6 +169,20 @@ elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj)
    _els_smart_box_pack_end(wd->box, subobj);
 }
 
+/**
+ * This adds adds an object to the box before the indicated object
+ *
+ * This will add the @p subobj to the box indicated before the object
+ * indicated with @p before. If @p before is not already in the box, results
+ * are undefined. Before means either to the left of the indicated object or
+ * above it depending on orientation.
+ * 
+ * @param obj The box object
+ * @param subobj The object to add to the box
+ * @param before The object before which to add it
+ *
+ * @ingroup Box
+ */
 EAPI void
 elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before)
 {
@@ -118,6 +191,20 @@ elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before)
    _els_smart_box_pack_before(wd->box, subobj, before);
 }
 
+/**
+ * This adds adds an object to the box after the indicated object
+ *
+ * This will add the @p subobj to the box indicated after the object
+ * indicated with @p after. If @p after is not already in the box, results
+ * are undefined. After means either to the right of the indicated object or
+ * below it depending on orientation.
+ * 
+ * @param obj The box object
+ * @param subobj The object to add to the box
+ * @param after The object after which to add it
+ *
+ * @ingroup Box
+ */
 EAPI void
 elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after)
 {