From 6bca794a31edb09313651e06cfc3449aef60083b Mon Sep 17 00:00:00 2001 From: Ankit Vani Date: Sun, 2 Feb 2014 16:55:09 +0530 Subject: Convert docs from doxygen to gtk-doc format for gtkdebug to gtksmiley --- pidgin/gtkdebug.h | 12 +++++++++++ pidgin/gtkdnd-hints.h | 48 +++++++++++++++++++++++++++++-------------- pidgin/gtkdocklet.h | 2 ++ pidgin/gtkeventloop.h | 2 ++ pidgin/gtkicon-theme-loader.h | 15 ++++++++------ pidgin/gtkicon-theme.h | 29 ++++++++++++++++---------- pidgin/gtkidle.h | 2 ++ pidgin/gtklog.h | 39 +++++++++++++++++++++++++---------- pidgin/gtkmenutray.h | 38 ++++++++++++++++++++++------------ pidgin/gtknotify.h | 19 +++++++++++++---- pidgin/gtkpluginpref.h | 4 +++- pidgin/gtkpounce.h | 13 ++++++++++-- pidgin/gtkprefs.h | 39 +++++++++++++++++++++++------------ pidgin/gtkprivacy.h | 24 ++++++++++++++-------- pidgin/gtkrequest.h | 13 ++++++++++-- pidgin/gtkroomlist.h | 11 ++++++++-- pidgin/gtksavedstatuses.h | 33 ++++++++++++++++++++--------- pidgin/gtksession.h | 9 +++++--- pidgin/gtksmiley.h | 41 ++++++++++++++++++++++++------------ 19 files changed, 279 insertions(+), 114 deletions(-) (limited to 'pidgin') diff --git a/pidgin/gtkdebug.h b/pidgin/gtkdebug.h index a8ec851d39..f44a3556f0 100644 --- a/pidgin/gtkdebug.h +++ b/pidgin/gtkdebug.h @@ -31,16 +31,22 @@ G_BEGIN_DECLS /** + * pidgin_debug_init: + * * Initializes the GTK+ debug system. */ void pidgin_debug_init(void); /** + * pidgin_debug_uninit: + * * Uninitialized the GTK+ debug system. */ void pidgin_debug_uninit(void); /** + * pidgin_debug_get_handle: + * * Get the handle for the GTK+ debug system. * * Returns: the handle to the debug system @@ -48,16 +54,22 @@ void pidgin_debug_uninit(void); void *pidgin_debug_get_handle(void); /** + * pidgin_debug_window_show: + * * Shows the debug window. */ void pidgin_debug_window_show(void); /** + * pidgin_debug_window_hide: + * * Hides the debug window. */ void pidgin_debug_window_hide(void); /** + * pidgin_debug_get_ui_ops: + * * Returns the UI operations structure for GTK+ debug output. * * Returns: The GTK+ UI debug operations structure. diff --git a/pidgin/gtkdnd-hints.h b/pidgin/gtkdnd-hints.h index b1a8fb4f5e..9ad8b67bfb 100644 --- a/pidgin/gtkdnd-hints.h +++ b/pidgin/gtkdnd-hints.h @@ -28,60 +28,78 @@ #include /** + * DndHintWindowId: + * @HINT_ARROW_UP: Up arrow. + * @HINT_ARROW_DOWN: Down arrow. + * @HINT_ARROW_LEFT: Left arrow. + * @HINT_ARROW_RIGHT: Right arrow. + * * Conversation drag-and-drop arrow types. */ typedef enum { - HINT_ARROW_UP, /**< Up arrow. */ - HINT_ARROW_DOWN, /**< Down arrow. */ - HINT_ARROW_LEFT, /**< Left arrow. */ - HINT_ARROW_RIGHT /**< Right arrow. */ + HINT_ARROW_UP, + HINT_ARROW_DOWN, + HINT_ARROW_LEFT, + HINT_ARROW_RIGHT } DndHintWindowId; /** + * DndHintPosition: + * @HINT_POSITION_RIGHT: Position to the right of a tab. + * @HINT_POSITION_LEFT: Position to the left of a tab. + * @HINT_POSITION_TOP: Position above a tab. + * @HINT_POSITION_BOTTOM: Position below a tab. + * @HINT_POSITION_CENTER: Position in the center of a tab. + * * Conversation drag-and-drop arrow positions. */ typedef enum { - HINT_POSITION_RIGHT, /**< Position to the right of a tab. */ - HINT_POSITION_LEFT, /**< Position to the left of a tab. */ - HINT_POSITION_TOP, /**< Position above a tab. */ - HINT_POSITION_BOTTOM, /**< Position below a tab. */ - HINT_POSITION_CENTER /**< Position in the center of a tab. */ + HINT_POSITION_RIGHT, + HINT_POSITION_LEFT, + HINT_POSITION_TOP, + HINT_POSITION_BOTTOM, + HINT_POSITION_CENTER } DndHintPosition; G_BEGIN_DECLS /** - * Shows a drag-and-drop hint at the specified location. - * + * dnd_hints_show: * @id: The ID of the hint to show. * @x: The X location to show it at. * @y: The Y location to show it at. + * + * Shows a drag-and-drop hint at the specified location. */ void dnd_hints_show(DndHintWindowId id, gint x, gint y); /** - * Hides the specified drag-and-drop hint. - * + * dnd_hints_hide: * @id: The ID of the hint to hide. + * + * Hides the specified drag-and-drop hint. */ void dnd_hints_hide(DndHintWindowId id); /** + * dnd_hints_hide_all: + * * Hides all drag-and-drop hints. */ void dnd_hints_hide_all(void); /** - * Shows a drag-and-drop hint relative to a widget. - * + * dnd_hints_show_relative: * @id: The ID of the hint. * @widget: The widget that the hint is relative to. * @horiz: The horizontal relative position. * @vert: The vertical relative position. + * + * Shows a drag-and-drop hint relative to a widget. */ void dnd_hints_show_relative(DndHintWindowId id, GtkWidget *widget, DndHintPosition horiz, DndHintPosition vert); diff --git a/pidgin/gtkdocklet.h b/pidgin/gtkdocklet.h index a40af813eb..9b8a7b5a47 100644 --- a/pidgin/gtkdocklet.h +++ b/pidgin/gtkdocklet.h @@ -35,6 +35,8 @@ typedef enum } PidginDockletFlag; /** + * pidgin_docklet_get_status_icon: + * * Returns the GtkStatusIcon used for the docklet. */ GtkStatusIcon *pidgin_docklet_get_status_icon(void); diff --git a/pidgin/gtkeventloop.h b/pidgin/gtkeventloop.h index 7c62207281..bbe398a2c4 100644 --- a/pidgin/gtkeventloop.h +++ b/pidgin/gtkeventloop.h @@ -31,6 +31,8 @@ G_BEGIN_DECLS /** + * pidgin_eventloop_get_ui_ops: + * * Returns the GTK+ event loop UI operations structure. * * Returns: The GTK+ event loop UI operations structure. diff --git a/pidgin/gtkicon-theme-loader.h b/pidgin/gtkicon-theme-loader.h index eccb85dc32..ba7226ec75 100644 --- a/pidgin/gtkicon-theme-loader.h +++ b/pidgin/gtkicon-theme-loader.h @@ -30,12 +30,6 @@ #include #include "theme-loader.h" -/** - * A pidgin icon theme loader. Extends PurpleThemeLoader (theme-loader.h) - * This is a class designed to build icon themes - * - * PidginIconThemeLoader is a GObject. - */ typedef struct _PidginIconThemeLoader PidginIconThemeLoader; typedef struct _PidginIconThemeLoaderClass PidginIconThemeLoaderClass; @@ -46,6 +40,12 @@ typedef struct _PidginIconThemeLoaderClass PidginIconThemeLoaderClass; #define PIDGIN_IS_ICON_THEME_LOADER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_ICON_THEME_LOADER)) #define PIDGIN_ICON_THEME_LOADER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_ICON_THEME_LOADER, PidginIconThemeLoaderClass)) +/** + * PidginIconThemeLoader: + * + * A pidgin icon theme loader. Extends PurpleThemeLoader (theme-loader.h) + * This is a class designed to build icon themes + */ struct _PidginIconThemeLoader { PurpleThemeLoader parent; @@ -62,10 +62,13 @@ struct _PidginIconThemeLoaderClass G_BEGIN_DECLS /** + * pidgin_icon_theme_loader_get_type: + * * GObject foo. * @internal. */ GType pidgin_icon_theme_loader_get_type(void); G_END_DECLS + #endif /* PIDGIN_ICON_THEME_LOADER_H */ diff --git a/pidgin/gtkicon-theme.h b/pidgin/gtkicon-theme.h index 97854355c7..16aff311e5 100644 --- a/pidgin/gtkicon-theme.h +++ b/pidgin/gtkicon-theme.h @@ -30,13 +30,6 @@ #include #include "theme.h" -/** - * extends PurpleTheme (theme.h) - * A pidgin icon theme. - * This object represents a Pidgin icon theme. - * - * PidginIconTheme is a PurpleTheme Object. - */ typedef struct _PidginIconTheme PidginIconTheme; typedef struct _PidginIconThemeClass PidginIconThemeClass; @@ -47,6 +40,15 @@ typedef struct _PidginIconThemeClass PidginIconThemeClass; #define PIDGIN_IS_ICON_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_ICON_THEME)) #define PIDGIN_ICON_THEME_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_ICON_THEME, PidginIconThemeClass)) +/** + * PidginIconTheme: + * + * extends PurpleTheme (theme.h) + * A pidgin icon theme. + * This object represents a Pidgin icon theme. + * + * PidginIconTheme is a PurpleTheme Object. + */ struct _PidginIconTheme { PurpleTheme parent; @@ -63,32 +65,37 @@ struct _PidginIconThemeClass G_BEGIN_DECLS /** + * pidgin_icon_theme_get_type: + * * GObject foo. * @internal. */ GType pidgin_icon_theme_get_type(void); /** - * Returns a copy of the filename for the icon event or NULL if it is not set - * + * pidgin_icon_theme_get_icon: * @theme: the theme * @event: the pidgin icon event to look up * + * Returns a copy of the filename for the icon event or NULL if it is not set + * * Returns: the filename of the icon event */ const gchar *pidgin_icon_theme_get_icon(PidginIconTheme *theme, const gchar *event); /** - * Sets the filename for a given icon id, setting the icon to NULL will remove the icon from the theme - * + * pidgin_icon_theme_set_icon: * @theme: the theme * @icon_id: a string representing what the icon is to be used for * @filename: the name of the file to be used for the given id + * + * Sets the filename for a given icon id, setting the icon to NULL will remove the icon from the theme */ void pidgin_icon_theme_set_icon(PidginIconTheme *theme, const gchar *icon_id, const gchar *filename); G_END_DECLS + #endif /* PIDGIN_ICON_THEME_H */ diff --git a/pidgin/gtkidle.h b/pidgin/gtkidle.h index 149c879ad4..de281ac296 100644 --- a/pidgin/gtkidle.h +++ b/pidgin/gtkidle.h @@ -36,6 +36,8 @@ G_BEGIN_DECLS /*@{*/ /** + * pidgin_idle_get_ui_ops: + * * Returns the GTK+ idle UI ops. * * Returns: The UI operations structure. diff --git a/pidgin/gtklog.h b/pidgin/gtklog.h index d5d9dbdb00..ac41000d04 100644 --- a/pidgin/gtklog.h +++ b/pidgin/gtklog.h @@ -35,20 +35,31 @@ typedef struct _PidginLogViewer PidginLogViewer; /** + * PidginLogViewer: + * @logs: The list of logs viewed in this viewer + * @window: The viewer's window + * @treestore: The treestore containing said logs + * @treeview: The treeview representing said treestore + * @web_view: The webkit web view to display said logs + * @entry: The search entry, in which search terms are entered + * @flags: The most recently used log flags + * @search: The string currently being searched for + * @label: The label at the top of the log viewer + * * A GTK+ Log Viewer. You can look at logs with it. */ struct _PidginLogViewer { - GList *logs; /**< The list of logs viewed in this viewer */ - - GtkWidget *window; /**< The viewer's window */ - GtkTreeStore *treestore; /**< The treestore containing said logs */ - GtkWidget *treeview; /**< The treeview representing said treestore */ - GtkWidget *web_view; /**< The webkit web view to display said logs */ - GtkWidget *entry; /**< The search entry, in which search terms - * are entered */ - PurpleLogReadFlags flags; /**< The most recently used log flags */ - char *search; /**< The string currently being searched for */ - GtkWidget *label; /**< The label at the top of the log viewer */ + GList *logs; + + GtkWidget *window; + GtkTreeStore *treestore; + GtkWidget *treeview; + GtkWidget *web_view; + GtkWidget *entry; + + PurpleLogReadFlags flags; + char *search; + GtkWidget *label; }; @@ -65,11 +76,15 @@ void pidgin_syslog_show(void); /*@{*/ /** + * pidgin_log_init: + * * Initializes the GTK+ log subsystem. */ void pidgin_log_init(void); /** + * pidgin_log_get_handle: + * * Returns the GTK+ log subsystem handle. * * Returns: The GTK+ log subsystem handle. @@ -77,6 +92,8 @@ void pidgin_log_init(void); void *pidgin_log_get_handle(void); /** + * pidgin_log_uninit: + * * Uninitializes the GTK+ log subsystem. */ void pidgin_log_uninit(void); diff --git a/pidgin/gtkmenutray.h b/pidgin/gtkmenutray.h index 204a653368..1184bcf1d2 100644 --- a/pidgin/gtkmenutray.h +++ b/pidgin/gtkmenutray.h @@ -36,20 +36,26 @@ typedef struct _PidginMenuTray PidginMenuTray; typedef struct _PidginMenuTrayClass PidginMenuTrayClass; -/** A PidginMenuTray */ +/** + * PidginMenuTray: + * @tray: The tray + * + * A PidginMenuTray + */ struct _PidginMenuTray { - GtkMenuItem gparent; /**< The parent instance */ - GtkWidget *tray; /**< The tray */ + GtkMenuItem gparent; + GtkWidget *tray; }; -/** A PidginMenuTrayClass */ struct _PidginMenuTrayClass { - GtkMenuItemClass gparent; /**< The parent class */ + GtkMenuItemClass gparent; }; G_BEGIN_DECLS /** + * pidgin_menu_tray_get_type: + * * Registers the PidginMenuTray class if necessary and returns the * type ID assigned to it. * @@ -58,6 +64,8 @@ G_BEGIN_DECLS GType pidgin_menu_tray_get_type(void); /** + * pidgin_menu_tray_new: + * * Creates a new PidginMenuTray * * Returns: A new PidginMenuTray @@ -65,38 +73,42 @@ GType pidgin_menu_tray_get_type(void); GtkWidget *pidgin_menu_tray_new(void); /** - * Gets the box for the PidginMenuTray - * + * pidgin_menu_tray_get_box: * @menu_tray: The PidginMenuTray * + * Gets the box for the PidginMenuTray + * * Returns: The box that this menu tray is using */ GtkWidget *pidgin_menu_tray_get_box(PidginMenuTray *menu_tray); /** - * Appends a widget into the tray - * + * pidgin_menu_tray_append: * @menu_tray: The tray * @widget: The widget * @tooltip: The tooltip for this widget (widget requires its own X-window) + * + * Appends a widget into the tray */ void pidgin_menu_tray_append(PidginMenuTray *menu_tray, GtkWidget *widget, const char *tooltip); /** - * Prepends a widget into the tray - * + * pidgin_menu_tray_prepend: * @menu_tray: The tray * @widget: The widget * @tooltip: The tooltip for this widget (widget requires its own X-window) + * + * Prepends a widget into the tray */ void pidgin_menu_tray_prepend(PidginMenuTray *menu_tray, GtkWidget *widget, const char *tooltip); /** - * Set the tooltip for a widget - * + * pidgin_menu_tray_set_tooltip: * @menu_tray: The tray * @widget: The widget * @tooltip: The tooltip to set for the widget (widget requires its own X-window) + * + * Set the tooltip for a widget */ void pidgin_menu_tray_set_tooltip(PidginMenuTray *menu_tray, GtkWidget *widget, const char *tooltip); diff --git a/pidgin/gtknotify.h b/pidgin/gtknotify.h index 6450befd1c..e1f05cc5fa 100644 --- a/pidgin/gtknotify.h +++ b/pidgin/gtknotify.h @@ -32,19 +32,22 @@ G_BEGIN_DECLS /** - * Adds a buddy pounce to the buddy pounce dialog - * + * pidgin_notify_pounce_add: * @account: The account * @pounce: The pounce * @alias: The buddy alias * @event: Event description * @message: Pounce message * @date: Pounce date + * + * Adds a buddy pounce to the buddy pounce dialog */ void pidgin_notify_pounce_add(PurpleAccount *account, PurplePounce *pounce, const char *alias, const char *event, const char *message, const char *date); /** + * pidgin_notify_get_ui_ops: + * * Returns the UI operations structure for GTK+ notification functions. * * Returns: The GTK+ UI notify operations structure. @@ -52,18 +55,22 @@ void pidgin_notify_pounce_add(PurpleAccount *account, PurplePounce *pounce, PurpleNotifyUiOps *pidgin_notify_get_ui_ops(void); /** + * pidgin_notify_init: + * * Initializes the GTK+ notifications subsystem. */ void pidgin_notify_init(void); /** + * pidgin_notify_uninit: + * * Uninitialized the GTK+ notifications subsystem. */ void pidgin_notify_uninit(void); -G_END_DECLS - /** + * pidgin_notify_emails_pending: + * * Returns TRUE if there are unseen emails, FALSE otherwise. * * Returns: TRUE if there are unseen emails, FALSE otherwise. @@ -71,10 +78,14 @@ G_END_DECLS gboolean pidgin_notify_emails_pending(void); /** + * pidgin_notify_emails_present: + * * Presents mail dialog to the user. * * Returns: void. */ void pidgin_notify_emails_present(void *data); +G_END_DECLS + #endif /* _PIDGINNOTIFY_H_ */ diff --git a/pidgin/gtkpluginpref.h b/pidgin/gtkpluginpref.h index 003dbb70d7..3f0f04dab9 100644 --- a/pidgin/gtkpluginpref.h +++ b/pidgin/gtkpluginpref.h @@ -34,9 +34,11 @@ G_BEGIN_DECLS /** + * pidgin_plugin_pref_create_frame: + * @frame: PurplePluginPrefFrame + * * Creates a Gtk Preference frame for a PurplePluginPrefFrame * - * @frame: PurplePluginPrefFrame * Returns: The gtk preference frame */ GtkWidget *pidgin_plugin_pref_create_frame(PurplePluginPrefFrame *frame); diff --git a/pidgin/gtkpounce.h b/pidgin/gtkpounce.h index 3789a1200c..bd24214445 100644 --- a/pidgin/gtkpounce.h +++ b/pidgin/gtkpounce.h @@ -31,26 +31,33 @@ G_BEGIN_DECLS /** - * Displays a New Buddy Pounce or Edit Buddy Pounce dialog. - * + * pidgin_pounce_editor_show: * @account: The optional account to use. * @name: The optional name to pounce on. * @cur_pounce: The current buddy pounce, if editing an existing one. + * + * Displays a New Buddy Pounce or Edit Buddy Pounce dialog. */ void pidgin_pounce_editor_show(PurpleAccount *account, const char *name, PurplePounce *cur_pounce); /** + * pidgin_pounces_manager_show: + * * Shows the pounces manager window. */ void pidgin_pounces_manager_show(void); /** + * pidgin_pounces_manager_hide: + * * Hides the pounces manager window. */ void pidgin_pounces_manager_hide(void); /** + * pidgin_pounces_get_handle: + * * Returns the gtkpounces handle * * Returns: The handle to the GTK+ pounces system @@ -58,6 +65,8 @@ void pidgin_pounces_manager_hide(void); void *pidgin_pounces_get_handle(void); /** + * pidgin_pounces_init: + * * Initializes the GTK+ pounces subsystem. */ void pidgin_pounces_init(void); diff --git a/pidgin/gtkprefs.h b/pidgin/gtkprefs.h index 8ec3ed592b..ca03221c43 100644 --- a/pidgin/gtkprefs.h +++ b/pidgin/gtkprefs.h @@ -32,34 +32,41 @@ G_BEGIN_DECLS /** + * pidgin_prefs_init: + * * Initializes all UI-specific preferences. */ void pidgin_prefs_init(void); /** + * pidgin_prefs_show: + * * Shows the preferences dialog. */ void pidgin_prefs_show(void); /** - * Add a new checkbox for a boolean preference - * + * pidgin_prefs_checkbox: * @title: The text to be displayed as the checkbox label * @key: The key of the purple bool pref that will be represented by the checkbox * @page: The page to which the new checkbox will be added + * + * Add a new checkbox for a boolean preference */ GtkWidget *pidgin_prefs_checkbox(const char *title, const char *key, GtkWidget *page); /** - * Add a new spin button representing an int preference - * + * pidgin_prefs_labeled_spin_button: * @page: The page to which the spin button will be added * @title: The text to be displayed as the spin button label * @key: The key of the int pref that will be represented by the spin button * @min: The minimum value of the spin button * @max: The maximum value of the spin button * @sg: If not NULL, the size group to which the spin button will be added + * + * Add a new spin button representing an int preference + * * Returns: An hbox containing both the label and the spinner. Can be * used to set the widgets to sensitive or insensitive based on the * value of a checkbox. @@ -68,13 +75,14 @@ GtkWidget *pidgin_prefs_labeled_spin_button(GtkWidget *page, const gchar *title, const char *key, int min, int max, GtkSizeGroup *sg); /** - * Add a new entry representing a string preference - * + * pidgin_prefs_labeled_entry: * @page: The page to which the entry will be added * @title: The text to be displayed as the entry label * @key: The key of the string pref that will be represented by the entry * @sg: If not NULL, the size group to which the entry will be added * + * Add a new entry representing a string preference + * * Returns: An hbox containing both the label and the entry. Can be used to set * the widgets to sensitive or insensitive based on the value of a * checkbox. @@ -83,14 +91,15 @@ GtkWidget *pidgin_prefs_labeled_entry(GtkWidget *page, const gchar *title, const char *key, GtkSizeGroup *sg); /** - * Add a new entry representing a password (string) preference - * The entry will use a password-style text entry (the text is substituded) - * + * pidgin_prefs_labeled_password: * @page: The page to which the entry will be added * @title: The text to be displayed as the entry label * @key: The key of the string pref that will be represented by the entry * @sg: If not NULL, the size group to which the entry will be added * + * Add a new entry representing a password (string) preference + * The entry will use a password-style text entry (the text is substituded) + * * Returns: An hbox containing both the label and the entry. Can be used to set * the widgets to sensitive or insensitive based on the value of a * checkbox. @@ -99,33 +108,37 @@ GtkWidget *pidgin_prefs_labeled_password(GtkWidget *page, const gchar *title, const char *key, GtkSizeGroup *sg); /** - * Add a new dropdown representing a preference of the specified type - * + * pidgin_prefs_dropdown: * @page: The page to which the dropdown will be added * @title: The text to be displayed as the dropdown label * @type: The type of preference to be stored in the generated dropdown * @key: The key of the pref that will be represented by the dropdown * @...: The choices to be added to the dropdown, choices should be * paired as label/value + * + * Add a new dropdown representing a preference of the specified type */ GtkWidget *pidgin_prefs_dropdown(GtkWidget *page, const gchar *title, PurplePrefType type, const char *key, ...); /** - * Add a new dropdown representing a preference of the specified type - * + * pidgin_prefs_dropdown_from_list: * @page: The page to which the dropdown will be added * @title: The text to be displayed as the dropdown label * @type: The type of preference to be stored in the dropdown * @key: The key of the pref that will be represented by the dropdown * @menuitems: The choices to be added to the dropdown, choices should * be paired as label/value + * + * Add a new dropdown representing a preference of the specified type */ GtkWidget *pidgin_prefs_dropdown_from_list(GtkWidget *page, const gchar * title, PurplePrefType type, const char *key, GList *menuitems); /** + * pidgin_prefs_update_old: + * * Rename legacy prefs and delete some that no longer exist. */ void pidgin_prefs_update_old(void); diff --git a/pidgin/gtkprivacy.h b/pidgin/gtkprivacy.h index 53cf3b0f3e..966a222bdb 100644 --- a/pidgin/gtkprivacy.h +++ b/pidgin/gtkprivacy.h @@ -31,39 +31,47 @@ G_BEGIN_DECLS /** + * pidgin_privacy_init: + * * Initializes the GTK+ privacy subsystem. */ void pidgin_privacy_init(void); /** + * pidgin_privacy_dialog_show: + * * Shows the privacy dialog. */ void pidgin_privacy_dialog_show(void); /** + * pidgin_privacy_dialog_hide: + * * Hides the privacy dialog. */ void pidgin_privacy_dialog_hide(void); /** + * pidgin_request_add_permit: + * @account: The account. + * @name: The name of the user to add. + * * Requests confirmation to add a user to the allow list for an account, * and then adds it. * - * If @a name is not specified, an input dialog will be presented. - * - * @account: The account. - * @name: The name of the user to add. + * If @name is not specified, an input dialog will be presented. */ void pidgin_request_add_permit(PurpleAccount *account, const char *name); /** + * pidgin_request_add_block: + * @account: The account. + * @name: The name of the user to add. + * * Requests confirmation to add a user to the block list for an account, * and then adds it. * - * If @a name is not specified, an input dialog will be presented. - * - * @account: The account. - * @name: The name of the user to add. + * If @name is not specified, an input dialog will be presented. */ void pidgin_request_add_block(PurpleAccount *account, const char *name); diff --git a/pidgin/gtkrequest.h b/pidgin/gtkrequest.h index 213ade8e86..e09ccf9d2a 100644 --- a/pidgin/gtkrequest.h +++ b/pidgin/gtkrequest.h @@ -31,6 +31,8 @@ G_BEGIN_DECLS /** + * pidgin_request_get_ui_ops: + * * Returns the UI operations structure for GTK+ request functions. * * Returns: The GTK+ UI request operations structure. @@ -38,10 +40,11 @@ G_BEGIN_DECLS PurpleRequestUiOps *pidgin_request_get_ui_ops(void); /** - * Gets dialog window for specified libpurple request. - * + * pidgin_request_get_dialog_window: * @ui_handle: The UI handle. * + * Gets dialog window for specified libpurple request. + * * Returns: The dialog window. */ GtkWindow * @@ -53,6 +56,8 @@ pidgin_request_get_dialog_window(void *ui_handle); /*@{*/ /** + * pidgin_request_get_handle: + * * Returns the gtk requests subsystem handle. * * Returns: The requests subsystem handle. @@ -60,11 +65,15 @@ pidgin_request_get_dialog_window(void *ui_handle); void *pidgin_request_get_handle(void); /** + * pidgin_request_init: + * * Initializes the GTK+ requests subsystem. */ void pidgin_request_init(void); /** + * pidgin_request_uninit: + * * Uninitializes the GTK+ requests subsystem. */ void pidgin_request_uninit(void); diff --git a/pidgin/gtkroomlist.h b/pidgin/gtkroomlist.h index ed9007a744..19ec80afc2 100644 --- a/pidgin/gtkroomlist.h +++ b/pidgin/gtkroomlist.h @@ -31,11 +31,15 @@ G_BEGIN_DECLS /** + * pidgin_roomlist_init: + * * Initializes the room list subsystem. */ void pidgin_roomlist_init(void); /** + * pidgin_roomlist_is_showable: + * * Determines if showing the room list dialog is a valid action. * * Returns: TRUE if there are accounts online that support listing @@ -44,14 +48,17 @@ void pidgin_roomlist_init(void); gboolean pidgin_roomlist_is_showable(void); /** + * pidgin_roomlist_dialog_show: + * * Shows a new roomlist dialog. */ void pidgin_roomlist_dialog_show(void); /** - * Shows a new room list dialog and fetches the list for the specified account. - * + * pidgin_roomlist_dialog_show_with_account: * @account: The account to use. + * + * Shows a new room list dialog and fetches the list for the specified account. */ void pidgin_roomlist_dialog_show_with_account(PurpleAccount *account); diff --git a/pidgin/gtksavedstatuses.h b/pidgin/gtksavedstatuses.h index 534111cbce..9caac3d7d7 100644 --- a/pidgin/gtksavedstatuses.h +++ b/pidgin/gtksavedstatuses.h @@ -32,45 +32,54 @@ G_BEGIN_DECLS /** + * pidgin_status_window_show: + * * Shows the status window. */ void pidgin_status_window_show(void); /** + * pidgin_status_window_hide: + * * Hides the status window. */ void pidgin_status_window_hide(void); /** - * Shows a status editor (used for adding a new saved status or - * editing an already existing saved status). - * - * @edit: TRUE if we want to edit an existing saved - * status or FALSE to create a new one. You + * pidgin_status_editor_show: + * @edit: %TRUE if we want to edit an existing saved + * status or %FALSE to create a new one. You * can not edit transient statuses--they don't * have titles. If you want to edit a transient - * status, set this to FALSE and seed the dialog + * status, set this to %FALSE and seed the dialog * with the transient status using the status * parameter to this function. - * @status: If edit is TRUE then this should be a + * @status: If edit is %TRUE then this should be a * pointer to the PurpleSavedStatus to edit. - * If edit is FALSE then this can be NULL, + * If edit is %FALSE then this can be NULL, * or you can pass in a saved status to * seed the initial values of the new status. + * + * Shows a status editor (used for adding a new saved status or + * editing an already existing saved status). */ void pidgin_status_editor_show(gboolean edit, PurpleSavedStatus *status); /** + * pidgin_status_menu: + * @status: The default saved_status to show as 'selected' + * @callback: The callback to call when the selection changes + * * Creates a dropdown menu of saved statuses and calls a callback * when one is selected * - * @status: The default saved_status to show as 'selected' - * @callback: The callback to call when the selection changes * Returns: The menu widget */ GtkWidget *pidgin_status_menu(PurpleSavedStatus *status, GCallback callback); /** + * pidgin_status_get_handle: + * * Returns the GTK+ status handle. * * Returns: The handle to the GTK+ status system. @@ -78,11 +87,15 @@ GtkWidget *pidgin_status_menu(PurpleSavedStatus *status, GCallback callback); void *pidgin_status_get_handle(void); /** + * pidgin_status_init: + * * Initializes the GTK+ status system. */ void pidgin_status_init(void); /** + * pidgin_status_uninit: + * * Uninitializes the GTK+ status system. */ void pidgin_status_uninit(void); diff --git a/pidgin/gtksession.h b/pidgin/gtksession.h index 3762fbf3ff..bcdea93de5 100644 --- a/pidgin/gtksession.h +++ b/pidgin/gtksession.h @@ -34,18 +34,21 @@ G_BEGIN_DECLS /*@{*/ /** - * Register this instance of Pidgin with the user's current session - * manager. - * + * pidgin_session_init: * @argv0: The first argument passed into the program. This * will be the name of the executable, e.g. 'purple' * @previous_id: An optional session ID to use. This can be NULL. * @config_dir: The path to the configuration directory used by * this instance of this program, e.g. '/home/user/.purple' + * + * Register this instance of Pidgin with the user's current session + * manager. */ void pidgin_session_init(gchar *argv0, gchar *previous_id, gchar *config_dir); /** + * pidgin_session_end: + * * Unregister this instance of Pidgin with the user's current session * manager. */ diff --git a/pidgin/gtksmiley.h b/pidgin/gtksmiley.h index fa5fd42276..9390d48166 100644 --- a/pidgin/gtksmiley.h +++ b/pidgin/gtksmiley.h @@ -34,31 +34,39 @@ typedef struct _PidginSmiley PidginSmiley; G_BEGIN_DECLS /** + * pidgin_smiley_add_to_list: + * @smiley: The smiley to be added. + * * Add a PurpleSmiley to the GtkWebViewSmiley's list to be able to use it * in pidgin - * - * @smiley: The smiley to be added. */ void pidgin_smiley_add_to_list(PurpleSmiley *smiley); /** - * Delete a PurpleSmiley from the GtkWebViewSmiley's list - * + * pidgin_smiley_del_from_list: * @smiley: The smiley to be deleted. + * + * Delete a PurpleSmiley from the GtkWebViewSmiley's list */ void pidgin_smiley_del_from_list(PurpleSmiley *smiley); /** + * pidgin_smileys_init: + * * Load the GtkWebViewSmiley list */ void pidgin_smileys_init(void); /** + * pidgin_smileys_uninit: + * * Uninit the GtkWebViewSmiley list */ void pidgin_smileys_uninit(void); /** + * pidgin_smileys_get_all: + * * Returns a GSList with the GtkWebViewSmiley of each custom smiley * * Returns: (transfer none): A GtkWebViewSmiley list @@ -69,44 +77,51 @@ GSList *pidgin_smileys_get_all(void); * Smiley Manager *****************************************************************************/ /** + * pidgin_smiley_manager_show: + * * Displays the Smiley Manager Window */ void pidgin_smiley_manager_show(void); /** - * Shows an editor for a smiley. - * + * pidgin_smiley_edit: * @widget: The parent widget to be linked or %NULL * @smiley: The PurpleSmiley to be edited, or %NULL for a new smiley - * Returns: The smiley add dialog + * + * Shows an editor for a smiley. * * @see pidgin_smiley_editor_set_shortcut * @see pidgin_smiley_editor_set_image + * + * Returns: The smiley add dialog */ PidginSmiley *pidgin_smiley_edit(GtkWidget *widget, PurpleSmiley *smiley); /** - * Set the shortcut in a smiley add dialog - * + * pidgin_smiley_editor_set_shortcut: * @editor: A smiley editor dialog (created by pidgin_smiley_edit) * @shortcut: The shortcut to set + * + * Set the shortcut in a smiley add dialog */ void pidgin_smiley_editor_set_shortcut(PidginSmiley *editor, const gchar *shortcut); /** - * Set the image in a smiley add dialog - * + * pidgin_smiley_editor_set_image: * @editor: A smiley editor dialog * @image: A GdkPixbuf image + * + * Set the image in a smiley add dialog */ void pidgin_smiley_editor_set_image(PidginSmiley *editor, GdkPixbuf *image); /** - * Sets the image data in a smiley add dialog - * + * pidgin_smiley_editor_set_data: * @editor: A smiley editor dialog * @data: A pointer to smiley's data * @datasize: The size of smiley's data + * + * Sets the image data in a smiley add dialog */ void pidgin_smiley_editor_set_data(PidginSmiley *editor, gpointer data, gsize datasize); -- cgit v1.2.1