Convert docs from doxygen to gtk-doc format for gtkaccount to gtkconvwin gtkdoc-conversion

Sun, 02 Feb 2014 16:24:04 +0530

author
Ankit Vani <a@nevitus.org>
date
Sun, 02 Feb 2014 16:24:04 +0530
branch
gtkdoc-conversion
changeset 35415
ba28be1a7611
parent 35414
8be0131619b8
child 35416
35c615531b2a

Convert docs from doxygen to gtk-doc format for gtkaccount to gtkconvwin

pidgin/gtkaccount.h file | annotate | diff | comparison | revisions
pidgin/gtkblist-theme-loader.h file | annotate | diff | comparison | revisions
pidgin/gtkblist-theme.h file | annotate | diff | comparison | revisions
pidgin/gtkblist.h file | annotate | diff | comparison | revisions
pidgin/gtkcertmgr.h file | annotate | diff | comparison | revisions
pidgin/gtkconn.h file | annotate | diff | comparison | revisions
pidgin/gtkconv-theme-loader.h file | annotate | diff | comparison | revisions
pidgin/gtkconv-theme.h file | annotate | diff | comparison | revisions
pidgin/gtkconv.h file | annotate | diff | comparison | revisions
pidgin/gtkconvwin.h file | annotate | diff | comparison | revisions
--- a/pidgin/gtkaccount.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkaccount.h	Sun Feb 02 16:24:04 2014 +0530
@@ -40,25 +40,32 @@
 G_BEGIN_DECLS
 
 /**
+ * pidgin_accounts_window_show:
+ *
  * Shows the accounts window.
  */
 void pidgin_accounts_window_show(void);
 
 /**
+ * pidgin_accounts_window_hide:
+ *
  * Hides the accounts window.
  */
 void pidgin_accounts_window_hide(void);
 
 /**
- * Shows an add/modify account dialog.
- *
+ * pidgin_account_dialog_show:
  * @type:    The type of dialog.
  * @account: The associated account, or %NULL for an Add dialog.
+ *
+ * Shows an add/modify account dialog.
  */
 void pidgin_account_dialog_show(PidginAccountDialogType type,
 								  PurpleAccount *account);
 
 /**
+ * pidgin_accounts_get_ui_ops:
+ *
  * Returns the GTK+ account UI ops
  *
  * Returns: The UI operations structure.
@@ -66,6 +73,8 @@
 PurpleAccountUiOps *pidgin_accounts_get_ui_ops(void);
 
 /**
+ * pidgin_accounts_get_handle:
+ *
  * Returns the gtkaccounts handle
  *
  * Returns: The handle to the GTK+ account system
@@ -73,11 +82,15 @@
 void *pidgin_accounts_get_handle(void);
 
 /**
+ * pidgin_accounts_init:
+ *
  * Initializes the GTK+ account system
  */
 void pidgin_accounts_init(void);
 
 /**
+ * pidgin_accounts_uninit:
+ *
  * Uninitializes the GTK+ account system
  */
 void pidgin_accounts_uninit(void);
--- a/pidgin/gtkblist-theme-loader.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkblist-theme-loader.h	Sun Feb 02 16:24:04 2014 +0530
@@ -30,12 +30,6 @@
 #include <glib-object.h>
 #include "theme-loader.h"
 
-/**
- * A pidgin buddy list theme loader. extends PurpleThemeLoader (theme-loader.h)
- * This is a class designed to build sound themes
- *
- * PidginBlistThemeLoader is a GObject.
- */
 typedef struct _PidginBlistThemeLoader        PidginBlistThemeLoader;
 typedef struct _PidginBlistThemeLoaderClass   PidginBlistThemeLoaderClass;
 
@@ -46,6 +40,12 @@
 #define PIDGIN_IS_BLIST_THEME_LOADER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME_LOADER))
 #define PIDGIN_BLIST_THEME_LOADER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME_LOADER, PidginBlistThemeLoaderClass))
 
