diff finch/libgnt/gntcombobox.h @ 18049:1cedd520cd18

Doxygen skeleton and license info for gnt files.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Wed, 06 Jun 2007 15:42:29 +0000
parents f00f2e283ffb
children 5c6f019e48f8 992afeb1d40f
line wrap: on
line diff
--- a/finch/libgnt/gntcombobox.h	Wed Jun 06 14:36:37 2007 +0000
+++ b/finch/libgnt/gntcombobox.h	Wed Jun 06 15:42:29 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_COMBO_BOX_H
 #define GNT_COMBO_BOX_H
 
@@ -42,18 +64,54 @@
 
 G_BEGIN_DECLS
 
+/**
+ * 
+ *
+ * @return
+ */
 GType gnt_combo_box_get_gtype(void);
 
-GntWidget *gnt_combo_box_new(void);
+/**
+ * 
+ *
+ * @return
+ */
+GntWidget * gnt_combo_box_new(void);
 
+/**
+ * 
+ * @param box
+ * @param key
+ * @param text
+ */
 void gnt_combo_box_add_data(GntComboBox *box, gpointer key, const char *text);
 
+/**
+ * 
+ * @param box
+ * @param key
+ */
 void gnt_combo_box_remove(GntComboBox *box, gpointer key);
 
+/**
+ * 
+ * @param box
+ */
 void gnt_combo_box_remove_all(GntComboBox *box);
 
+/**
+ * 
+ * @param box
+ *
+ * @return
+ */
 gpointer gnt_combo_box_get_selected_data(GntComboBox *box);
 
+/**
+ * 
+ * @param box
+ * @param key
+ */
 void gnt_combo_box_set_selected(GntComboBox *box, gpointer key);
 
 G_END_DECLS