/soc/2013/ankitkv/gobjectification: 04c99b24db84: Use gtk-doc st...
Ankit Vani
a at nevitus.org
Tue Jan 28 23:40:37 EST 2014
Changeset: 04c99b24db841b18a1d2d9720cc22b87a25e1835
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-29 10:01 +0530
Branch: soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/04c99b24db84
Description:
Use gtk-doc style constants (%NULL, %TRUE, %FALSE), and 'Note:' instead of '@note'
diffstat:
finch/gntaccount.h | 2 +-
finch/gntblist.h | 10 +-
finch/gntconv.h | 2 +-
finch/gntplugin.h | 2 +-
finch/gntstatus.h | 2 +-
finch/gntxfer.h | 2 +-
finch/libgnt/gnt.h | 20 +++---
finch/libgnt/gntbindable.h | 14 ++--
finch/libgnt/gntbox.h | 8 +-
finch/libgnt/gntcheckbox.h | 4 +-
finch/libgnt/gntentry.h | 6 +-
finch/libgnt/gntfilesel.h | 12 +-
finch/libgnt/gntline.h | 2 +-
finch/libgnt/gntmenu.h | 2 +-
finch/libgnt/gntmenuitem.h | 2 +-
finch/libgnt/gntmenuitemcheck.h | 4 +-
finch/libgnt/gntslider.h | 2 +-
finch/libgnt/gntstyle.h | 14 ++--
finch/libgnt/gnttextview.h | 4 +-
finch/libgnt/gnttree.h | 26 ++++----
finch/libgnt/gntutils.h | 10 +-
finch/libgnt/gntwidget.h | 14 ++--
finch/libgnt/gntwindow.h | 6 +-
finch/libgnt/gntwm.h | 6 +-
finch/libgnt/gntws.h | 4 +-
libpurple/account.h | 44 +++++++-------
libpurple/accounts.h | 2 +-
libpurple/blistnodetypes.h | 4 +-
libpurple/buddyicon.h | 18 ++--
libpurple/buddylist.h | 2 +-
libpurple/cipher.h | 6 +-
libpurple/cmds.h | 12 +-
libpurple/connection.h | 14 ++--
libpurple/conversation.h | 36 +++++-----
libpurple/conversations.h | 10 +-
libpurple/conversationtypes.h | 16 ++--
libpurple/core.h | 6 +-
libpurple/dbus-server.h | 2 +-
libpurple/debug.h | 12 +-
libpurple/e2ee.h | 6 +-
libpurple/eventloop.h | 12 +-
libpurple/http.h | 6 +-
libpurple/imgstore.h | 2 +-
libpurple/internal.h | 12 +-
libpurple/log.h | 12 +-
libpurple/media.h | 14 ++--
libpurple/network.h | 8 +-
libpurple/notify.h | 6 +-
libpurple/ntlm.h | 2 +-
libpurple/plugins.h | 46 +++++++-------
libpurple/pounce.h | 14 ++--
libpurple/prefs.h | 6 +-
libpurple/presence.h | 2 +-
libpurple/protocol.h | 6 +-
libpurple/protocols.h | 12 +-
libpurple/request-datasheet.h | 8 +-
libpurple/request.h | 122 ++++++++++++++++++++--------------------
libpurple/roomlist.h | 36 +++++-----
libpurple/smiley.h | 10 +-
libpurple/status.h | 12 +-
libpurple/stringref.h | 2 +-
libpurple/util.h | 54 ++++++++--------
libpurple/whiteboard.h | 2 +-
libpurple/xfer.h | 4 +-
libpurple/xmlnode.h | 8 +-
pidgin/gtkaccount.h | 2 +-
pidgin/gtkblist.h | 2 +-
pidgin/gtkconv-theme.h | 2 +-
pidgin/gtkimhtml.h | 64 ++++++++++----------
pidgin/gtkplugin.h | 2 +-
pidgin/gtksmiley.h | 4 +-
pidgin/gtkutils.h | 58 +++++++++---------
pidgin/gtkwebview.h | 50 ++++++++--------
pidgin/gtkxfer.h | 2 +-
pidgin/minidialog.h | 6 +-
pidgin/pidgintooltip.h | 10 +-
76 files changed, 495 insertions(+), 495 deletions(-)
diffs (truncated from 3880 to 300 lines):
diff --git a/finch/gntaccount.h b/finch/gntaccount.h
--- a/finch/gntaccount.h
+++ b/finch/gntaccount.h
@@ -58,7 +58,7 @@ void finch_accounts_show_all(void);
/**
* Show the edit dialog for an account.
*
- * @account: The account to edit, or @c NULL to create a new account.
+ * @account: The account to edit, or %NULL to create a new account.
*/
void finch_account_dialog_show(PurpleAccount *account);
diff --git a/finch/gntblist.h b/finch/gntblist.h
--- a/finch/gntblist.h
+++ b/finch/gntblist.h
@@ -78,9 +78,9 @@ void finch_blist_show(void);
* Get the position of the buddy list.
*
* @param x The x-coordinate is set here if not @ NULL.
- * @param y The y-coordinate is set here if not @c NULL.
+ * @param y The y-coordinate is set here if not %NULL.
*
- * Returns: Returns @c TRUE if the values were set, @c FALSE otherwise.
+ * Returns: Returns %TRUE if the values were set, %FALSE otherwise.
*/
gboolean finch_blist_get_position(int *x, int *y);
@@ -96,9 +96,9 @@ void finch_blist_set_position(int x, int
* Get the size of the buddy list.
*
* @width: The width is set here if not @ NULL.
- * @height: The height is set here if not @c NULL.
+ * @height: The height is set here if not %NULL.
*
- * Returns: Returns @c TRUE if the values were set, @c FALSE otherwise.
+ * Returns: Returns %TRUE if the values were set, %FALSE otherwise.
*/
gboolean finch_blist_get_size(int *width, int *height);
@@ -145,7 +145,7 @@ void finch_blist_uninstall_manager(const
*
* @id: The identifier for the desired buddy list manager.
*
- * Returns: The manager with the requested identifier, if available. @c NULL otherwise.
+ * Returns: The manager with the requested identifier, if available. %NULL otherwise.
*/
FinchBlistManager * finch_blist_manager_find(const char *id);
diff --git a/finch/gntconv.h b/finch/gntconv.h
--- a/finch/gntconv.h
+++ b/finch/gntconv.h
@@ -110,7 +110,7 @@ void finch_conversation_set_active(Purpl
* Sets the information widget for the conversation window.
*
* @conv: The conversation.
- * @widget: The widget containing the information. If @c NULL,
+ * @widget: The widget containing the information. If %NULL,
* the current information widget is removed.
*/
void finch_conversation_set_info_widget(PurpleConversation *conv, GntWidget *widget);
diff --git a/finch/gntplugin.h b/finch/gntplugin.h
--- a/finch/gntplugin.h
+++ b/finch/gntplugin.h
@@ -93,7 +93,7 @@ GType finch_plugin_info_get_type(void);
*
* @first_property: The first property name
* @...: The value of the first property, followed optionally by more
- * name/value pairs, followed by @c NULL
+ * name/value pairs, followed by %NULL
*
* Returns: A new #FinchPluginInfo instance.
*
diff --git a/finch/gntstatus.h b/finch/gntstatus.h
--- a/finch/gntstatus.h
+++ b/finch/gntstatus.h
@@ -42,7 +42,7 @@ void finch_savedstatus_show_all(void);
/**
* Show a dialog to edit a status.
*
- * @saved: The saved status to edit. Set it to @c NULL to create a new status.
+ * @saved: The saved status to edit. Set it to %NULL to create a new status.
*/
void finch_savedstatus_edit(PurpleSavedStatus *saved);
diff --git a/finch/gntxfer.h b/finch/gntxfer.h
--- a/finch/gntxfer.h
+++ b/finch/gntxfer.h
@@ -48,7 +48,7 @@ void finch_xfer_dialog_destroy(void);
/**
* Displays the file transfer dialog given.
- * If dialog is @c NULL, displays the default dialog, creating one if necessary
+ * If dialog is %NULL, displays the default dialog, creating one if necessary
*/
void finch_xfer_dialog_show(void);
diff --git a/finch/libgnt/gnt.h b/finch/libgnt/gnt.h
--- a/finch/libgnt/gnt.h
+++ b/finch/libgnt/gnt.h
@@ -52,7 +52,7 @@ void gnt_main(void);
/**
* Check whether the terminal is capable of UTF8 display.
*
- * Returns: @c FALSE if the terminal is capable of drawing UTF-8, @c TRUE otherwise.
+ * Returns: %FALSE if the terminal is capable of drawing UTF-8, %TRUE otherwise.
*/
gboolean gnt_ascii_only(void);
@@ -115,7 +115,7 @@ void gnt_screen_rename_widget(GntWidget
*
* @widget: The widget.
*
- * Returns: @c TRUE if the widget has the current focus, @c FALSE otherwise.
+ * Returns: %TRUE if the widget has the current focus, %FALSE otherwise.
*/
gboolean gnt_widget_has_focus(GntWidget *widget);
@@ -139,7 +139,7 @@ void gnt_register_action(const char *lab
*
* @menu: The menu to display.
*
- * Returns: @c TRUE if the menu is displayed, @c FALSE otherwise (e.g., if another menu is currently displayed).
+ * Returns: %TRUE if the menu is displayed, %FALSE otherwise (e.g., if another menu is currently displayed).
*/
gboolean gnt_screen_menu_show(gpointer menu);
@@ -174,14 +174,14 @@ void gnt_set_clipboard_string(const gcha
*
* @wd: The working directory for the new application.
* @argv: The argument vector.
- * @envp: The environment, or @c NULL.
- * @stin: Location to store the child's stdin, or @c NULL.
- * @stout: Location to store the child's stdout, or @c NULL.
- * @sterr: Location to store the child's stderr, or @c NULL.
+ * @envp: The environment, or %NULL.
+ * @stin: Location to store the child's stdin, or %NULL.
+ * @stout: Location to store the child's stdout, or %NULL.
+ * @sterr: Location to store the child's stderr, or %NULL.
* @callback: The callback to call after the child exits.
* @data: The data to pass to the callback.
*
- * Returns: @c TRUE if the child was successfully spawned, @c FALSE otherwise.
+ * Returns: %TRUE if the child was successfully spawned, %FALSE otherwise.
*/
gboolean gnt_giveup_console(const char *wd, char **argv, char **envp,
gint *stin, gint *stout, gint *sterr,
@@ -190,8 +190,8 @@ gboolean gnt_giveup_console(const char *
/**
* Check whether a child process is in control of the current terminal.
*
- * Returns: @c TRUE if a child process (eg., PAGER) is occupying the current
- * terminal, @c FALSE otherwise.
+ * Returns: %TRUE if a child process (eg., PAGER) is occupying the current
+ * terminal, %FALSE otherwise.
*/
gboolean gnt_is_refugee(void);
diff --git a/finch/libgnt/gntbindable.h b/finch/libgnt/gntbindable.h
--- a/finch/libgnt/gntbindable.h
+++ b/finch/libgnt/gntbindable.h
@@ -124,7 +124,7 @@ void gnt_bindable_action_param_free(GntB
* @klass: The class the binding is for.
* @name: The name of the binding.
* @callback: The callback for the binding.
- * @trigger: The default trigger for the binding, or @c NULL, followed by a NULL-terminated
+ * @trigger: The default trigger for the binding, or %NULL, followed by a NULL-terminated
* list of default parameters.
*/
void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...);
@@ -134,7 +134,7 @@ void gnt_bindable_class_register_action(
*
* @klass: The class the binding is for.
* @name: The name of the binding.
- * @trigger: A new trigger for the binding, followed by a @c NULL-terminated list of parameters for the callback.
+ * @trigger: A new trigger for the binding, followed by a %NULL-terminated list of parameters for the callback.
*/
void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...);
@@ -144,7 +144,7 @@ void gnt_bindable_register_binding(GntBi
* @bindable: The bindable object.
* @keys: The key to trigger the action.
*
- * Returns: @c TRUE if the action was performed successfully, @c FALSE otherwise.
+ * Returns: %TRUE if the action was performed successfully, %FALSE otherwise.
*/
gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys);
@@ -154,7 +154,7 @@ gboolean gnt_bindable_perform_action_key
* @bindable: The bindable object.
* @keys: The key to check for.
*
- * Returns: @c TRUE if the the key has an action associated with it.
+ * Returns: %TRUE if the the key has an action associated with it.
*/
gboolean gnt_bindable_check_key(GntBindable *bindable, const char *keys);
@@ -162,9 +162,9 @@ gboolean gnt_bindable_check_key(GntBinda
* Perform an action on a bindable object.
*
* @bindable: The bindable object.
- * @name: The action to perform, followed by a @c NULL-terminated list of parameters.
+ * @name: The action to perform, followed by a %NULL-terminated list of parameters.
*
- * Returns: @c TRUE if the action was performed successfully, @c FALSE otherwise.
+ * Returns: %TRUE if the action was performed successfully, %FALSE otherwise.
*/
gboolean gnt_bindable_perform_action_named(GntBindable *bindable, const char *name, ...) G_GNUC_NULL_TERMINATED;
@@ -183,7 +183,7 @@ GntBindable * gnt_bindable_bindings_view
*
* @bindable: The object to list the bindings for.
*
- * Returns: @c TRUE
+ * Returns: %TRUE
*/
gboolean gnt_bindable_build_help_window(GntBindable *bindable);
diff --git a/finch/libgnt/gntbox.h b/finch/libgnt/gntbox.h
--- a/finch/libgnt/gntbox.h
+++ b/finch/libgnt/gntbox.h
@@ -99,9 +99,9 @@ GType gnt_box_get_gtype(void);
/**
* Create a new GntBox.
*
- * @homo: If @c TRUE, all the widgets in it will have the same width (or height)
- * @vert: Whether the widgets in it should be stacked vertically (if @c TRUE)
- * or horizontally (if @c FALSE).
+ * @homo: If %TRUE, all the widgets in it will have the same width (or height)
+ * @vert: Whether the widgets in it should be stacked vertically (if %TRUE)
+ * or horizontally (if %FALSE).
*
* Returns: The new GntBox.
*/
@@ -137,7 +137,7 @@ void gnt_box_set_pad(GntBox *box, int pa
* @e .gntrc)
*
* @box: The box
- * @set: @c TRUE if it's a toplevel box, @c FALSE otherwise.
+ * @set: %TRUE if it's a toplevel box, %FALSE otherwise.
*/
void gnt_box_set_toplevel(GntBox *box, gboolean set);
diff --git a/finch/libgnt/gntcheckbox.h b/finch/libgnt/gntcheckbox.h
--- a/finch/libgnt/gntcheckbox.h
+++ b/finch/libgnt/gntcheckbox.h
@@ -85,7 +85,7 @@ GntWidget * gnt_check_box_new(const char
* Set whether the checkbox should be checked or not.
*
* @box: The checkbox.
- * @set: @c TRUE if the checkbox should be selected, @c FALSE otherwise.
+ * @set: %TRUE if the checkbox should be selected, %FALSE otherwise.
*/
void gnt_check_box_set_checked(GntCheckBox *box, gboolean set);
@@ -94,7 +94,7 @@ void gnt_check_box_set_checked(GntCheckB
*
* @box: The checkbox.
*
- * Returns: @c TRUE if the checkbox is selected, @c FALSE otherwise.
+ * Returns: %TRUE if the checkbox is selected, %FALSE otherwise.
*/
gboolean gnt_check_box_get_checked(GntCheckBox *box);
diff --git a/finch/libgnt/gntentry.h b/finch/libgnt/gntentry.h
--- a/finch/libgnt/gntentry.h
+++ b/finch/libgnt/gntentry.h
@@ -161,7 +161,7 @@ void gnt_entry_clear(GntEntry *entry);
* Set whether the text in the entry box should be masked for display.
*
* @entry: The entry box.
- * @set: @c TRUE if the text should be masked, @c FALSE otherwise.
+ * @set: %TRUE if the text should be masked, %FALSE otherwise.
*/
void gnt_entry_set_masked(GntEntry *entry, gboolean set);
@@ -187,7 +187,7 @@ void gnt_entry_set_history_length(GntEnt
* individual word in the entry box.
*
* @entry: The entry box.
- * @word: @c TRUE if the suggestions are for individual words, @c FALSE otherwise.
+ * @word: %TRUE if the suggestions are for individual words, %FALSE otherwise.
*/
void gnt_entry_set_word_suggest(GntEntry *entry, gboolean word);
@@ -196,7 +196,7 @@ void gnt_entry_set_word_suggest(GntEntry
* tab-completion key is pressed (the TAB key, by default).
*
* @entry: The entry box.
- * @always: @c TRUE if the suggestion list should always be displayed.
+ * @always: %TRUE if the suggestion list should always be displayed.
*/
void gnt_entry_set_always_suggest(GntEntry *entry, gboolean always);
diff --git a/finch/libgnt/gntfilesel.h b/finch/libgnt/gntfilesel.h
--- a/finch/libgnt/gntfilesel.h
+++ b/finch/libgnt/gntfilesel.h
@@ -115,7 +115,7 @@ GntWidget * gnt_file_sel_new(void);
* @sel: The file selector.
* @path: The current path of the selector.
*
More information about the Commits
mailing list