changeset 26573:98c40e2a0c7f

Document some functions.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Fri, 17 Apr 2009 19:34:00 +0000
parents f099e7f2739c
children 7591d7ed911c
files pidgin/gtkblist-theme.c pidgin/gtkblist-theme.h
diffstat 2 files changed, 43 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/pidgin/gtkblist-theme.c	Fri Apr 17 19:28:20 2009 +0000
+++ b/pidgin/gtkblist-theme.c	Fri Apr 17 19:34:00 2009 +0000
@@ -101,7 +101,7 @@
  *****************************************************************************/
 
 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);
--- a/pidgin/gtkblist-theme.h	Fri Apr 17 19:28:20 2009 +0000
+++ b/pidgin/gtkblist-theme.h	Fri Apr 17 19:34:00 2009 +0000
@@ -84,7 +84,15 @@
 /** @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(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);
 
 /**************************************************************************/