diff finch/libgnt/gntcheckbox.h @ 20306:665d6d7eea83

applied changes from 88f296b3653b5a7578a7581c1582d37390c9d212 through 4bbc209c8076ef89135700af844ec6bb04602c0a
author Luke Schierer <lschiere@pidgin.im>
date Fri, 19 Oct 2007 17:06:53 +0000
parents 44b4e8bd759b
children
line wrap: on
line diff
--- a/finch/libgnt/gntcheckbox.h	Fri Oct 19 16:58:37 2007 +0000
+++ b/finch/libgnt/gntcheckbox.h	Fri Oct 19 17:06:53 2007 +0000
@@ -68,32 +68,33 @@
 G_BEGIN_DECLS
 
 /**
- * 
- *
- * @return
+ * @return GType for GntCheckBox
  */
 GType gnt_check_box_get_gtype(void);
 
 /**
- * 
- * @param text
+ * Create a new checkbox.
  *
- * @return
+ * @param text The text for the checkbox.
+ *
+ * @return  The newly created checkbox.
  */
 GntWidget * gnt_check_box_new(const char *text);
 
 /**
- * 
- * @param box
- * @param set
+ * Set whether the checkbox should be checked or not.
+ *
+ * @param box   The checkbox.
+ * @param set   @c TRUE if the checkbox should be selected, @c FALSE otherwise.
  */
 void gnt_check_box_set_checked(GntCheckBox *box, gboolean set);
 
 /**
- * 
- * @param box
+ * Return the checked state of the checkbox.
  *
- * @return
+ * @param box  The checkbox.
+ *
+ * @return     @c TRUE if the checkbox is selected, @c FALSE otherwise.
  */
 gboolean gnt_check_box_get_checked(GntCheckBox *box);