/soc/2013/ankitkv/gobjectification: 4e34bb5d3681: Convert docs f...
Ankit Vani
a at nevitus.org
Sun Feb 2 07:06:03 EST 2014
Changeset: 4e34bb5d3681b1c0b080e59437fdee298c44addf
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 17:33 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/4e34bb5d3681
Description:
Convert docs from doxygen to gtk-doc format for gtksound to pidgintooltip
diffstat:
pidgin/gtksound.h | 14 +-
pidgin/gtkstatus-icon-theme.h | 21 +-
pidgin/gtkstatusbox.h | 23 +-
pidgin/gtkwebview.h | 323 ++++++++++++++++++++++++-----------------
pidgin/gtkwebviewtoolbar.h | 24 ++-
pidgin/gtkxfer.h | 52 ++++--
pidgin/minidialog.h | 172 ++++++++++++++-------
pidgin/pidginstock.h | 28 ++-
pidgin/pidgintooltip.h | 20 +-
9 files changed, 427 insertions(+), 250 deletions(-)
diffs (truncated from 1537 to 300 lines):
diff --git a/pidgin/gtksound.h b/pidgin/gtksound.h
--- a/pidgin/gtksound.h
+++ b/pidgin/gtksound.h
@@ -36,22 +36,28 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * pidgin_sound_get_event_option:
+ * @event: The event.
+ *
* Get the prefs option for an event.
*
- * @event: The event.
* Returns: The option.
*/
const char *pidgin_sound_get_event_option(PurpleSoundEventID event);
/**
+ * pidgin_sound_get_event_label:
+ * @event: The event.
+ *
* Get the label for an event.
*
- * @event: The event.
* Returns: The label.
*/
const char *pidgin_sound_get_event_label(PurpleSoundEventID event);
/**
+ * pidgin_sound_get_ui_ops:
+ *
* Gets GTK+ sound UI ops.
*
* Returns: The UI operations structure.
@@ -59,6 +65,8 @@ const char *pidgin_sound_get_event_label
PurpleSoundUiOps *pidgin_sound_get_ui_ops(void);
/**
+ * pidgin_sound_get_handle:
+ *
* Get the handle for the GTK+ sound system.
*
* Returns: The handle to the sound system
@@ -66,6 +74,8 @@ PurpleSoundUiOps *pidgin_sound_get_ui_op
void *pidgin_sound_get_handle(void);
/**
+ * pidgin_sound_is_customized:
+ *
* Returns true Pidgin is using customized sounds
*
* Returns: TRUE if non default sounds are used.
diff --git a/pidgin/gtkstatus-icon-theme.h b/pidgin/gtkstatus-icon-theme.h
--- a/pidgin/gtkstatus-icon-theme.h
+++ b/pidgin/gtkstatus-icon-theme.h
@@ -29,13 +29,6 @@
#include <glib-object.h>
#include "gtkicon-theme.h"
-/**
- * extends PidginIconTheme (gtkicon-theme.h)
- * A pidgin status icon theme.
- * This object represents a Pidgin status icon theme.
- *
- * PidginStatusIconTheme is a PidginIconTheme Object.
- */
typedef struct _PidginStatusIconTheme PidginStatusIconTheme;
typedef struct _PidginStatusIconThemeClass PidginStatusIconThemeClass;
@@ -46,6 +39,15 @@ typedef struct _PidginStatusIconThemeCla
#define PIDGIN_IS_STATUS_ICON_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_STATUS_ICON_THEME))
#define PIDGIN_STATUS_ICON_THEME_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_STATUS_ICON_THEME, PidginStatusIconThemeClass))
+/**
+ * PidginStatusIconTheme:
+ *
+ * extends PidginIconTheme (gtkicon-theme.h)
+ * A pidgin status icon theme.
+ * This object represents a Pidgin status icon theme.
+ *
+ * PidginStatusIconTheme is a PidginIconTheme Object.
+ */
struct _PidginStatusIconTheme
{
PidginIconTheme parent;
@@ -57,15 +59,18 @@ struct _PidginStatusIconThemeClass
};
/**************************************************************************/
-/** @name Pidgin Status Icon Theme API */
+/** @name Pidgin Status Icon Theme API */
/**************************************************************************/
G_BEGIN_DECLS
/**
+ * pidgin_status_icon_theme_get_type:
+ *
* GObject foo.
* @internal.
*/
GType pidgin_status_icon_theme_get_type(void);
G_END_DECLS
+
#endif /* PIDGIN_STATUS_ICON_THEME_H */
diff --git a/pidgin/gtkstatusbox.h b/pidgin/gtkstatusbox.h
--- a/pidgin/gtkstatusbox.h
+++ b/pidgin/gtkstatusbox.h
@@ -45,6 +45,8 @@ G_BEGIN_DECLS
#define PIDGIN_STATUS_BOX_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), PIDGIN_TYPE_STATUS_BOX, PidginStatusBoxClass))
/**
+ * PidginStatusBoxItemType:
+ *
* This is a hidden field in the GtkStatusBox that identifies the
* item in the list store. The item could be a normal
* PurpleStatusPrimitive, or it could be something special like the
@@ -64,26 +66,25 @@ typedef enum
typedef struct _PidginStatusBox PidginStatusBox;
typedef struct _PidginStatusBoxClass PidginStatusBoxClass;
+/**
+ * PidginStatusBox:
+ * @store: This GtkListStore contains only one row--the currently
+ * selected status.
+ * @dropdown_store: This is the dropdown GtkListStore that contains the
+ * available statuses, plus some recently used statuses, plus
+ * the "Custom..." and "Saved..." options.
+ * @token_status_account: This will be non-NULL and contain a sample account
+ * when all enabled accounts use the same statuses
+ */
struct _PidginStatusBox
{
GtkContainer parent_instance;
- /**
- * This GtkListStore contains only one row--the currently selected status.
- */
GtkListStore *store;
-
- /**
- * This is the dropdown GtkListStore that contains the available statuses,
- * plus some recently used statuses, plus the "Custom..." and "Saved..."
- * options.
- */
GtkListStore *dropdown_store;
PurpleAccount *account;
- /* This will be non-NULL and contain a sample account
- * when all enabled accounts use the same statuses */
PurpleAccount *token_status_account;
GtkWidget *vbox, *sw;
diff --git a/pidgin/gtkwebview.h b/pidgin/gtkwebview.h
--- a/pidgin/gtkwebview.h
+++ b/pidgin/gtkwebview.h
@@ -109,6 +109,8 @@ struct _GtkWebViewClass
G_BEGIN_DECLS
/**
+ * gtk_webview_get_type:
+ *
* Returns the GType for a GtkWebView widget
*
* Returns: The GType for GtkWebView widget
@@ -116,162 +118,176 @@ G_BEGIN_DECLS
GType gtk_webview_get_type(void);
/**
+ * gtk_webview_new:
+ * @editable: Whether this GtkWebView will be user-editable
+ *
* Create a new GtkWebView object
*
- * @editable: Whether this GtkWebView will be user-editable
- *
* Returns: A GtkWidget corresponding to the GtkWebView object
*/
GtkWidget *gtk_webview_new(gboolean editable);
/**
+ * gtk_webview_append_html:
+ * @webview: The GtkWebView object
+ * @markup: The html markup to append
+ *
* A very basic routine to append html, which can be considered
* equivalent to a "document.write" using JavaScript.
- *
- * @webview: The GtkWebView object
- * @markup: The html markup to append
*/
void gtk_webview_append_html(GtkWebView *webview, const char *markup);
/**
- * Requests loading of the given content.
- *
+ * gtk_webview_load_html_string:
* @webview: The GtkWebView object
* @html: The HTML content to load
+ *
+ * Requests loading of the given content.
*/
void gtk_webview_load_html_string(GtkWebView *webview, const char *html);
/**
+ * gtk_webview_load_html_string_with_selection:
+ * @webview: The GtkWebView object
+ * @html: The HTML content to load
+ *
* Requests loading of the given content and sets the selection. You must
* include an anchor tag with id='caret' in the HTML string, which will be
* used to set the selection. This tag is then removed so that querying the
* WebView's HTML contents will no longer return it.
- *
- * @webview: The GtkWebView object
- * @html: The HTML content to load
*/
void gtk_webview_load_html_string_with_selection(GtkWebView *webview, const char *html);
/**
+ * gtk_webview_safe_execute_script:
+ * @webview: The GtkWebView object
+ * @script: The script to execute
+ *
* Execute the JavaScript only after the webkit_webview_load_string
* loads completely. We also guarantee that the scripts are executed
* in the order they are called here. This is useful to avoid race
* conditions when calling JS functions immediately after opening the
* page.
- *
- * @webview: The GtkWebView object
- * @script: The script to execute
*/
void gtk_webview_safe_execute_script(GtkWebView *webview, const char *script);
/**
+ * gtk_webview_quote_js_string:
+ * @str: The string to escape and quote
+ *
* A convenience routine to quote a string for use as a JavaScript
* string. For instance, "hello 'world'" becomes "'hello \\'world\\''"
*
- * @str: The string to escape and quote
- *
* Returns: The quoted string
*/
char *gtk_webview_quote_js_string(const char *str);
/**
- * Set the vertical adjustment for the GtkWebView.
- *
+ * gtk_webview_set_vadjustment:
* @webview: The GtkWebView object
* @vadj: The GtkAdjustment that control the webview
+ *
+ * Set the vertical adjustment for the GtkWebView.
*/
void gtk_webview_set_vadjustment(GtkWebView *webview, GtkAdjustment *vadj);
/**
- * Scrolls the Webview to the end of its contents.
- *
+ * gtk_webview_scroll_to_end:
* @webview: The GtkWebView object
* @smooth: A boolean indicating if smooth scrolling should be used
+ *
+ * Scrolls the Webview to the end of its contents.
*/
void gtk_webview_scroll_to_end(GtkWebView *webview, gboolean smooth);
/**
+ * gtk_webview_set_autoscroll:
+ * @webview: The GtkWebView object
+ * @scroll: Whether to automatically scroll
+ *
* Set whether the GtkWebView stays at its end when HTML content is appended. If
* not already at the end before appending, then scrolling will not occur.
- *
- * @webview: The GtkWebView object
- * @scroll: Whether to automatically scroll
*/
void gtk_webview_set_autoscroll(GtkWebView *webview, gboolean scroll);
/**
+ * gtk_webview_get_autoscroll:
+ * @webview: The GtkWebView object
+ *
* Set whether the GtkWebView stays at its end when HTML content is appended. If
* not already at the end before appending, then scrolling will not occur.
*
- * @webview: The GtkWebView object
- *
* Returns: Whether to automatically scroll
*/
gboolean gtk_webview_get_autoscroll(GtkWebView *webview);
/**
+ * gtk_webview_page_up:
+ * @webview: The GtkWebView.
More information about the Commits
mailing list