sadrul.gtkblist-theme: 3275d22c: Some doxygen fixes.

sadrul at pidgin.im sadrul at pidgin.im
Fri Apr 17 19:50:46 EDT 2009


-----------------------------------------------------------------
Revision: 3275d22caa307448632aadda0dbb8efe37385dc6
Ancestor: d8b732eb99c93f7a380d8ad15147f695ba350088
Author: sadrul at pidgin.im
Date: 2009-04-17T16:23:02
Branch: im.pidgin.sadrul.gtkblist-theme
URL: http://d.pidgin.im/viewmtn/revision/info/3275d22caa307448632aadda0dbb8efe37385dc6

Modified files:
        pidgin/gtkblist-theme-loader.h pidgin/gtkblist-theme.h
        pidgin/gtkicon-theme-loader.h pidgin/gtkicon-theme.h
        pidgin/gtknotify.h pidgin/gtkstatus-icon-theme.h

ChangeLog: 

Some doxygen fixes.

-------------- next part --------------
============================================================
--- pidgin/gtkblist-theme-loader.h	14794ef932610da8a32c554383b1d653a401b740
+++ pidgin/gtkblist-theme-loader.h	e5e373e18e1217b8063a43d31d3aa8c6d9b9d4df
@@ -1,5 +1,5 @@
 /**
- * @file gtkblist-loader.h  Pidgin Buddy List Theme Loader Class API
+ * @file gtkblist-theme-loader.h  Pidgin Buddy List Theme Loader Class API
  */
 
 /* pidgin
============================================================
--- pidgin/gtkblist-theme.h	aa0324ebabb1de723cc759005a31a99a5cb5603e
+++ pidgin/gtkblist-theme.h	f4e5a6982e84ff8d80bf86f3292cd601017bfec0
@@ -102,6 +102,8 @@ GType pidgin_blist_theme_get_type(void);
 /**
  * Returns the background color of the buddy list.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
@@ -110,6 +112,8 @@ GType pidgin_blist_theme_get_type(void);
  * Returns the opacity of the buddy list window
  * (0.0 or clear to 1.0 fully opaque).
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns The opacity
  */
 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
@@ -117,6 +121,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the layout to be used with the buddy list.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns The buddy list layout.
  */
  PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
@@ -124,6 +130,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the background color to be used with expanded groups.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
@@ -131,6 +139,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used with expanded groups.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
@@ -138,6 +148,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the background color to be used with collapsed groups.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
@@ -145,6 +157,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used with collapsed groups.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
@@ -152,6 +166,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the colors to be used for contacts and chats.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A gdkcolor for contacts and chats.
  */
  GdkColor *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme);
@@ -159,6 +175,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used for expanded contacts.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
@@ -166,6 +184,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used for online buddies.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
@@ -173,6 +193,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used for away and idle buddies.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
@@ -180,6 +202,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used for offline buddies.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
@@ -187,6 +211,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used for idle buddies.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
@@ -194,6 +220,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used for buddies with unread messages.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme);
@@ -202,6 +230,8 @@ gdouble pidgin_blist_theme_get_opacity(P
  * Returns the text font and color to be used for chats with unread messages
  * that mention your nick.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme);
@@ -209,6 +239,8 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Returns the text font and color to be used for a buddy's status message.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme);
@@ -218,6 +250,7 @@ gdouble pidgin_blist_theme_get_opacity(P
 /**
  * Sets the background color to be used for this buddy list theme.
  *
+ * @param theme  The PidginBlist theme.
  * @param color The new background color.
  */
 void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, const GdkColor *color);
@@ -225,6 +258,7 @@ void pidgin_blist_theme_set_background_c
 /**
  * Sets the opacity to be used for this buddy list theme.
  *
+ * @param theme  The PidginBlist theme.
  * @param opacity The new opacity setting.
  */
 void pidgin_blist_theme_set_opacity(PidginBlistTheme *theme, gdouble opacity);
@@ -232,6 +266,7 @@ void pidgin_blist_theme_set_opacity(Pidg
 /**
  * Sets the buddy list layout to be used for this buddy list theme.
  *
+ * @param theme  The PidginBlist theme.
  * @param layout The new layout.
  */
 void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, const PidginBlistLayout *layout);
@@ -239,6 +274,7 @@ void pidgin_blist_theme_set_layout(Pidgi
 /**
  * Sets the background color to be used for expanded groups.
  *
+ * @param theme  The PidginBlist theme.
  * @param color The new background color.
  */
 void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, const GdkColor *color);
