cpw.darkrain42.docs: 799f7ce5: Fix more `make docs` warnings
paul at darkrain42.org
paul at darkrain42.org
Sun Mar 22 23:11:01 EDT 2009
-----------------------------------------------------------------
Revision: 799f7ce56a35bead71cb3a40f6b3d4fa1c273a1c
Ancestor: 32bb9bd20e1c43f7114c55c19bbdb65d9572bdc6
Author: paul at darkrain42.org
Date: 2009-03-12T03:54:11
Branch: im.pidgin.cpw.darkrain42.docs
URL: http://d.pidgin.im/viewmtn/revision/info/799f7ce56a35bead71cb3a40f6b3d4fa1c273a1c
Modified 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
ChangeLog:
Fix more `make docs` warnings
-------------- next part --------------
============================================================
--- libpurple/sound-theme.h 5a2ad6c76c3e9a8c211e35e3913525e2c3cfd514
+++ libpurple/sound-theme.h d6e1850e4cd92ead2ac39ab8dca7ce6874f4bb60
@@ -73,6 +73,7 @@ GType purple_sound_theme_get_type(void);
/**
* 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 @@ const gchar *purple_sound_theme_get_file
/**
* 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 @@ gchar *purple_sound_theme_get_file_full(
/**
* 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,
============================================================
--- libpurple/theme-loader.h 5ed3c1de4188eb6ad780578bd24832895652c36e
+++ libpurple/theme-loader.h 5f9fbe816ddf22a87e477415130ce111e5c96427
@@ -82,7 +82,8 @@ const gchar *purple_theme_loader_get_typ
/**
* 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
*/
============================================================
--- libpurple/theme-manager.h ae1a85a314c392cda5ddba85f1d41cd6aaf84865
+++ libpurple/theme-manager.h 7f2246c929ad0ca0a94699cd419eaa40dff49202
@@ -1,5 +1,5 @@
/**
- * @file thememanager.h Theme Manager API
+ * @file theme-manager.h Theme Manager API
*/
/*
============================================================
--- 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 5761cb1114a3795464d7efa76a2416628853de12
+++ pidgin/gtkblist-theme.h 64ddb819d816cbca0ea9769603a83626d3bb68d9
@@ -102,6 +102,8 @@ GType pidgin_blist_theme_get_type(void);
/**
* 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 @@ 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 theme.
* @param color The new background color.
*/
void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, 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 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 theme.
* @param layout The new layout.
*/
void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, 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 theme.
* @param color The new background color.
*/
void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, GdkColor *color);
@@ -246,13 +282,15 @@ void pidgin_blist_theme_set_expanded_bac
/**
* 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 @@ void pidgin_blist_theme_set_collapsed_ba
/**
* 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 @@ void pidgin_blist_theme_set_contact_colo
/**
* 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 @@ 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 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);
============================================================
--- 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 2c92e56d150c04b73756b3884ea931c9a82eda5b
@@ -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 @@ GType pidgin_icon_theme_get_type(void);
/**
* 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 @@ const gchar *pidgin_icon_theme_get_icon(
/**
* 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
*/
============================================================
--- 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