/soc/2013/ankitkv/gobjectification: 6a395246c742: Merge gtkdoc-c...
Ankit Vani
a at nevitus.org
Sat Feb 1 13:53:29 EST 2014
Changeset: 6a395246c742ac34a20720b67534f606d774217a
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 00:11 +0530
Branch: soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/6a395246c742
Description:
Merge gtkdoc-conversion
diffstat:
finch/finch.h | 2 +
finch/gntplugin.h | 28 ++-
pidgin/gtkplugin.h | 28 ++-
pidgin/gtkutils.h | 387 ++++++++++++++++++++++++++++++------------------
pidgin/gtkwhiteboard.h | 31 ++-
pidgin/pidgin.h | 4 +
6 files changed, 302 insertions(+), 178 deletions(-)
diffs (truncated from 1236 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
@@ -42,14 +42,14 @@
#define FINCH_IS_PLUGIN_INFO_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), FINCH_TYPE_PLUGIN_INFO))
#define FINCH_PLUGIN_INFO_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfoClass))
-/** @copydoc _FinchPluginInfo */
typedef struct _FinchPluginInfo FinchPluginInfo;
-/** @copydoc _FinchPluginInfoClass */
typedef struct _FinchPluginInfoClass FinchPluginInfoClass;
typedef GntWidget* (*FinchPluginPrefFrameCb) (void);
/**
+ * FinchPluginInfo:
+ *
* Extends #PurplePluginInfo to hold UI information for finch.
*/
struct _FinchPluginInfo {
@@ -77,27 +77,31 @@ struct _FinchPluginInfoClass {
/*@{*/
/**
+ * finch_plugin_info_get_type:
+ *
* Returns the GType for the FinchPluginInfo object.
*/
GType finch_plugin_info_get_type(void);
/**
+ * finch_plugin_info_new:
+ * @first_property: The first property name
+ * @...: The value of the first property, followed optionally by more
+ * name/value pairs, followed by %NULL
+ *
* Creates a new #FinchPluginInfo instance to be returned from
* gplugin_plugin_query() of a finch plugin, using the provided name/value
* pairs.
*
* See purple_plugin_info_new() for a list of available property names.
- * Additionally, you can provide the property "gnt-pref-frame-cb",
- * which should be a callback that returns a GntWidget for the plugin's
- * preferences (see FinchPluginPrefFrameCb).
+ * Additionally, you can provide the property
+ * <literal>"gnt-pref-frame-cb"</literal>, which should be a callback that
+ * returns a #GntWidget for the plugin's preferences
+ * (see #FinchPluginPrefFrameCb).
*
- * @first_property: The first property name
- * @...: The value of the first property, followed optionally by more
- * name/value pairs, followed by %NULL
+ * @see purple_plugin_info_new()
*
* Returns: A new #FinchPluginInfo instance.
- *
- * @see purple_plugin_info_new()
*/
FinchPluginInfo *finch_plugin_info_new(const char *first_property, ...)
G_GNUC_NULL_TERMINATED;
@@ -110,11 +114,15 @@ FinchPluginInfo *finch_plugin_info_new(c
/*@{*/
/**
+ * 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
@@ -36,14 +36,14 @@
#define PIDGIN_IS_PLUGIN_INFO_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PIDGIN_TYPE_PLUGIN_INFO))
#define PIDGIN_PLUGIN_INFO_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PIDGIN_TYPE_PLUGIN_INFO, PidginPluginInfoClass))
-/** @copydoc _PidginPluginInfo */
typedef struct _PidginPluginInfo PidginPluginInfo;
-/** @copydoc _PidginPluginInfoClass */
typedef struct _PidginPluginInfoClass PidginPluginInfoClass;
typedef GtkWidget *(*PidginPluginConfigFrameCb)(PurplePlugin *);
/**
+ * PidginPluginInfo:
+ *
* Extends #PurplePluginInfo to hold UI information for pidgin.
*/
struct _PidginPluginInfo {
@@ -68,37 +68,45 @@ struct _PidginPluginInfoClass {
G_BEGIN_DECLS
/**
+ * pidgin_plugin_info_get_type:
+ *
* Returns the GType for the PidginPluginInfo object.
*/
GType pidgin_plugin_info_get_type(void);
/**
+ * pidgin_plugin_info_new:
+ * @first_property: The first property name
+ * @...: The value of the first property, followed optionally by more
+ * name/value pairs, followed by %NULL
+ *
* Creates a new #PidginPluginInfo instance to be returned from
* gplugin_plugin_query() of a pidgin plugin, using the provided name/value
* pairs.
*
* See purple_plugin_info_new() for a list of available property names.
- * Additionally, you can provide the property "gtk-config-frame-cb",
- * which should be a callback that returns a GtkWidget for the plugin's
- * configuration (see PidginPluginConfigFrameCb).
+ * Additionally, you can provide the property
+ * <literal>"gtk-config-frame-cb"</literal>, which should be a callback that
+ * returns a #GtkWidget for the plugin's configuration
+ * (see #PidginPluginConfigFrameCb).
*
- * @first_property: The first property name
- * @...: The value of the first property, followed optionally by more
- * name/value pairs, followed by %NULL
+ * @see purple_plugin_info_new()
*
* Returns: A new #PidginPluginInfo instance.
- *
- * @see purple_plugin_info_new()
*/
PidginPluginInfo *pidgin_plugin_info_new(const char *first_property, ...)
G_GNUC_NULL_TERMINATED;
/**
+ * 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.
More information about the Commits
mailing list