+/**
+ * PidginBlistThemeLoader:
+ *
+ * A pidgin buddy list theme loader. extends PurpleThemeLoader (theme-loader.h)
+ * This is a class designed to build sound themes
+ */
 struct _PidginBlistThemeLoader
 {
 	PurpleThemeLoader parent;
@@ -62,6 +62,8 @@
 G_BEGIN_DECLS
 
 /**
+ * pidgin_blist_theme_loader_get_type:
+ *
  * GObject foo.
  * @internal.
  */
--- a/pidgin/gtkblist-theme.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkblist-theme.h	Sun Feb 02 16:24:04 2014 +0530
@@ -32,12 +32,6 @@
 
 #include "theme.h"
 
-/**
- * A pidgin buddy list theme.
- * This is an object for Purple to represent a buddy list theme.
- *
- * PidginBlistTheme is a PurpleTheme Object.
- */
 typedef struct _PidginBlistTheme        PidginBlistTheme;
 typedef struct _PidginBlistThemeClass   PidginBlistThemeClass;
 
@@ -48,6 +42,14 @@
 #define PIDGIN_IS_BLIST_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME))
 #define PIDGIN_BLIST_THEME_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))
 
+/**
+ * PidginBlistTheme:
+ *
+ * A pidgin buddy list theme.
+ * This is an object for Purple to represent a buddy list theme.
+ *
+ * PidginBlistTheme is a PurpleTheme Object.
+ */
 struct _PidginBlistTheme
 {
 	PurpleTheme parent;
@@ -86,60 +88,67 @@
 /**************************************************************************/
 
 /**
- * Create a new PidginThemeFont.
- *
+ * pidgin_theme_font_new:
  * @face:  The font face
  * @color: The color of the font
  *
+ * Create a new PidginThemeFont.
+ *
  * Returns: A newly created PidginThemeFont
  */
 PidginThemeFont * pidgin_theme_font_new(const gchar *face, GdkColor *color);
 
 /**
- * Frees a font and color pair
+ * pidgin_theme_font_free:
+ * @font: The theme font
  *
- * @font: The theme font
+ * Frees a font and color pair
  */
 void pidgin_theme_font_free(PidginThemeFont *font);
 
 /**
- * Set the font-face of a PidginThemeFont.
- *
+ * pidgin_theme_font_set_font_face:
  * @font:  The PidginThemeFont
  * @face:  The font-face
+ *
+ * Set the font-face of a PidginThemeFont.
  */
 void pidgin_theme_font_set_font_face(PidginThemeFont *font, const gchar *face);
 
 /**
- * Set the color of a PidginThemeFont.
- *
+ * pidgin_theme_font_set_color:
  * @font:  The PidginThemeFont
  * @color: The color
+ *
+ * Set the color of a PidginThemeFont.
  */
 void pidgin_theme_font_set_color(PidginThemeFont *font, const GdkColor *color);
 
 /**
- * Get the font-face of a PidginThemeFont.
+ * pidgin_theme_font_get_font_face:
+ * @font:  The PidginThemeFont
  *
- * @font:  The PidginThemeFont
+ * Get the font-face of a PidginThemeFont.
  *
  * Returns: The font-face, or NULL if none is set.
  */
 const gchar * pidgin_theme_font_get_font_face(PidginThemeFont *font);
 
 /**
- * Get the color of a PidginThemeFont as a GdkColor object.
+ * pidgin_theme_font_get_color:
+ * @font:  The PidginThemeFont
  *
- * @font:  The PidginThemeFont
+ * Get the color of a PidginThemeFont as a GdkColor object.
  *
  * Returns: The color, or NULL if none is set.
  */
 const GdkColor * pidgin_theme_font_get_color(PidginThemeFont *font);
 
 /**
- * Get the color of a PidginThemeFont.
+ * pidgin_theme_font_get_color_describe:
+ * @font:  The PidginThemeFont
  *
- * @font:  The PidginThemeFont
+ * Get the color of a PidginThemeFont.
  *
  * Returns: The color, or NULL if none is set.
  */
@@ -150,6 +159,8 @@
 /**************************************************************************/
 
 /**
+ * pidgin_blist_theme_get_type:
+ *
  * GObject foo.
  * @internal.
  */
@@ -158,146 +169,162 @@
 /* get methods */
 
 /**
- * Returns the background color of the buddy list.
+ * pidgin_blist_theme_get_background_color:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the background color of the buddy list.
  *
  * Returns: A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
 
 /**
+ * pidgin_blist_theme_get_opacity:
+ * @theme:  The PidginBlist theme.
+ *
  * Returns the opacity of the buddy list window
  * (0.0 or clear to 1.0 fully opaque).
  *
- * @theme:  The PidginBlist theme.
- *
  * Returns: The opacity
  */
 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
 
 /**
- * Returns the layout to be used with the buddy list.
+ * pidgin_blist_theme_get_layout:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the layout to be used with the buddy list.
  *
  * Returns: The buddy list layout.
  */
 PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
 
 /**
- * Returns the background color to be used with expanded groups.
+ * pidgin_blist_theme_get_expanded_background_color:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the background color to be used with expanded groups.
  *
  * Returns: A gdk color.
  */
 GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used with expanded groups.
+ * pidgin_blist_theme_get_expanded_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used with expanded groups.
  *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the background color to be used with collapsed groups.
+ * pidgin_blist_theme_get_collapsed_background_color:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the background color to be used with collapsed groups.
  *
  * Returns: A gdk color.
  */
 GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used with collapsed groups.
+ * pidgin_blist_theme_get_collapsed_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used with collapsed groups.
  *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the colors to be used for contacts and chats.
+ * pidgin_blist_theme_get_contact_color:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the colors to be used for contacts and chats.
  *
  * Returns: A gdkcolor for contacts and chats.
  */
 GdkColor *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for expanded contacts.
+ * pidgin_blist_theme_get_contact_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used for expanded contacts.
  *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for online buddies.
+ * pidgin_blist_theme_get_online_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used for online buddies.
  *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for away and idle buddies.
+ * pidgin_blist_theme_get_away_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used for away and idle buddies.
  *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for offline buddies.
+ * pidgin_blist_theme_get_offline_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used for offline buddies.
  *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for idle buddies.
+ * pidgin_blist_theme_get_idle_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used for idle buddies.
  *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for buddies with unread messages.
+ * pidgin_blist_theme_get_unread_message_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used for buddies with unread messages.
  *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme);
 
 /**
+ * pidgin_blist_theme_get_unread_message_nick_said_text_info:
+ * @theme:  The PidginBlist theme.
+ *
  * Returns the text font and color to be used for chats with unread messages
  * that mention your nick.
  *
- * @theme:  The PidginBlist theme.
- *
  * Returns: A font and color pair.
  */
 PidginThemeFont *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for a buddy's status message.
+ * pidgin_blist_theme_get_status_text_info:
+ * @theme:  The PidginBlist theme.
  *
- * @theme:  The PidginBlist theme.
+ * Returns the text font and color to be used for a buddy's status message.
  *
  * Returns: A font and color pair.
  */
@@ -306,131 +333,147 @@
 /* Set Methods */
 
 /**
- * Sets the background color to be used for this buddy list theme.
- *
+ * pidgin_blist_theme_set_background_color:
  * @theme:  The PidginBlist theme.
  * @color: The new background color.
+ *
+ * Sets the background color to be used for this buddy list theme.
  */
 void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, const GdkColor *color);
 
 /**
- * Sets the opacity to be used for this buddy list theme.
- *
+ * pidgin_blist_theme_set_opacity:
  * @theme:  The PidginBlist theme.
  * @opacity: The new opacity setting.
+ *
+ * Sets the opacity to be used for this buddy list theme.
  */
 void pidgin_blist_theme_set_opacity(PidginBlistTheme *theme, gdouble opacity);
 
 /**
- * Sets the buddy list layout to be used for this buddy list theme.
- *
+ * pidgin_blist_theme_set_layout:
  * @theme:  The PidginBlist theme.
  * @layout: The new layout.
+ *
+ * Sets the buddy list layout to be used for this buddy list theme.
  */
 void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, const PidginBlistLayout *layout);
 
 /**
- * Sets the background color to be used for expanded groups.
- *
+ * pidgin_blist_theme_set_expanded_background_color:
  * @theme:  The PidginBlist theme.
  * @color: The new background color.
+ *
+ * Sets the background color to be used for expanded groups.
  */
 void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, const GdkColor *color);
 
 /**
- * Sets the text color and font to be used for expanded groups.
- *
+ * pidgin_blist_theme_set_expanded_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for expanded groups.
  */
 void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
- * Sets the background color to be used for collapsed groups.
- *
+ * pidgin_blist_theme_set_collapsed_background_color:
  * @theme:  The PidginBlist theme.
  * @color: The new background color.
