Mercurial > pidgin

changeset 26669:b1c8ffbd48f9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix more `make docs` warnings
author Paul Aurich <paul@darkrain42.org>
date Thu, 12 Mar 2009 03:54:11 +0000
parents f916afb91566
children f22ecddd3eba
files libpurple/sound-theme.h libpurple/theme-loader.h libpurple/theme-manager.h pidgin/gtkblist-theme-loader.h pidgin/gtkblist-theme.h pidgin/gtkicon-theme-loader.h pidgin/gtkicon-theme.h pidgin/gtkstatus-icon-theme.h
diffstat 8 files changed, 72 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/sound-theme.h	Thu Mar 12 03:52:54 2009 +0000
+++ b/libpurple/sound-theme.h	Thu Mar 12 03:54:11 2009 +0000
@@ -73,6 +73,7 @@
 /**
  * Returns a copy of the filename for the sound event.
  *
+ * @param theme The theme.
  * @param event The purple sound event to look up.
  *
  * @returns The filename of the sound event.
@@ -83,6 +84,7 @@
 /**
  * Returns a copy of the directory and filename for the sound event
  *
+ * @param theme The theme.
  * @param event The purple sound event to look up
  *
  * @returns The directory + '/' + filename of the sound event.  This is
@@ -94,8 +96,9 @@
 /**
  * Sets the filename for a given sound event
  *
- * @param event		the purple sound event to look up
- * @param filename		the name of the file to be used for the event
+ * @param theme    The theme.
+ * @param event    the purple sound event to look up
+ * @param filename the name of the file to be used for the event
  */
 void purple_sound_theme_set_file(PurpleSoundTheme *theme,
 		const gchar *event,
--- a/libpurple/theme-loader.h	Thu Mar 12 03:52:54 2009 +0000
+++ b/libpurple/theme-loader.h	Thu Mar 12 03:54:11 2009 +0000
@@ -82,7 +82,8 @@
 /**
  * Creates a new PurpleTheme
  *
- * @param dir The directory containing the theme
+ * @param loader The theme loader
+ * @param dir    The directory containing the theme
  *
  * @returns A PurpleTheme containing the information from the directory
  */
--- a/libpurple/theme-manager.h	Thu Mar 12 03:52:54 2009 +0000
+++ b/libpurple/theme-manager.h	Thu Mar 12 03:54:11 2009 +0000
@@ -1,5 +1,5 @@
 /**
- * @file thememanager.h  Theme Manager API
+ * @file theme-manager.h  Theme Manager API
  */
 
 /*
--- a/pidgin/gtkblist-theme-loader.h	Thu Mar 12 03:52:54 2009 +0000
+++ b/pidgin/gtkblist-theme-loader.h	Thu Mar 12 03:54:11 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	Thu Mar 12 03:52:54 2009 +0000
+++ b/pidgin/gtkblist-theme.h	Thu Mar 12 03:54:11 2009 +0000
@@ -102,6 +102,8 @@
 /**
  * Returns the background color of the buddy list.
  *
+ * @param theme The 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 theme.
  * @param color The new background color.
  */
 void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, GdkColor *color);
@@ -225,6 +258,7 @@
 /**
  * Sets the opacity to be used for this buddy list theme.
  *
+ * @param theme The 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 theme.
  * @param layout The new layout.
  */
 void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, PidginBlistLayout *layout);
@@ -239,6 +274,7 @@
 /**
  * Sets the background color to be used for expanded groups.
  *
+ * @param theme The theme.
  * @param color The new background color.
  */
 void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, GdkColor *color);
@@ -246,13 +282,15 @@
 /**
  * Sets the text color and font to be used for expanded groups.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the background color to be used for collapsed groups.
  *
+ * @param theme The theme.
  * @param color The new background color.
  */
 void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, GdkColor *color);
@@ -260,13 +298,15 @@
 /**
  * Sets the text color and font to be used for expanded groups.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the background color to be used for contacts and chats.
  *
+ * @param theme The theme.
  * @param color The color to use for contacts and chats.
  */
 void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, GdkColor *color);
@@ -274,42 +314,48 @@
 /**
  * Sets the text color and font to be used for expanded contacts.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the text color and font to be used for online buddies.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the text color and font to be used for away and idle buddies.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the text color and font to be used for offline buddies.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the text color and font to be used for idle buddies.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the text color and font to be used for buddies with unread messages.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
@@ -317,14 +363,16 @@
  * Sets the text color and font to be used for a chat with unread messages
  * that mention your nick.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the text color and font to be used for buddy status messages.
  *
- * @param pair The new text font at color pair.
+ * @param theme The theme.
+ * @param pair The new text font and color pair.
  */
 void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
--- a/pidgin/gtkicon-theme-loader.h	Thu Mar 12 03:52:54 2009 +0000
+++ b/pidgin/gtkicon-theme-loader.h	Thu Mar 12 03:54:11 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	Thu Mar 12 03:52:54 2009 +0000
+++ b/pidgin/gtkicon-theme.h	Thu Mar 12 03:54:11 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
@@ -72,6 +72,7 @@
 /**
  * Returns a copy of the filename for the icon event or NULL if it is not set
  *
+ * @param theme     the theme
  * @param event		the pidgin icon event to look up
  *
  * @returns the filename of the icon event
@@ -82,6 +83,7 @@
 /**
  * Sets the filename for a given icon id, setting the icon to NULL will remove the icon from the theme
  *
+ * @param theme         the theme
  * @param icon_id		a string representing what the icon is to be used for
  * @param filename		the name of the file to be used for the given id
  */
--- a/pidgin/gtkstatus-icon-theme.h	Thu Mar 12 03:52:54 2009 +0000
+++ b/pidgin/gtkstatus-icon-theme.h	Thu Mar 12 03:54:11 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