@@ -246,6 +282,7 @@ void pidgin_blist_theme_set_expanded_bac
 /**
  * Sets the text color and font to be used for expanded groups.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -253,6 +290,7 @@ void pidgin_blist_theme_set_expanded_tex
 /**
  * Sets the background color to be used for collapsed groups.
  *
+ * @param theme  The PidginBlist theme.
  * @param color The new background color.
  */
 void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, const GdkColor *color);
@@ -260,6 +298,7 @@ void pidgin_blist_theme_set_collapsed_ba
 /**
  * Sets the text color and font to be used for expanded groups.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -267,6 +306,7 @@ void pidgin_blist_theme_set_collapsed_te
 /**
  * Sets the background color to be used for contacts and chats.
  *
+ * @param theme  The PidginBlist theme.
  * @param color The color to use for contacts and chats.
  */
 void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, const GdkColor *color);
@@ -274,6 +314,7 @@ void pidgin_blist_theme_set_contact_colo
 /**
  * Sets the text color and font to be used for expanded contacts.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -281,6 +322,7 @@ void pidgin_blist_theme_set_contact_text
 /**
  * Sets the text color and font to be used for online buddies.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -288,6 +330,7 @@ void pidgin_blist_theme_set_online_text_
 /**
  * Sets the text color and font to be used for away and idle buddies.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -295,6 +338,7 @@ void pidgin_blist_theme_set_away_text_in
 /**
  * Sets the text color and font to be used for offline buddies.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -302,6 +346,7 @@ void pidgin_blist_theme_set_offline_text
 /**
  * Sets the text color and font to be used for idle buddies.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -309,6 +354,7 @@ void pidgin_blist_theme_set_idle_text_in
 /**
  * Sets the text color and font to be used for buddies with unread messages.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -317,6 +363,7 @@ void pidgin_blist_theme_set_unread_messa
  * Sets the text color and font to be used for a chat with unread messages
  * that mention your nick.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
@@ -324,6 +371,7 @@ void pidgin_blist_theme_set_unread_messa
 /**
  * Sets the text color and font to be used for buddy status messages.
  *
+ * @param theme  The PidginBlist theme.
  * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, const FontColorPair *pair);
============================================================
--- pidgin/gtkicon-theme-loader.h	448e091e359bd1782a24967294b172f96be4c0aa
+++ pidgin/gtkicon-theme-loader.h	7754c57fa34f573897bb8ced7cea955b00d9bb12
@@ -1,5 +1,5 @@
 /**
- * @file gtkicon-loader.h  Pidgin Icon Theme Loader Class API
+ * @file gtkicon-theme-loader.h  Pidgin Icon Theme Loader Class API
  */
 
 /* purple
============================================================
--- pidgin/gtkicon-theme.h	a6b46a7d3a13d812d656d490e96e8fa6bbc1b55e
+++ pidgin/gtkicon-theme.h	6e5b506141d231e2f1c3c3ada35cac4eb0b900e7
@@ -1,5 +1,5 @@
 /**
- * @file icon-theme.h  Pidgin Icon Theme  Class API
+ * @file gtkicon-theme.h  Pidgin Icon Theme  Class API
  */
 
 /* pidgin
============================================================
--- pidgin/gtknotify.h	fdd835a6fcceca15a925794f5b5c1274cba01af6
+++ pidgin/gtknotify.h	8ee563e34247793fa22c453906c9d6ebfa3cab4b
@@ -32,8 +32,10 @@
 /**
  * Adds a buddy pounce to the buddy pounce dialog
  *
+ * @param account	The account
+ * @param pounce	The pounce
  * @param alias		The buddy alias
- * @param event 	Event description
+ * @param event		Event description
  * @param message	Pounce message
  * @param date		Pounce date
  */
============================================================
--- pidgin/gtkstatus-icon-theme.h	25ba2f845a14f18bfdae2136f76d8813013582ff
+++ pidgin/gtkstatus-icon-theme.h	d90b73fee9db077528ff0afd26dae1dba837d72f
@@ -1,5 +1,5 @@
 /**
- * @file status_icon-theme.h  Pidgin Icon Theme  Class API
+ * @file gtkstatus-icon-theme.h  Pidgin Icon Theme  Class API
  */
 
 /* pidgin


More information about the Commits mailing list