/soc/2013/ankitkv/gobjectification: d3f9e6dad44b: Convert docs f...
Ankit Vani
a at nevitus.org
Sat Feb 1 13:53:29 EST 2014
Changeset: d3f9e6dad44b97eda7be73d7462929c9115a5ac7
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 00:09 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/d3f9e6dad44b
Description:
Convert docs from doxygen to gtk-doc format for UI headers that change in .plugins
diffstat:
finch/finch.h | 2 +
finch/gntplugin.h | 8 +
pidgin/gtkplugin.h | 6 +
pidgin/gtkutils.h | 387 ++++++++++++++++++++++++++++++------------------
pidgin/gtkwhiteboard.h | 33 ++-
pidgin/pidgin.h | 4 +
6 files changed, 281 insertions(+), 159 deletions(-)
diffs (truncated from 1155 to 300 lines):
diff --git a/finch/finch.h b/finch/finch.h
--- a/finch/finch.h
+++ b/finch/finch.h
@@ -35,6 +35,8 @@
#define FINCH_SET_DATA(obj, data) (obj)->ui_data = data
/**
+ * gnt_start:
+ *
* Start finch with the given command line arguments.
*/
gboolean gnt_start(int *argc, char ***argv);
diff --git a/finch/gntplugin.h b/finch/gntplugin.h
--- a/finch/gntplugin.h
+++ b/finch/gntplugin.h
@@ -46,6 +46,8 @@ typedef GntWidget* (*FinchPluginFrame) (
#define FINCH_PLUGIN_TYPE FINCH_UI
/**
+ * PURPLE_IS_GNT_PLUGIN:
+ *
* Decide whether a plugin is a GNT-plugin.
*/
#define PURPLE_IS_GNT_PLUGIN(plugin) \
@@ -53,17 +55,23 @@ typedef GntWidget* (*FinchPluginFrame) (
!strcmp((plugin)->info->ui_requirement, FINCH_PLUGIN_TYPE))
/**
+ * FINCH_PLUGIN_UI_INFO:
+ *
* Get the ui-info from GNT-plugins.
*/
#define FINCH_PLUGIN_UI_INFO(plugin) \
(FinchPluginFrame)((plugin)->info->ui_info)
/**
+ * finch_plugins_show_all:
+ *
* Show a list of plugins.
*/
void finch_plugins_show_all(void);
/**
+ * finch_plugins_save_loaded:
+ *
* Save the list of loaded plugins.
*/
void finch_plugins_save_loaded(void);
diff --git a/pidgin/gtkplugin.h b/pidgin/gtkplugin.h
--- a/pidgin/gtkplugin.h
+++ b/pidgin/gtkplugin.h
@@ -32,6 +32,8 @@
typedef struct _PidginPluginUiInfo PidginPluginUiInfo;
/**
+ * PidginPluginUiInfo:
+ *
* A GTK+ UI structure for plugins.
*/
struct _PidginPluginUiInfo
@@ -57,11 +59,15 @@ struct _PidginPluginUiInfo
G_BEGIN_DECLS
/**
+ * pidgin_plugins_save:
+ *
* Saves all loaded plugins.
*/
void pidgin_plugins_save(void);
/**
+ * pidgin_plugin_dialog_show:
+ *
* Shows the Plugins dialog
*/
void pidgin_plugin_dialog_show(void);
diff --git a/pidgin/gtkutils.h b/pidgin/gtkutils.h
--- a/pidgin/gtkutils.h
+++ b/pidgin/gtkutils.h
@@ -79,18 +79,16 @@ typedef gboolean (*PidginFilterBuddyComp
G_BEGIN_DECLS
/**
+ * pidgin_setup_webview:
+ * @webview: The gtkwebview widget to setup.
+ *
* Sets up a gtkwebview widget, loads it with smileys, and sets the
* default signal handlers.
- *
- * @webview: The gtkwebview widget to setup.
*/
void pidgin_setup_webview(GtkWidget *webview);
/**
- * Create an GtkWebView widget and associated GtkWebViewToolbar widget. This
- * function puts both widgets in a nice GtkFrame. They're separated by an
- * attractive GtkSeparator.
- *
+ * pidgin_create_webview:
* @editable: %TRUE if this webview should be editable. If this is
* %FALSE, then the toolbar will NOT be created. If this webview
* should be read-only at first, but may become editable later, then
@@ -101,145 +99,162 @@ void pidgin_setup_webview(GtkWidget *web
* @sw_ret: This will be filled with a pointer to the scrolled window
* widget which contains the webview.
*
+ * Create an GtkWebView widget and associated GtkWebViewToolbar widget. This
+ * function puts both widgets in a nice GtkFrame. They're separated by an
+ * attractive GtkSeparator.
+ *
* Returns: The GtkFrame containing the toolbar and webview.
*/
GtkWidget *pidgin_create_webview(gboolean editable, GtkWidget **webview_ret, GtkWidget **sw_ret);
/**
+ * pidgin_create_small_button:
+ * @image: A button image.
+ *
* Creates a small button
*
- * @image: A button image.
- *
* Returns: A GtkButton created from the image.
*/
GtkWidget *pidgin_create_small_button(GtkWidget *image);
/**
- * Creates a new window
- *
+ * pidgin_create_window:
* @title: The window title, or %NULL
* @border_width: The window's desired border width
* @role: A string indicating what the window is responsible for doing, or %NULL
* @resizable: Whether the window should be resizable (%TRUE) or not (%FALSE)
+ *
+ * Creates a new window
*/
GtkWidget *pidgin_create_window(const char *title, guint border_width, const char *role, gboolean resizable);
/**
- * Creates a new dialog window
- *
+ * pidgin_create_dialog:
* @title: The window title, or %NULL
* @border_width: The window's desired border width
* @role: A string indicating what the window is responsible for doing, or %NULL
* @resizable: Whether the window should be resizable (%TRUE) or not (%FALSE)
+ *
+ * Creates a new dialog window
*/
GtkWidget *pidgin_create_dialog(const char *title, guint border_width, const char *role, gboolean resizable);
/**
- * Retrieves the main content box (vbox) from a pidgin dialog window
- *
+ * pidgin_dialog_get_vbox_with_properties:
* @dialog: The dialog window
* @homogeneous: TRUE if all children are to be given equal space allotments.
* @spacing: the number of pixels to place by default between children
+ *
+ * Retrieves the main content box (vbox) from a pidgin dialog window
*/
GtkWidget *pidgin_dialog_get_vbox_with_properties(GtkDialog *dialog, gboolean homogeneous, gint spacing);
/**
+ * pidgin_dialog_get_vbox:
+ * @dialog: The dialog window
+ *
* Retrieves the main content box (vbox) from a pidgin dialog window
- *
- * @dialog: The dialog window
*/
GtkWidget *pidgin_dialog_get_vbox(GtkDialog *dialog);
/**
- * Add a button to a dialog created by #pidgin_create_dialog.
- *
+ * pidgin_dialog_add_button:
* @dialog: The dialog window
* @label: The stock-id or the label for the button
* @callback: The callback function for the button
* @callbackdata: The user data for the callback function
*
+ * Add a button to a dialog created by #pidgin_create_dialog.
+ *
* Returns: The created button.
*/
GtkWidget *pidgin_dialog_add_button(GtkDialog *dialog, const char *label,
GCallback callback, gpointer callbackdata);
/**
+ * pidgin_dialog_get_action_area:
+ * @dialog: The dialog window
+ *
* Retrieves the action area (button box) from a pidgin dialog window
- *
- * @dialog: The dialog window
*/
GtkWidget *pidgin_dialog_get_action_area(GtkDialog *dialog);
/**
- * Toggles the sensitivity of a widget.
- *
+ * pidgin_toggle_sensitive:
* @widget: %NULL. Used for signal handlers.
* @to_toggle: The widget to toggle.
+ *
+ * Toggles the sensitivity of a widget.
*/
void pidgin_toggle_sensitive(GtkWidget *widget, GtkWidget *to_toggle);
/**
+ * pidgin_set_sensitive_if_input:
+ * @entry: The text entry widget.
+ * @dialog: The dialog containing the text entry widget.
+ *
* Checks if text has been entered into a GtkTextEntry widget. If
* so, the GTK_RESPONSE_OK on the given dialog is set to TRUE.
* Otherwise GTK_RESPONSE_OK is set to FALSE.
- *
- * @entry: The text entry widget.
- * @dialog: The dialog containing the text entry widget.
*/
void pidgin_set_sensitive_if_input(GtkWidget *entry, GtkWidget *dialog);
/**
- * Toggles the sensitivity of all widgets in a pointer array.
- *
+ * pidgin_toggle_sensitive_array:
* @w: %NULL. Used for signal handlers.
* @data: The array containing the widgets to toggle.
+ *
+ * Toggles the sensitivity of all widgets in a pointer array.
*/
void pidgin_toggle_sensitive_array(GtkWidget *w, GPtrArray *data);
/**
- * Toggles the visibility of a widget.
- *
+ * pidgin_toggle_showhide:
* @widget: %NULL. Used for signal handlers.
* @to_toggle: The widget to toggle.
+ *
+ * Toggles the visibility of a widget.
*/
void pidgin_toggle_showhide(GtkWidget *widget, GtkWidget *to_toggle);
/**
+ * pidgin_separator:
+ * @menu: The menu to add a separator to.
+ *
* Adds a separator to a menu.
*
- * @menu: The menu to add a separator to.
- *
* Returns: The separator.
*/
GtkWidget *pidgin_separator(GtkWidget *menu);
/**
- * Creates a menu item.
- *
+ * pidgin_new_item:
* @menu: The menu to which to append the menu item.
* @str: The title to use for the newly created menu item.
*
+ * Creates a menu item.
+ *
* Returns: The newly created menu item.
*/
GtkWidget *pidgin_new_item(GtkWidget *menu, const char *str);
/**
- * Creates a check menu item.
- *
+ * pidgin_new_check_item:
* @menu: The menu to which to append the check menu item.
* @str: The title to use for the newly created menu item.
* @cb: A function to call when the menu item is activated.
* @data: Data to pass to the signal function.
* @checked: The initial state of the check item
*
+ * Creates a check menu item.
+ *
* Returns: The newly created menu item.
*/
GtkWidget *pidgin_new_check_item(GtkWidget *menu, const char *str,
GCallback cb, gpointer data, gboolean checked);
/**
- * Creates a menu item.
- *
+ * pidgin_new_item_from_stock:
* @menu: The menu to which to append the menu item.
* @str: The title for the menu item.
* @icon: An icon to place to the left of the menu item,
@@ -250,6 +265,8 @@ GtkWidget *pidgin_new_check_item(GtkWidg
* @accel_mods: Something.
* @mod: Something.
*
More information about the Commits
mailing list