Mercurial > pidgin.yaz

changeset 26653:74d62c5fd716

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some doxygen fixes.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Fri, 17 Apr 2009 16:23:02 +0000
parents 1365dbb97c7d
children f099e7f2739c
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
diffstat 6 files changed, 55 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/pidgin/gtkblist-theme-loader.h	Fri Apr 17 16:21:21 2009 +0000
+++ b/pidgin/gtkblist-theme-loader.h	Fri Apr 17 16:23:02 2009 +0000
@@ -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
--- a/pidgin/gtkblist-theme.h	Fri Apr 17 16:21:21 2009 +0000
+++ b/pidgin/gtkblist-theme.h	Fri Apr 17 16:23:02 2009 +0000
@@ -102,6 +102,8 @@
 /**
  * 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 @@
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
 /**
  * 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 @@
  * 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 @@
 /**
  * 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);
--- a/pidgin/gtkicon-theme-loader.h	Fri Apr 17 16:21:21 2009 +0000
+++ b/pidgin/gtkicon-theme-loader.h	Fri Apr 17 16:23:02 2009 +0000
@@ -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
--- a/pidgin/gtkicon-theme.h	Fri Apr 17 16:21:21 2009 +0000
+++ b/pidgin/gtkicon-theme.h	Fri Apr 17 16:23:02 2009 +0000
@@ -1,5 +1,5 @@
 /**
- * @file icon-theme.h  Pidgin Icon Theme  Class API
+ * @file gtkicon-theme.h  Pidgin Icon Theme  Class API
  */
 
 /* pidgin
--- a/pidgin/gtknotify.h	Fri Apr 17 16:21:21 2009 +0000
+++ b/pidgin/gtknotify.h	Fri Apr 17 16:23:02 2009 +0000
@@ -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
  */
--- a/pidgin/gtkstatus-icon-theme.h	Fri Apr 17 16:21:21 2009 +0000
+++ b/pidgin/gtkstatus-icon-theme.h	Fri Apr 17 16:23:02 2009 +0000
@@ -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