+ *
+ * Sets the background color to be used for collapsed groups.
  */
 void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, const GdkColor *color);
 
 /**
- * Sets the text color and font to be used for expanded groups.
- *
+ * pidgin_blist_theme_set_collapsed_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for expanded groups.
  */
 void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
- * Sets the background color to be used for contacts and chats.
- *
+ * pidgin_blist_theme_set_contact_color:
  * @theme:  The PidginBlist theme.
  * @color: The color to use for contacts and chats.
+ *
+ * Sets the background color to be used for contacts and chats.
  */
 void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, const GdkColor *color);
 
 /**
- * Sets the text color and font to be used for expanded contacts.
- *
+ * pidgin_blist_theme_set_contact_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for expanded contacts.
  */
 void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
- * Sets the text color and font to be used for online buddies.
- *
+ * pidgin_blist_theme_set_online_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for online buddies.
  */
 void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
- * Sets the text color and font to be used for away and idle buddies.
- *
+ * pidgin_blist_theme_set_away_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for away and idle buddies.
  */
 void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
- * Sets the text color and font to be used for offline buddies.
- *
+ * pidgin_blist_theme_set_offline_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for offline buddies.
  */
 void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
- * Sets the text color and font to be used for idle buddies.
- *
+ * pidgin_blist_theme_set_idle_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for idle buddies.
  */
 void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
- * Sets the text color and font to be used for buddies with unread messages.
- *
+ * pidgin_blist_theme_set_unread_message_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for buddies with unread messages.
  */
 void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
+ * pidgin_blist_theme_set_unread_message_nick_said_text_info:
+ * @theme:  The PidginBlist theme.
+ * @pair: The new text font and color pair.
+ *
  * Sets the text color and font to be used for a chat with unread messages
  * that mention your nick.
- *
- * @theme:  The PidginBlist theme.
- * @pair: The new text font and color pair.
  */
 void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 /**
- * Sets the text color and font to be used for buddy status messages.
- *
+ * pidgin_blist_theme_set_status_text_info:
  * @theme:  The PidginBlist theme.
  * @pair: The new text font and color pair.
+ *
+ * Sets the text color and font to be used for buddy status messages.
  */
 void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
--- a/pidgin/gtkblist.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkblist.h	Sun Feb 02 16:24:04 2014 +0530
@@ -27,7 +27,6 @@
 #ifndef _PIDGINBLIST_H_
 #define _PIDGINBLIST_H_
 
