summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSadrul Habib Chowdhury <sadrul@pidgin.im>2009-04-17 19:34:00 +0000
committerSadrul Habib Chowdhury <sadrul@pidgin.im>2009-04-17 19:34:00 +0000
commit843ed74e5c28778b4e98d51137671be143519e7a (patch)
tree32c3635741eac784b6f3100fa47485d4337caaa0
parenta7536023256fe8ce64b48681f290286ab672f02f (diff)
downloadpidgin-843ed74e5c28778b4e98d51137671be143519e7a.tar.gz
Document some functions.
-rw-r--r--pidgin/gtkblist-theme.c2
-rw-r--r--pidgin/gtkblist-theme.h43
2 files changed, 43 insertions, 2 deletions
diff --git a/pidgin/gtkblist-theme.c b/pidgin/gtkblist-theme.c
index 53424f0cf8..13ba87de34 100644
--- a/pidgin/gtkblist-theme.c
+++ b/pidgin/gtkblist-theme.c
@@ -101,7 +101,7 @@ enum {
*****************************************************************************/
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);
diff --git a/pidgin/gtkblist-theme.h b/pidgin/gtkblist-theme.h
index 0f545d8770..e134ea56d0 100644
--- a/pidgin/gtkblist-theme.h
+++ b/pidgin/gtkblist-theme.h
@@ -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 @@ PidginThemeFont * pidgin_theme_font_new(const char *face, GdkColor *color);
*/
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);
/**************************************************************************/