Document box public api.

1 files changed, 43 insertions, 0 deletions

diff --git a/include/widgets/box.h b/include/widgets/box.h
index e797e51e..e5507731 100644
--- a/include/widgets/box.h
+++ b/include/widgets/box.h
@@ -7,20 +7,63 @@
  * @defgroup box box
  * @ingroup widgets
  *
+ * Widget used to pack multiple widgets either horizontally or vertically.
+ * It supports packing widgets horizontally or vertically. Child widgets are always
+ * expanded to the maximum size in the oposite direction of the packing direction.
+ * e.g. vertically packed widgets use the full box width.
+ *
  * @{
  */
 typedef struct _box   box;
+
+/**
+ * The packing direction of the box
+ */
 typedef enum
 {
+    /** Pack widgets horizontal */
     BOX_HORIZONTAL,
+    /** Pack widgets vertical */
     BOX_VERTICAL
 } boxType;
 
+/**
+ * @param type The packing direction of the newly created box.
+ * @param x    The x position of the box relative to its parent.
+ * @param y    The y position of the box relative to its parent.
+ * @param w    The width of the box.
+ * @param h    The height of the box.
+ *
+ * @returns a newly created box, free with #widget_free
+ */
 box * box_create ( boxType type, short x, short y, short w, short h );
 
+/**
+ * @param box   Handle to the box widget.
+ * @param child Handle to the child widget to pack.
+ * @param expand If the child widget should expand and use all available space.
+ * @param end    If the child widget should be packed at the end.
+ *
+ * Add a widget to the box.
+ */ 
 void box_add ( box *box, widget *child, gboolean expand, gboolean end );
 
+/**
+ * @param box Handle to the box widget.
+ *
+ * Obtains the minimal size required to display all widgets. (expanding widgets are not counted, except for their
+ * padding)
+ * 
+ * @returns the minimum size in pixels.
+ */
 int box_get_fixed_pixels ( box *box );
+
+/**
+ * @param box Handle to the box widget.
+ * @param padding The padding to apply.
+ *
+ * Set the padding to apply between the children in pixels.
+ */
 void box_set_padding ( box * box, unsigned int padding );
 /*@}*/
 #endif // ROFI_HBOX_H