sadrul.gtkblist-theme: e9739d99: Document some functions.

[sadrul at pidgin.im]

-----------------------------------------------------------------
Revision: e9739d99d7b0b2c65515864c48ee58dc388b3cf8
Ancestor: 8d0c661e542317196fdd72509cd89d4bc4666653
Author: sadrul at pidgin.im
Date: 2009-04-17T19:34:00
Branch: im.pidgin.sadrul.gtkblist-theme
URL: http://d.pidgin.im/viewmtn/revision/info/e9739d99d7b0b2c65515864c48ee58dc388b3cf8

Modified files:
        pidgin/gtkblist-theme.c pidgin/gtkblist-theme.h

ChangeLog: 

Document some functions.

-------------- next part --------------
============================================================
--- pidgin/gtkblist-theme.c	8ecac398b69039d97465fbd92d6d7f37535e27d2
+++ pidgin/gtkblist-theme.c	ce9fb1071df45b45b9bc19fba8dd4cb0653b23fa
@@ -101,7 +101,7 @@ PidginThemeFont *
  *****************************************************************************/
 
 PidginThemeFont *
-pidgin_theme_font_new(const char *face, GdkColor *color)
+pidgin_theme_font_new(const gchar *face, GdkColor *color)
 {
 	PidginThemeFont *font = g_new0(PidginThemeFont, 1);
 	font->font = g_strdup(face);
============================================================
--- pidgin/gtkblist-theme.h	7ddb3ec5e106f94697dc1d05cbdd9b35f99f4ad4
+++ pidgin/gtkblist-theme.h	5a69850b9f860257233bb7bef3eee03649a98b22
@@ -84,7 +84,15 @@ typedef struct
 /** @name PidginThemeFont API                                               */
 /**************************************************************************/
 
-PidginThemeFont * pidgin_theme_font_new(const char *face, GdkColor *color);
+/**
+ * Create a new PidginThemeFont.
+ *
+ * @param face  The font face
+ * @param color The color of the font
+ *
+ * @return A newly created PidginThemeFont
+ */
+PidginThemeFont * pidgin_theme_font_new(const gchar *face, GdkColor *color);
 
 /**
  * Frees a font and color pair
@@ -93,14 +101,47 @@ void pidgin_theme_font_free(PidginThemeF
  */
 void pidgin_theme_font_free(PidginThemeFont *font);
 
+/**
+ * Set the font-face of a PidginThemeFont.
+ *
+ * @param font  The PidginThemeFont
+ * @param face  The font-face
+ */
 void pidgin_theme_font_set_font_face(PidginThemeFont *font, const gchar *face);
 
+/**
+ * Set the color of a PidginThemeFont.
+ *
+ * @param font  The PidginThemeFont
+ * @param color The color
+ */
 void pidgin_theme_font_set_color(PidginThemeFont *font, const GdkColor *color);
 
+/**
+ * Get the font-face of a PidginThemeFont.
+ *
+ * @param font  The PidginThemeFont
+ *
+ * @return The font-face
+ */
 const gchar * pidgin_theme_font_get_font_face(PidginThemeFont *font);
 
+/**
+ * Get the color of a PidginThemeFont as a GdkColor object.
+ *
+ * @param font  The PidginThemeFont
+ *
+ * @return The color
+ */
 const GdkColor * pidgin_theme_font_get_color(PidginThemeFont *font);
 
+/**
+ * Get the color of a PidginThemeFont.
+ *
+ * @param font  The PidginThemeFont
+ *
+ * @return The color
+ */
 const gchar * pidgin_theme_font_get_color_describe(PidginThemeFont *font);
 
 /**************************************************************************/