-/** @copydoc _PidginBuddyList */
 typedef struct _PidginBuddyList PidginBuddyList;
 
 enum {
@@ -66,55 +65,83 @@
  * @name Structures
  **************************************************************************/
 /**
+ * PidginBuddyList:
+ * @notebook:          The notebook that switches between the real buddy list
+ *                     and the helpful instructions page
+ * @main_vbox:         This vbox contains the menu and notebook
+ * @vbox:              This is the vbox that everything important gets packed
+ *                     into.  Your plugin might want to pack something in it
+ *                     itself.  Go, plugins!
+ * @treeview:          It's a treeview... d'uh.
+ * @treemodel:         This is the treemodel. 
+ * @text_column:       Column
+ * @menutray:          The menu tray widget.
+ * @menutrayicon:      The menu tray icon.
+ * @refresh_timer:     The timer for refreshing every 30 seconds
+ * @timeout:           The timeout for the tooltip.
+ * @drag_timeout:      The timeout for expanding contacts on drags
+ * @tip_rect:          This is the bounding rectangle of the cell we're
+ *                     currently hovering over.  This is used for tooltips.
+ * @contact_rect:      This is the bounding rectangle of the contact node and
+ *                     its children.  This is used for auto-expand on mouseover.
+ * @mouseover_contact: This is the contact currently mouse-over expanded
+ * @tipwindow:         The window used by the tooltip
+ * @tooltipdata:       The data for each "chunk" of the tooltip
+ * @selected_node:     The currently selected node
+ * @scrollbook:        Scrollbook for alerts
+ * @headline:          Widget for headline notifications
+ * @headline_label:    Label for headline notifications
+ * @headline_image:    Image for headline notifications
+ * @headline_callback: Callback for headline notifications
+ * @headline_data:     User data for headline notifications
+ * @headline_destroy:  Callback to use for destroying the headline-data
+ * @statusbox:         The status selector dropdown
+ * @empty_avatar:      A 32x32 transparent pixbuf
+ * @priv:              Pointer to opaque private data
+ *
  * Like, everything you need to know about the gtk buddy list
  */
 struct _PidginBuddyList {
 	GtkWidget *window;
-	GtkWidget *notebook;            /**< The notebook that switches between the real buddy list and the helpful
-					   instructions page */
-	GtkWidget *main_vbox;           /**< This vbox contains the menu and notebook */
-	GtkWidget *vbox;                /**< This is the vbox that everything important gets packed into.
-					   Your plugin might want to pack something in it itself.  Go, plugins! */
+	GtkWidget *notebook;
+	GtkWidget *main_vbox;
+	GtkWidget *vbox;
 
-	GtkWidget *treeview;            /**< It's a treeview... d'uh. */
-	GtkTreeStore *treemodel;        /**< This is the treemodel.  */
-	GtkTreeViewColumn *text_column; /**< Column */
+	GtkWidget *treeview;
+	GtkTreeStore *treemodel;
+	GtkTreeViewColumn *text_column;
 
 	GtkCellRenderer *text_rend;
 
 	GtkUIManager *ui;
-	GtkWidget *menutray;            /**< The menu tray widget. */
-	GtkWidget *menutrayicon;        /**< The menu tray icon. */
+	GtkWidget *menutray;
+	GtkWidget *menutrayicon;
 
-	guint refresh_timer;            /**< The timer for refreshing every 30 seconds */
+	guint refresh_timer;
 
-	guint      timeout;              /**< The timeout for the tooltip. */
-	guint      drag_timeout;         /**< The timeout for expanding contacts on drags */
-	GdkRectangle tip_rect;           /**< This is the bounding rectangle of the
-					      cell we're currently hovering over.  This is
-					      used for tooltips. */
-	GdkRectangle contact_rect;       /**< This is the bounding rectangle of the contact node
-					      and its children.  This is used for auto-expand on
-					      mouseover. */
-	PurpleBlistNode *mouseover_contact; /**< This is the contact currently mouse-over expanded */
+	guint      timeout;
+	guint      drag_timeout;
+	GdkRectangle tip_rect;
+	GdkRectangle contact_rect;
+	PurpleBlistNode *mouseover_contact;
+
+	GtkWidget *tipwindow;
+	GList *tooltipdata;
 
-	GtkWidget *tipwindow;            /**< The window used by the tooltip */
-	GList *tooltipdata;              /**< The data for each "chunk" of the tooltip */
-
-	PurpleBlistNode *selected_node;    /**< The currently selected node */
+	PurpleBlistNode *selected_node;
 
-	GtkWidget *scrollbook;          /**< Scrollbook for alerts */
-	GtkWidget *headline;            /**< Widget for headline notifications */
-	GtkWidget *headline_label;      /**< Label for headline notifications */
-	GtkWidget *headline_image;      /**< Image for headline notifications */
-	GCallback headline_callback;    /**< Callback for headline notifications */
-	gpointer headline_data;         /**< User data for headline notifications */
-	GDestroyNotify headline_destroy; /**< Callback to use for destroying the headline-data */
+	GtkWidget *scrollbook;
+	GtkWidget *headline;
+	GtkWidget *headline_label;
+	GtkWidget *headline_image;
+	GCallback headline_callback;
+	gpointer headline_data;
+	GDestroyNotify headline_destroy;
 
-	GtkWidget *statusbox;            /**< The status selector dropdown */
-	GdkPixbuf *empty_avatar;         /**< A 32x32 transparent pixbuf */
+	GtkWidget *statusbox;
+	GdkPixbuf *empty_avatar;
 
-	gpointer priv;                   /**< Pointer to opaque private data */
+	gpointer priv;
 };
 
 #define PIDGIN_BLIST(list) ((PidginBuddyList *)purple_blist_get_ui_data())
@@ -128,6 +155,8 @@
  **************************************************************************/
 
 /**
+ * pidgin_blist_get_handle:
+ *
  * Get the handle for the GTK+ blist system.
  *
  * Returns: the handle to the blist system
@@ -135,16 +164,22 @@
 void *pidgin_blist_get_handle(void);
 
 /**
+ * pidgin_blist_init:
+ *
  * Initializes the GTK+ blist system.
  */
 void pidgin_blist_init(void);
 
 /**
+ * pidgin_blist_uninit:
+ *
  * Uninitializes the GTK+ blist system.
  */
 void pidgin_blist_uninit(void);
 
 /**
+ * pidgin_blist_get_ui_ops:
+ *
  * Returns the UI operations structure for the buddy list.
  *
  * Returns: The GTK+ list operations structure.
@@ -152,6 +187,8 @@
 PurpleBlistUiOps *pidgin_blist_get_ui_ops(void);
 
 /**
+ * pidgin_blist_get_default_gtk_blist:
+ *
  * Returns the default gtk buddy list
  *
  * There's normally only one buddy list window, but that isn't a necessity. This function
@@ -163,19 +200,21 @@
 PidginBuddyList *pidgin_blist_get_default_gtk_blist(void);
 
 /**
- * Populates a menu with the items shown on the buddy list for a buddy.
- *
+ * pidgin_blist_make_buddy_menu:
  * @menu:  The menu to populate
  * @buddy: The buddy whose menu to get
- * @sub:   TRUE if this is a sub-menu, FALSE otherwise
+ * @sub:   %TRUE if this is a sub-menu, %FALSE otherwise
+ *
+ * Populates a menu with the items shown on the buddy list for a buddy.
  */
 void pidgin_blist_make_buddy_menu(GtkWidget *menu, PurpleBuddy *buddy, gboolean sub);
 
 /**
+ * pidgin_blist_refresh:
+ * @list:   This is the core list that gets updated from
+ *
  * Refreshes all the nodes of the buddy list.
  * This should only be called when something changes to affect most of the nodes (such as a ui preference changing)
- *
- * @list:   This is the core list that gets updated from
  */
 void pidgin_blist_refresh(PurpleBuddyList *list);
 
@@ -183,36 +222,43 @@
 void pidgin_blist_update_refresh_timeout(void);
 
 /**
+ * pidgin_blist_get_emblem:
+ * @node:   The node to return an emblem for
+ *
  * Returns the blist emblem.
  *
  * This may be an existing pixbuf that has been given an additional ref,
  * so it shouldn't be modified.
  *
- * @node:   The node to return an emblem for
- *
  * Returns:  A GdkPixbuf for the emblem to show, or NULL
  */
 GdkPixbuf *
 pidgin_blist_get_emblem(PurpleBlistNode *node);
 
 /**
+ * pidgin_blist_get_status_icon:
+ *
  * Useful for the buddy ticker
  */
 GdkPixbuf *pidgin_blist_get_status_icon(PurpleBlistNode *node,
 		PidginStatusIconSize size);
 
 /**
- * Returns a boolean indicating if @a node is part of an expanded contact.
+ * pidgin_blist_node_is_contact_expanded:
+ * @node: The node in question.
+ *
+ * Returns a boolean indicating if @node is part of an expanded contact.
  *
  * This only makes sense for contact and buddy nodes. %FALSE is returned
  * for other types of nodes.
  *
- * @node: The node in question.
- * Returns: A boolean indicating if @a node is part of an expanded contact.
+ * Returns: A boolean indicating if @node is part of an expanded contact.
  */
 gboolean pidgin_blist_node_is_contact_expanded(PurpleBlistNode *node);
 
 /**
+ * pidgin_blist_toggle_visibility:
+ *
  * Intelligently toggles the visibility of the buddy list. If the buddy
  * list is obscured, it is brought to the front. If it is not obscured,
  * it is hidden. If it is hidden it is shown.
@@ -220,6 +266,8 @@
 void pidgin_blist_toggle_visibility(void);
 
 /**
+ * pidgin_blist_visibility_manager_add:
+ *
  * Increases the reference count of visibility managers. Callers should
  * call the complementary remove function when no longer managing
  * visibility.
@@ -230,26 +278,32 @@
 void pidgin_blist_visibility_manager_add(void);
 
 /**
+ * pidgin_blist_visibility_manager_remove:
+ *
  * Decreases the reference count of visibility managers. If the count
  * drops below zero, the buddy list is shown.
  */
 void pidgin_blist_visibility_manager_remove(void);
 
 /**
- * Adds a mini-alert to the blist scrollbook
+ * pidgin_blist_add_alert:
+ * @widget:   The widget to add
  *
- * @widget:   The widget to add
+ * Adds a mini-alert to the blist scrollbook
  */
 void pidgin_blist_add_alert(GtkWidget *widget);
 
 /**
- * Sets the current theme for Pidgin to use
+ * pidgin_blist_set_theme:
+ * @theme:	the new theme to use
  *
- * @theme:	the new theme to use
+ * Sets the current theme for Pidgin to use
  */
 void pidgin_blist_set_theme(PidginBlistTheme *theme);
 
 /**
+ * pidgin_blist_get_theme:
+ *
  * Gets Pidgin's current buddy list theme
  *
  * Returns:	the current theme
@@ -263,6 +317,8 @@
 typedef void (*pidgin_blist_sort_function)(PurpleBlistNode *new, PurpleBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur, GtkTreeIter *iter);
 
 /**
+ * pidgin_blist_get_sort_methods:
+ *
  * Gets the current list of sort methods.
  *
  * Returns: A GSlist of sort methods
@@ -278,50 +334,62 @@
 typedef struct pidgin_blist_sort_method PidginBlistSortMethod;
 
 /**
- * Registers a buddy list sorting method.
- *
+ * pidgin_blist_sort_method_reg:
  * @id:   The unique ID of the sorting method
  * @name: The method's name.
  * @func:  A pointer to the function.
  *
+ * Registers a buddy list sorting method.
  */
 void pidgin_blist_sort_method_reg(const char *id, const char *name, pidgin_blist_sort_function func);
 
 /**
- * Unregisters a buddy list sorting method.
+ * pidgin_blist_sort_method_unreg:
+ * @id: The method's id
  *
- * @id: The method's id
+ * Unregisters a buddy list sorting method.
  */
 void pidgin_blist_sort_method_unreg(const char *id);
 
 /**
- * Sets a buddy list sorting method.
+ * pidgin_blist_sort_method_set:
+ * @id: The method's id.
  *
- * @id: The method's id.
+ * Sets a buddy list sorting method.
  */
 void pidgin_blist_sort_method_set(const char *id);
 
 /**
+ * pidgin_blist_setup_sort_methods:
+ *
  * Sets up the programs default sort methods
  */
 void pidgin_blist_setup_sort_methods(void);
 
 /**
+ * pidgin_blist_update_accounts_menu:
+ *
  * Updates the accounts menu on the GTK+ buddy list window.
  */
 void pidgin_blist_update_accounts_menu(void);
 
 /**
+ * pidgin_blist_update_plugin_actions:
+ *
  * Updates the plugin actions menu on the GTK+ buddy list window.
  */
 void pidgin_blist_update_plugin_actions(void);
 
 /**
+ * pidgin_blist_update_sort_methods:
+ *
  * Updates the Sorting menu on the GTK+ buddy list window.
  */
 void pidgin_blist_update_sort_methods(void);
 
 /**
+ * pidgin_blist_joinchat_is_showable:
+ *
  * Determines if showing the join chat dialog is a valid action.
  *
  * Returns: Returns TRUE if there are accounts online capable of
@@ -330,65 +398,79 @@
 gboolean pidgin_blist_joinchat_is_showable(void);
 
 /**
+ * pidgin_blist_joinchat_show:
+ *
  * Shows the join chat dialog.
  */
 void pidgin_blist_joinchat_show(void);
 
 /**
+ * pidgin_append_blist_node_privacy_menu:
+ *
  * Appends the privacy menu items for a PurpleBlistNode
- * TODO: Rename these.
+ * @todo Rename these.
  */
 void pidgin_append_blist_node_privacy_menu(GtkWidget *menu, PurpleBlistNode *node);
 
 /**
+ * pidgin_append_blist_node_proto_menu:
+ *
  * Appends the protocol specific menu items for a PurpleBlistNode
- * TODO: Rename these.
+ * @todo Rename these.
  */
 void pidgin_append_blist_node_proto_menu (GtkWidget *menu, PurpleConnection *gc, PurpleBlistNode *node);
 
 /**
+ * pidgin_append_blist_node_extended_menu:
+ *
  * Appends the extended menu items for a PurpleBlistNode
- * TODO: Rename these.
+ * @todo Rename these.
  */
 void pidgin_append_blist_node_extended_menu(GtkWidget *menu, PurpleBlistNode *node);
 
 /**
- * Sets a headline notification
- *
- * This is currently used for mail notification, but could theoretically be used for anything.
- * Only the most recent headline will be shown.
- *
+ * pidgin_blist_set_headline:
  * @text:	    Pango Markup for the label text
  * @pixbuf:    The GdkPixbuf for the icon
  * @callback:  The callback to call when headline is clicked
  * @user_data: The userdata to include in the callback
  * @destroy:   The callback to call when headline is closed or replaced by another headline.
+ *
+ * Sets a headline notification
+ *
+ * This is currently used for mail notification, but could theoretically be used for anything.
+ * Only the most recent headline will be shown.
  */
 void pidgin_blist_set_headline(const char *text, GdkPixbuf *pixbuf, GCallback callback, gpointer user_data,
 		GDestroyNotify destroy);
 
 /**
- * Returns a buddy's Pango markup appropriate for setting in a GtkCellRenderer.
- *
+ * pidgin_blist_get_name_markup:
  * @buddy: The buddy to return markup from
  * @selected:  Whether this buddy is selected. If TRUE, the markup will not change the color.
  * @aliased:  TRUE to return the appropriate alias of this buddy, FALSE to return its username and status information
+ *
+ * Returns a buddy's Pango markup appropriate for setting in a GtkCellRenderer.
+ *
  * Returns: The markup for this buddy
  */
 gchar *pidgin_blist_get_name_markup(PurpleBuddy *buddy, gboolean selected, gboolean aliased);
 
 /**
+ * pidgin_blist_draw_tooltip:
+ * @node: The buddy list node to show a tooltip for
+ * @widget: The widget to draw the tooltip on
+ *
  * Creates the Buddy List tooltip at the current pointer location for the given buddy list node.
  *
  * This tooltip will be destroyed the next time this function is called, or when XXXX
  * is called
- *
- * @node: The buddy list node to show a tooltip for
- * @widget: The widget to draw the tooltip on
  */
 void pidgin_blist_draw_tooltip(PurpleBlistNode *node, GtkWidget *widget);
 
 /**
+ * pidgin_blist_tooltip_destroy:
+ *
  * Destroys the current (if any) Buddy List tooltip
  */
 void pidgin_blist_tooltip_destroy(void);
--- a/pidgin/gtkcertmgr.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkcertmgr.h	Sun Feb 02 16:24:04 2014 +0530
@@ -34,6 +34,8 @@
 typedef struct _PidginCertificateManager PidginCertificateManager;
 
 /**
+ * PidginCertificateManager:
+ *
  * GTK+ Certificate Manager subwidget
  */
 struct _PidginCertificateManager {
@@ -50,11 +52,15 @@
 /**************************************************************************/
 /*@{*/
 /**
+ * pidgin_certmgr_show:
+ *
  * Show the certificate manager window
  */
 void pidgin_certmgr_show(void);
 
 /**
+ * pidgin_certmgr_hide:
+ *
  * Hide the certificate manager window
  */
 void pidgin_certmgr_hide(void);
--- a/pidgin/gtkconn.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkconn.h	Sun Feb 02 16:24:04 2014 +0530
@@ -33,6 +33,8 @@
 /*@{*/
 
 /**
+ * pidgin_connections_get_ui_ops:
+ *
  * Gets GTK+ Connection UI ops
  *
  * Returns: UI operations struct
@@ -42,6 +44,8 @@
 /*@}*/
 
 /**
+ * pidgin_connection_get_handle:
+ *
  * Returns the GTK+ connection handle.
  *
  * Returns: The handle to the GTK+ connection system.
@@ -49,11 +53,15 @@
 void *pidgin_connection_get_handle(void);
 
 /**
+ * pidgin_connection_init:
+ *
  * Initializes the GTK+ connection system.
  */
 void pidgin_connection_init(void);
 
 /**
+ * pidgin_connection_uninit:
+ *
  * Uninitializes the GTK+ connection system.
  */
 void pidgin_connection_uninit(void);
--- a/pidgin/gtkconv-theme-loader.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkconv-theme-loader.h	Sun Feb 02 16:24:04 2014 +0530
@@ -30,12 +30,6 @@
 #include <glib-object.h>
 #include "theme-loader.h"
 
-/**
- * A pidgin conversation theme loader. Extends PurpleThemeLoader (theme-loader.h)
- * This is a class designed to build conversation themes
- *
- * PidginConvThemeLoader is a GObject.
- */
 typedef struct _PidginConvThemeLoader       PidginConvThemeLoader;
 typedef struct _PidginConvThemeLoaderClass  PidginConvThemeLoaderClass;
 
@@ -46,6 +40,12 @@
 #define PIDGIN_IS_CONV_THEME_LOADER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_CONV_THEME_LOADER))
 #define PIDGIN_CONV_THEME_LOADER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_CONV_THEME_LOADER, PidginConvThemeLoaderClass))
 
+/**
+ * PidginConvThemeLoader:
+ *
+ * A pidgin conversation theme loader. Extends PurpleThemeLoader (theme-loader.h)
+ * This is a class designed to build conversation themes
+ */
 struct _PidginConvThemeLoader
 {
 	PurpleThemeLoader parent;
@@ -62,6 +62,8 @@
 G_BEGIN_DECLS
 
 /**
+ * pidgin_conversation_theme_loader_get_type:
+ *
  * GObject foo.
  * @internal.
  */
--- a/pidgin/gtkconv-theme.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkconv-theme.h	Sun Feb 02 16:24:04 2014 +0530
@@ -31,13 +31,6 @@
 #include "conversation.h"
 #include "theme.h"
 
-/**
- * extends PurpleTheme (theme.h)
- * A pidgin icon theme.
- * This object represents a Pidgin icon theme.
- *
- * PidginConvTheme is a PurpleTheme Object.
- */
 typedef struct _PidginConvTheme        PidginConvTheme;
 typedef struct _PidginConvThemeClass   PidginConvThemeClass;
 
@@ -48,6 +41,15 @@
 #define PIDGIN_IS_CONV_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_CONV_THEME))
 #define PIDGIN_CONV_THEME_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_CONV_THEME, PidginConvThemeClass))
 
+/**
+ * PidginConvTheme:
+ *
+ * extends PurpleTheme (theme.h)
+ * A pidgin icon theme.
+ * This object represents a Pidgin icon theme.
+ *
+ * PidginConvTheme is a PurpleTheme Object.
+ */
 struct _PidginConvTheme
 {
 	PurpleTheme parent;
@@ -83,15 +85,18 @@
 G_BEGIN_DECLS
 
 /**
+ * pidgin_conversation_theme_get_type:
+ *
  * GObject foo.
  * @internal.
  */
 GType pidgin_conversation_theme_get_type(void);
 
 /**
- * Get the Info.plist hash table from a conversation theme.
+ * pidgin_conversation_theme_get_info:
+ * @theme: The conversation theme
  *
- * @theme: The conversation theme
+ * Get the Info.plist hash table from a conversation theme.
  *
  * Returns: The hash table. Keys are strings as outlined for message styles,
  *         values are GValue*s. This is an internal structure. Take a ref if
@@ -100,73 +105,78 @@
 const GHashTable *pidgin_conversation_theme_get_info(const PidginConvTheme *theme);
 
 /**
- * Set the Info.plist hash table for a conversation theme.
- *
+ * pidgin_conversation_theme_set_info:
  * @theme: The conversation theme
  * @info:  The new hash table. The theme will take ownership of this hash
  *              table. Do not use it yourself afterwards with holding a ref.
- *              For key and value specifications, @see pidgin_conversation_theme_get_info.
+ *              For key and value specifications, see pidgin_conversation_theme_get_info().
  *
+ * Set the Info.plist hash table for a conversation theme.
  */
 void pidgin_conversation_theme_set_info(PidginConvTheme *theme, GHashTable *info);
 
 /**
- * Lookup a key in a theme
- *
+ * pidgin_conversation_theme_lookup:
  * @theme:    The conversation theme
  * @key:      The key to find
  * @specific: Whether to search variant-specific keys
  *
- * Returns: The key information. If @a specific is %TRUE, then keys are first
+ * Lookup a key in a theme
+ *
+ * Returns: The key information. If @specific is %TRUE, then keys are first
  *         searched by variant, then by general ones. Otherwise, only general
  *         key values are returned.
  */
 const GValue *pidgin_conversation_theme_lookup(PidginConvTheme *theme, const char *key, gboolean specific);
 
 /**
- * Get the template data from a conversation theme.
- *
+ * pidgin_conversation_theme_get_template:
  * @theme: The conversation theme
  * @type:  The type of template data
  *
+ * Get the template data from a conversation theme.
+ *
  * Returns: The template data requested. Fallback is made as required by styles.
  *         Subsequent calls to this function will return cached values.
  */
 const char *pidgin_conversation_theme_get_template(PidginConvTheme *theme, PidginConvThemeTemplateType type);
 
 /**
- * Add an available variant name to a conversation theme.
- *
+ * pidgin_conversation_theme_add_variant:
  * @theme:   The conversation theme
  * @variant: The name of the variant
  *
- * @Note The conversation theme will take ownership of the variant name string.
+ * Add an available variant name to a conversation theme.
+ *
+ * Note: The conversation theme will take ownership of the variant name string.
  *       This function should normally only be called by the theme loader.
  */
 void pidgin_conversation_theme_add_variant(PidginConvTheme *theme, char *variant);
 
 /**
- * Get the currently set variant name for a conversation theme.
+ * pidgin_conversation_theme_get_variant:
+ * @theme: The conversation theme
  *
- * @theme: The conversation theme
+ * Get the currently set variant name for a conversation theme.
  *
  * Returns: The current variant name.
  */
 const char *pidgin_conversation_theme_get_variant(PidginConvTheme *theme);
 
 /**
- * Set the variant name for a conversation theme.
- *
+ * pidgin_conversation_theme_set_variant:
  * @theme:   The conversation theme
  * @variant: The name of the variant
  *
+ * Set the variant name for a conversation theme.
  */
 void pidgin_conversation_theme_set_variant(PidginConvTheme *theme, const char *variant);
 
 /**
- * Get a list of available variants for a conversation theme.
+ * pidgin_conversation_theme_get_variants:
+ * @theme: The conversation theme
  *
- * @theme: The conversation theme
+ * Get a list of available variants for a conversation theme.
  *
  * Returns: The list of variants. This GList and the string data are owned by
  *         the theme and should not be freed by the caller.
@@ -174,32 +184,36 @@
 const GList *pidgin_conversation_theme_get_variants(PidginConvTheme *theme);
 
 /**
- * Get the path to the template HTML file.
+ * pidgin_conversation_theme_get_template_path:
+ * @theme: The conversation theme
  *
- * @theme: The conversation theme
+ * Get the path to the template HTML file.
  *
  * Returns: The path to the HTML file.
  */
 char *pidgin_conversation_theme_get_template_path(PidginConvTheme *theme);
 
 /**
- * Get the path to the current variant CSS file.
+ * pidgin_conversation_theme_get_css_path:
+ * @theme: The conversation theme
  *
- * @theme: The conversation theme
+ * Get the path to the current variant CSS file.
  *
  * Returns: The path to the CSS file.
  */
 char *pidgin_conversation_theme_get_css_path(PidginConvTheme *theme);
 
 /**
- * Get (and reference) the array of nick colors
+ * pidgin_conversation_theme_get_nick_colors:
+ * @theme: The conversation theme
  *
- * @theme: The conversation theme
+ * Get (and reference) the array of nick colors
  *
  * Returns: Pointer to GArray of nick colors, or NULL if no colors in theme
  */
 GArray *pidgin_conversation_theme_get_nick_colors(PidginConvTheme *theme);
 
 G_END_DECLS
+
 #endif /* PIDGIN_CONV_THEME_H */
 
--- a/pidgin/gtkconv.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkconv.h	Sun Feb 02 16:24:04 2014 +0530
@@ -32,15 +32,22 @@
 typedef struct _PidginConversation PidginConversation;
 
 /**
+ * PidginUnseenState:
+ * @PIDGIN_UNSEEN_NONE:   No unseen text in the conversation.
+ * @PIDGIN_UNSEEN_EVENT:  Unseen events in the conversation.
+ * @PIDGIN_UNSEEN_NO_LOG: Unseen text with NO_LOG flag.
+ * @PIDGIN_UNSEEN_TEXT:   Unseen text in the conversation.
+ * @PIDGIN_UNSEEN_NICK:   Unseen text and the nick was said.
+ *
  * Unseen text states.
  */
 typedef enum
 {
-	PIDGIN_UNSEEN_NONE,   /**< No unseen text in the conversation. */
-	PIDGIN_UNSEEN_EVENT,  /**< Unseen events in the conversation.  */
-	PIDGIN_UNSEEN_NO_LOG, /**< Unseen text with NO_LOG flag.       */
-	PIDGIN_UNSEEN_TEXT,   /**< Unseen text in the conversation.    */
-	PIDGIN_UNSEEN_NICK    /**< Unseen text and the nick was said.  */
+	PIDGIN_UNSEEN_NONE,
+	PIDGIN_UNSEEN_EVENT,
+	PIDGIN_UNSEEN_NO_LOG,
+	PIDGIN_UNSEEN_TEXT,
+	PIDGIN_UNSEEN_NICK
 } PidginUnseenState;
 
 enum {
@@ -73,11 +80,8 @@
 /*@{*/
 
 /**
- * A GTK+ representation of a graphical window containing one or more
- * conversations.
- */
-
-/**
+ * PidginConversation:
+ *
  * A GTK+ conversation pane.
  */
 struct _PidginConversation
@@ -137,7 +141,7 @@
 	int attach_timer;
 	GList *attach_current;
 
-	/**
+	/*
 	 * Quick Find.
 	 */
 	GtkWidget *quickfind_entry;
@@ -154,6 +158,8 @@
 /*@{*/
 
 /**
+ * pidgin_conversations_get_conv_ui_ops:
+ *
  * Returns the UI operations structure for GTK+ conversations.
  *
  * Returns: The GTK+ conversation operations structure.
@@ -161,6 +167,8 @@
 PurpleConversationUiOps *pidgin_conversations_get_conv_ui_ops(void);
 
 /**
+ * pidgin_conversations_get_default_theme:
+ *
  * Returns the default theme for GTK+ conversations.
  *
  * Returns: The default GTK+ conversation theme.
@@ -168,27 +176,36 @@
 PurpleTheme *pidgin_conversations_get_default_theme(void);
 
 /**
- * Updates the buddy icon on a conversation.
+ * pidgin_conv_update_buddy_icon:
+ * @im: The IM conversation.
  *
- * @conv: The conversation.
+ * Updates the buddy icon on a conversation.
  */
 void pidgin_conv_update_buddy_icon(PurpleIMConversation *im);
 
 /**
- * Sets the active conversation within a GTK-conversation.
+ * pidgin_conv_switch_active_conversation:
+ * @conv: The conversation
  *
- * @conv: The conversation
+ * Sets the active conversation within a GTK-conversation.
  */
 void pidgin_conv_switch_active_conversation(PurpleConversation *conv);
 
 /**
- * Updates conversation buttons by protocol.
+ * pidgin_conv_update_buttons_by_protocol:
+ * @conv: The conversation.
  *
- * @conv: The conversation.
+ * Updates conversation buttons by protocol.
  */
 void pidgin_conv_update_buttons_by_protocol(PurpleConversation *conv);
 
 /**
+ * pidgin_conversations_get_unseen_all:
+ * @min_state:    The minimum unseen state.
+ * @hidden_only:  If TRUE, only consider hidden conversations.
+ * @max_count:    Maximum number of conversations to return, or 0 for
+ *                     no maximum.
+ *
  * Returns a list of conversations of any type which have an unseen
  * state greater than or equal to the specified minimum state. Using the
  * hidden_only parameter, this search can be limited to hidden
@@ -196,11 +213,7 @@
  * converations returned if greater than zero. The returned list should
  * be freed by the caller.
  *
- * @min_state:    The minimum unseen state.
- * @hidden_only:  If TRUE, only consider hidden conversations.
- * @max_count:    Maximum number of conversations to return, or 0 for
- *                     no maximum.
- * Returns:             List of PurpleConversation matching criteria, or NULL.
+ * Returns:             List of PurpleConversation matching criteria, or %NULL.
  */
 GList *
 pidgin_conversations_get_unseen_all(PidginUnseenState min_state,
@@ -208,6 +221,12 @@
 										guint max_count);
 
 /**
+ * pidgin_conversations_get_unseen_ims:
+ * @min_state:    The minimum unseen state.
+ * @hidden_only:  If TRUE, only consider hidden conversations.
+ * @max_count:    Maximum number of conversations to return, or 0 for
+ *                     no maximum.
+ *
  * Returns a list of IM conversations which have an unseen state greater
  * than or equal to the specified minimum state. Using the hidden_only
  * parameter, this search can be limited to hidden IM conversations. The
@@ -215,12 +234,8 @@
  * returned if greater than zero. The returned list should be freed by the
  * caller.
  *
- * @min_state:    The minimum unseen state.
- * @hidden_only:  If TRUE, only consider hidden conversations.
- * @max_count:    Maximum number of conversations to return, or 0 for
- *                     no maximum.
  * Returns:             List of PurpleIMConversation matching criteria,
- *                     or NULL.
+ *                     or %NULL.
  */
 GList *
 pidgin_conversations_get_unseen_ims(PidginUnseenState min_state,
@@ -228,6 +243,12 @@
 										guint max_count);
 
 /**
+ * pidgin_conversations_get_unseen_chats:
+ * @min_state:    The minimum unseen state.
+ * @hidden_only:  If TRUE, only consider hidden conversations.
+ * @max_count:    Maximum number of conversations to return, or 0 for
+ *                     no maximum.
+ *
  * Returns a list of chat conversations which have an unseen state greater
  * than or equal to the specified minimum state. Using the hidden_only
  * parameter, this search can be limited to hidden chat conversations. The
@@ -235,10 +256,6 @@
  * returned if greater than zero. The returned list should be freed by the
  * caller.
  *
- * @min_state:    The minimum unseen state.
- * @hidden_only:  If TRUE, only consider hidden conversations.
- * @max_count:    Maximum number of conversations to return, or 0 for
- *                     no maximum.
  * Returns:             List of PurpleChatConversation matching criteria,
  *                     or NULL.
  */
@@ -248,27 +265,31 @@
 										guint max_count);
 
 /**
+ * pidgin_conversations_fill_menu:
+ * @menu:   Menu widget to add items to.
+ * @convs:  List of PurpleConversation to add to menu.
+ *
  * Fill a menu with a list of conversations. Clicking the conversation
  * menu item will present that conversation to the user.
  *
- * @menu:   Menu widget to add items to.
- * @convs:  List of PurpleConversation to add to menu.
  * Returns:       Number of conversations added to menu.
  */
 guint
 pidgin_conversations_fill_menu(GtkWidget *menu, GList *convs);
 
 /**
- * Presents a purple conversation to the user.
+ * pidgin_conv_present_conversation:
+ * @conv: The conversation.
  *
- * @conv: The conversation.
+ * Presents a purple conversation to the user.
  */
 void pidgin_conv_present_conversation(PurpleConversation *conv);
 
 /**
- * Reattach Pidgin UI to a conversation.
+ * pidgin_conv_attach_to_conversation:
+ * @conv:  The conversation.
  *
- * @conv:  The conversation.
+ * Reattach Pidgin UI to a conversation.
  *
  * Returns:  Wheter Pidgin UI was successfully attached.
  */
@@ -287,6 +308,8 @@
 /*@{*/
 
 /**
+ * pidgin_conversations_get_handle:
+ *
  * Returns the gtk conversations subsystem handle.
  *
  * Returns: The conversations subsystem handle.
@@ -294,11 +317,15 @@
 void *pidgin_conversations_get_handle(void);
 
 /**
+ * pidgin_conversations_init:
+ *
  * Initializes the GTK+ conversations subsystem.
  */
 void pidgin_conversations_init(void);
 
 /**
+ * pidgin_conversations_uninit:
+ *
  * Uninitialized the GTK+ conversation subsystem.
  */
 void pidgin_conversations_uninit(void);
--- a/pidgin/gtkconvwin.h	Sun Feb 02 15:51:15 2014 +0530
+++ b/pidgin/gtkconvwin.h	Sun Feb 02 16:24:04 2014 +0530
@@ -74,15 +74,21 @@
 };
 
 /**
+ * PidginWindow:
+ * @window:        The window.
+ * @notebook:      The notebook of conversations.
+ * @notebook_menu: The menu on the notebook.
+ * @clicked_tab:   The menu currently clicked.
+ *
  * A GTK+ representation of a graphical window containing one or more
  * conversations.
  */
 struct _PidginWindow
 {
-	GtkWidget *window;           /**< The window.                      */
-	GtkWidget *notebook;         /**< The notebook of conversations.   */
-	GtkWidget *notebook_menu;    /**< The menu on the notebook.        */
-	PidginConversation *clicked_tab; /**< The menu currently clicked.      */
+	GtkWidget *window;
+	GtkWidget *notebook;
+	GtkWidget *notebook_menu;
+	PidginConversation *clicked_tab;
 	GList *gtkconvs;
 
 	PidginWindowMenu *menu;

mercurial