diff finch/libgnt/gntlabel.h @ 21253:ae330012956f

Doxygen for gnt.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Tue, 16 Oct 2007 13:06:48 +0000
parents 44b4e8bd759b
children
line wrap: on
line diff
--- a/finch/libgnt/gntlabel.h	Tue Oct 16 11:05:59 2007 +0000
+++ b/finch/libgnt/gntlabel.h	Tue Oct 16 13:06:48 2007 +0000
@@ -67,33 +67,34 @@
 G_BEGIN_DECLS
 
 /**
- * 
- *
- * @return
+ * @return GType for GntLabel.
  */
 GType gnt_label_get_gtype(void);
 
 /**
- * 
- * @param text
+ * Create a new GntLabel.
  *
- * @return
+ * @param text  The text of the label.
+ *
+ * @return  The newly created label.
  */
 GntWidget * gnt_label_new(const char *text);
 
 /**
- * 
- * @param text
- * @param flags
+ * Create a new label with specified text attributes.
  *
- * @return
+ * @param text    The text.
+ * @param flags   Text attributes for the text.
+ *
+ * @return  The newly created label.
  */
 GntWidget * gnt_label_new_with_format(const char *text, GntTextFormatFlags flags);
 
 /**
- * 
- * @param label
- * @param text
+ * Change the text of a label.
+ *
+ * @param label  The label.
+ * @param text   The new text to set in the label.
  */
 void gnt_label_set_text(GntLabel *label, const char *text);