diff finch/libgnt/gntbox.h @ 18079:c885a9ccd301

propagate from branch 'im.pidgin.pidgin' (head 03da073664bc840f76d0cec53eea61517337c5a7) to branch 'im.pidgin.pidgin.2.1.0' (head 2eee4d84a7977a4f51d95b9b57910625dc3e9085)

--- a/finch/libgnt/gntbox.h	Fri Jun 08 12:52:35 2007 +0000
+++ b/finch/libgnt/gntbox.h	Fri Jun 08 13:25:28 2007 +0000
@@ -1,3 +1,25 @@
+/**
+ * GNT - The GLib Ncurses Toolkit
+ *
+ * GNT is the legal property of its developers, whose names are too numerous
+ * to list here.  Please refer to the COPYRIGHT file distributed with this
+ * source distribution.
+ *
+ * This library is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
 #ifndef GNT_BOX_H
 #define GNT_BOX_H
 
@@ -61,35 +83,110 @@
 
 G_BEGIN_DECLS
 
+/**
+ * 
+ *
+ * @return
+ */
 GType gnt_box_get_gtype(void);
 
 #define gnt_vbox_new(homo) gnt_box_new(homo, TRUE)
 #define gnt_hbox_new(homo) gnt_box_new(homo, FALSE)
 
-GntWidget *gnt_box_new(gboolean homo, gboolean vert);
+/**
+ * 
+ * @param homo
+ * @param vert
+ *
+ * @return
+ */
+GntWidget * gnt_box_new(gboolean homo, gboolean vert);
 
+/**
+ * 
+ * @param box
+ * @param widget
+ */
 void gnt_box_add_widget(GntBox *box, GntWidget *widget);
 
+/**
+ * 
+ * @param box
+ * @param title
+ */
 void gnt_box_set_title(GntBox *box, const char *title);
 
+/**
+ * 
+ * @param box
+ * @param pad
+ */
 void gnt_box_set_pad(GntBox *box, int pad);
 
+/**
+ * 
+ * @param box
+ * @param set
+ */
 void gnt_box_set_toplevel(GntBox *box, gboolean set);
 
+/**
+ * 
+ * @param box
+ */
 void gnt_box_sync_children(GntBox *box);
 
+/**
+ * 
+ * @param box
+ * @param alignment
+ */
 void gnt_box_set_alignment(GntBox *box, GntAlignment alignment);
 
-void gnt_box_remove(GntBox *box, GntWidget *widget); /* XXX: does NOT destroy widget */
+/**
+ * 
+ * @param box
+ * @param widget
+ */
+void gnt_box_remove(GntBox *box, GntWidget *widget);
+
+ /* XXX: does NOT destroy widget */
 
-void gnt_box_remove_all(GntBox *box);      /* Removes AND destroys all the widgets in it */
+/**
+ * 
+ * @param box
+ */
+void gnt_box_remove_all(GntBox *box);
 
+      /* Removes AND destroys all the widgets in it */
+
+/**
+ * 
+ * @param box
+ */
 void gnt_box_readjust(GntBox *box);
 
+/**
+ * 
+ * @param box
+ * @param fill
+ */
 void gnt_box_set_fill(GntBox *box, gboolean fill);
 
-void gnt_box_move_focus(GntBox *box, int dir);  /* +1 to move forward, -1 for backward */
+/**
+ * 
+ * @param box
+ * @param dir
+ */
+void gnt_box_move_focus(GntBox *box, int dir);
 
+  /* +1 to move forward, -1 for backward */
+
+/**
+ * 
+ * @param box
+ * @param widget
+ */
 void gnt_box_give_focus_to_child(GntBox *box, GntWidget *widget);
 
 G_END_DECLS