Mercurial > pidgin3 / file diff

--- a/finch/libgnt/gntbox.h	Sun Feb 02 01:22:13 2014 +0530
+++ b/finch/libgnt/gntbox.h	Sun Feb 02 03:49:31 2014 +0530
@@ -88,6 +88,8 @@
 G_BEGIN_DECLS
 
 /**
+ * gnt_box_get_gtype:
+ *
  * The GType for GntBox.
  * Returns: The GType.
  */
@@ -97,110 +99,123 @@
 #define gnt_hbox_new(homo) gnt_box_new(homo, FALSE)
 
 /**
- * Create a new GntBox.
- *
+ * gnt_box_new:
  * @homo:  If %TRUE, all the widgets in it will have the same width (or height)
  * @vert:  Whether the widgets in it should be stacked vertically (if %TRUE)
  *              or horizontally (if %FALSE).
  *
+ * Create a new GntBox.
+ *
  * Returns: The new GntBox.
  */
 GntWidget * gnt_box_new(gboolean homo, gboolean vert);
 
 /**
- * Add a widget in the box.
- *
+ * gnt_box_add_widget:
  * @box:     The box
  * @widget:  The widget to add
+ *
+ * Add a widget in the box.
  */
 void gnt_box_add_widget(GntBox *box, GntWidget *widget);
 
 /**
- * Set a title for the box.
- *
+ * gnt_box_set_title:
  * @box:    The box
  * @title:	 The title to set
+ *
+ * Set a title for the box.
  */
 void gnt_box_set_title(GntBox *box, const char *title);
 
 /**
- * Set the padding to use between the widgets in the box.
- *
+ * gnt_box_set_pad:
  * @box: The box
  * @pad: The padding to use
+ *
+ * Set the padding to use between the widgets in the box.
  */
 void gnt_box_set_pad(GntBox *box, int pad);
 
 /**
+ * gnt_box_set_toplevel:
+ * @box: The box
+ * @set: %TRUE if it's a toplevel box, %FALSE otherwise.
+ *
  * Set whether it's a toplevel box (ie, a window) or not. If a box is toplevel,
  * then it will show borders, the title (if set) and shadow (if enabled in
- * @e .gntrc)
- *
- * @box: The box
- * @set: %TRUE if it's a toplevel box, %FALSE otherwise.
+ * <filename>.gntrc</filename>)
  */
 void gnt_box_set_toplevel(GntBox *box, gboolean set);
 
 /**
- * Reposition and refresh the widgets in the box.
+ * gnt_box_sync_children:
+ * @box: The box
  *
- * @box: The box
+ * Reposition and refresh the widgets in the box.
  */
 void gnt_box_sync_children(GntBox *box);
 
 /**
- * Set the alignment for the widgets in the box.
- *
+ * gnt_box_set_alignment:
  * @box:       The box
  * @alignment: The alignment to use
+ *
+ * Set the alignment for the widgets in the box.
  */
 void gnt_box_set_alignment(GntBox *box, GntAlignment alignment);
 
 /**
- * Remove a widget from the box. Calling this does NOT destroy the removed widget.
- *
+ * gnt_box_remove:
  * @box:       The box
  * @widget:    The widget to remove
+ *
+ * Remove a widget from the box. Calling this does NOT destroy the removed widget.
  */
 void gnt_box_remove(GntBox *box, GntWidget *widget);
 
 /**
- * Remove all widgets from the box. This DOES destroy all widgets in the box.
+ * gnt_box_remove_all:
+ * @box: The box
  *
- * @box: The box
+ * Remove all widgets from the box. This DOES destroy all widgets in the box.
  */
 void gnt_box_remove_all(GntBox *box);
 
 /**
+ * gnt_box_readjust:
+ * @box:  The box
+ *
  * Readjust the size of each child widget, reposition the child widgets and
  * recalculate the size of the box.
- *
- * @box:  The box
  */
 void gnt_box_readjust(GntBox *box);
 
 /**
- * Set whether the widgets in the box should fill the empty spaces.
- *
+ * gnt_box_set_fill:
  * @box:   The box
  * @fill:  Whether the child widgets should fill the empty space
+ *
+ * Set whether the widgets in the box should fill the empty spaces.
  */
 void gnt_box_set_fill(GntBox *box, gboolean fill);
 
 /**
- * Move the focus from one widget to the other.
- *
+ * gnt_box_move_focus:
  * @box: The box
  * @dir: The direction. If it's 1, then the focus is moved forwards, if it's
  *            -1, the focus is moved backwards.
+ *
+ * Move the focus from one widget to the other.
  */
 void gnt_box_move_focus(GntBox *box, int dir);
 
 /**
- * Give focus to a specific child widget.
- *
+ * gnt_box_give_focus_to_child:
  * @box:       The box
  * @widget:    The child widget to give focus
+ *
+ * Give focus to a specific child widget.
  */
 void gnt_box_give_focus_to_child(GntBox *box, GntWidget *widget);