diff options
author | Sadrul Habib Chowdhury <sadrul@pidgin.im> | 2009-04-17 16:23:02 +0000 |
---|---|---|
committer | Sadrul Habib Chowdhury <sadrul@pidgin.im> | 2009-04-17 16:23:02 +0000 |
commit | 49390c76fd2b41dd432f9bfb4cee02f934eb4009 (patch) | |
tree | 197fdbd701f7f3cc3047b0b5ad3abe5f0bff9186 | |
parent | cc8365c93171d4f9d3051b1de794a185f64726f2 (diff) | |
download | pidgin-49390c76fd2b41dd432f9bfb4cee02f934eb4009.tar.gz |
Some doxygen fixes.
-rw-r--r-- | pidgin/gtkblist-theme-loader.h | 2 | ||||
-rw-r--r-- | pidgin/gtkblist-theme.h | 48 | ||||
-rw-r--r-- | pidgin/gtkicon-theme-loader.h | 2 | ||||
-rw-r--r-- | pidgin/gtkicon-theme.h | 2 | ||||
-rw-r--r-- | pidgin/gtknotify.h | 4 | ||||
-rw-r--r-- | pidgin/gtkstatus-icon-theme.h | 2 |
6 files changed, 55 insertions, 5 deletions
diff --git a/pidgin/gtkblist-theme-loader.h b/pidgin/gtkblist-theme-loader.h index a5a40621e3..049c1c6ceb 100644 --- a/pidgin/gtkblist-theme-loader.h +++ b/pidgin/gtkblist-theme-loader.h @@ -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 diff --git a/pidgin/gtkblist-theme.h b/pidgin/gtkblist-theme.h index c558ef81b1..f66999d482 100644 --- a/pidgin/gtkblist-theme.h +++ b/pidgin/gtkblist-theme.h @@ -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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); * 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(PidginBlistTheme *theme); /** * 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(PidginBlistTheme *theme); /** * 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_color(PidginBlistTheme *theme, const GdkC /** * 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(PidginBlistTheme *theme, gdouble opacity); /** * 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(PidginBlistTheme *theme, const PidginBlistLay /** * 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_background_color(PidginBlistTheme *theme, c /** * 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_text_info(PidginBlistTheme *theme, const Fo /** * 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_background_color(PidginBlistTheme *theme, /** * 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_text_info(PidginBlistTheme *theme, const F /** * 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_color(PidginBlistTheme *theme, const GdkColo /** * 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_info(PidginBlistTheme *theme, const Fon /** * 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_info(PidginBlistTheme *theme, const Font /** * 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_info(PidginBlistTheme *theme, const FontCo /** * 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_info(PidginBlistTheme *theme, const Fon /** * 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_info(PidginBlistTheme *theme, const FontCo /** * 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_message_text_info(PidginBlistTheme *theme, co * 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_message_nick_said_text_info(PidginBlistTheme /** * 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); diff --git a/pidgin/gtkicon-theme-loader.h b/pidgin/gtkicon-theme-loader.h index 57ab2b53a3..eccb85dc32 100644 --- a/pidgin/gtkicon-theme-loader.h +++ b/pidgin/gtkicon-theme-loader.h @@ -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 diff --git a/pidgin/gtkicon-theme.h b/pidgin/gtkicon-theme.h index 0ba669d349..f479f07c96 100644 --- a/pidgin/gtkicon-theme.h +++ b/pidgin/gtkicon-theme.h @@ -1,5 +1,5 @@ /** - * @file icon-theme.h Pidgin Icon Theme Class API + * @file gtkicon-theme.h Pidgin Icon Theme Class API */ /* pidgin diff --git a/pidgin/gtknotify.h b/pidgin/gtknotify.h index 8ecc762a50..7fa7996263 100644 --- a/pidgin/gtknotify.h +++ b/pidgin/gtknotify.h @@ -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 */ diff --git a/pidgin/gtkstatus-icon-theme.h b/pidgin/gtkstatus-icon-theme.h index 9dbc14c02d..ba8269a778 100644 --- a/pidgin/gtkstatus-icon-theme.h +++ b/pidgin/gtkstatus-icon-theme.h @@ -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 |