diff finch/libgnt/gntcolors.h @ 20751:fe77cc691f78

Some doxygen stuff.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Tue, 02 Oct 2007 04:22:26 +0000
parents 44b4e8bd759b
children 9187d331aebe
line wrap: on
line diff
--- a/finch/libgnt/gntcolors.h	Tue Oct 02 03:46:43 2007 +0000
+++ b/finch/libgnt/gntcolors.h	Tue Oct 02 04:22:26 2007 +0000
@@ -29,6 +29,9 @@
 
 #include <glib.h>
 
+/**
+ * Different classes of colors.
+ */
 typedef enum
 {
 	GNT_COLOR_NORMAL = 1,
@@ -58,27 +61,28 @@
 	GNT_TOTAL_COLORS
 };
 
-/* populate some default colors */
 /**
- * 
+ * Initialize the colors.
  */
 void gnt_init_colors(void);
 
 /**
- * 
+ * Uninitialize the colors.
  */
 void gnt_uninit_colors(void);
 
 #if GLIB_CHECK_VERSION(2,6,0)
 /**
- * 
- * @param kfile
+ * Parse color information from a file.
+ *
+ * @param kfile  The file containing color information.
  */
 void gnt_colors_parse(GKeyFile *kfile);
 
 /**
- * 
- * @param kfile
+ * Parse color-pair information from a file.
+ *
+ * @param kfile The file containing the color-pair information.
  */
 void gnt_color_pairs_parse(GKeyFile *kfile);