Use gtk-doc style constants (%NULL, %TRUE, %FALSE), and 'Note:' instead of '@note'
--- a/gnt.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gnt.h Wed Jan 29 10:01:14 2014 +0530
@@ -52,7 +52,7 @@
* 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 @@
- * 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 @@
* @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 @@
* @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 @@
* 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);
--- a/gntbindable.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntbindable.h Wed Jan 29 10:01:14 2014 +0530
@@ -124,7 +124,7 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* 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 @@
* @bindable: The object to list the bindings for.
gboolean gnt_bindable_build_help_window(GntBindable *bindable);
--- a/gntbox.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntbox.h Wed Jan 29 10:01:14 2014 +0530
@@ -99,9 +99,9 @@
- * @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 @@
- * @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);
--- a/gntcheckbox.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntcheckbox.h Wed Jan 29 10:01:14 2014 +0530
@@ -85,7 +85,7 @@
* Set whether the checkbox should be checked or not.
- * @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 @@
- * 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);
--- a/gntentry.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntentry.h Wed Jan 29 10:01:14 2014 +0530
@@ -161,7 +161,7 @@
* Set whether the text in the entry box should be masked for display.
- * @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 @@
* individual word in 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 @@
* tab-completion key is pressed (the TAB key, by default).
- * @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);
--- a/gntfilesel.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntfilesel.h Wed Jan 29 10:01:14 2014 +0530
@@ -115,7 +115,7 @@
* @sel: The file selector.
* @path: The current path of the selector.
- * Returns: @c TRUE if the current location was successfully changed, @c FALSE otherwise.+ * Returns: %TRUE if the current location was successfully changed, %FALSE otherwise. gboolean gnt_file_sel_set_current_location(GntFileSel *sel, const char *path);
@@ -123,7 +123,7 @@
* Set wheter to only allow selecting directories.
* @sel: The file selector.
- * @dirs: @c TRUE if only directories can be selected, @c FALSE if files+ * @dirs: %TRUE if only directories can be selected, %FALSE if files void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs);
@@ -133,7 +133,7 @@
* @sel: The file selector.
- * Returns: @c TRUE if only directories can be selected.+ * Returns: %TRUE if only directories can be selected. gboolean gnt_file_sel_get_dirs_only(GntFileSel *sel);
@@ -141,7 +141,7 @@
* Set whether a selected file must exist.
* @sel: The file selector.
- * @must: @c TRUE if the selected file must exist.+ * @must: %TRUE if the selected file must exist. void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must);
@@ -150,7 +150,7 @@
* @sel: The file selector.
- * Returns: @c TRUE if the selected file must exist, @c FALSE if a non-existent+ * Returns: %TRUE if the selected file must exist, %FALSE if a non-existent gboolean gnt_file_sel_get_must_exist(GntFileSel *sel);
@@ -179,7 +179,7 @@
* Allow selecting multiple files.
* @sel: The file selector.
- * @set: @c TRUE if selecting multiple files should be allowed.+ * @set: %TRUE if selecting multiple files should be allowed. void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set);
--- a/gntline.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntline.h Wed Jan 29 10:01:14 2014 +0530
@@ -77,7 +77,7 @@
- * @vertical: @c TRUE if the line should be vertical, @c FALSE for a horizontal line.+ * @vertical: %TRUE if the line should be vertical, %FALSE for a horizontal line. * Returns: The newly created line.
--- a/gntmenu.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntmenu.h Wed Jan 29 10:01:14 2014 +0530
@@ -113,7 +113,7 @@
* @id: The ID for an item.
- * Returns: The menuitem with the given ID, or @c NULL.+ * Returns: The menuitem with the given ID, or %NULL. --- a/gntmenuitem.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntmenuitem.h Wed Jan 29 10:01:14 2014 +0530
@@ -122,7 +122,7 @@
- * Returns: The submenu, or @c NULL.+ * Returns: The submenu, or %NULL. --- a/gntmenuitemcheck.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntmenuitemcheck.h Wed Jan 29 10:01:14 2014 +0530
@@ -84,7 +84,7 @@
- * Returns: @c TRUE if the item is checked, @c FALSE otherwise.+ * Returns: %TRUE if the item is checked, %FALSE otherwise. gboolean gnt_menuitem_check_get_checked(GntMenuItemCheck *item);
@@ -92,7 +92,7 @@
* Set whether the menuitem is checked or not.
- * @set: @c TRUE if the item should be checked, @c FALSE otherwise.+ * @set: %TRUE if the item should be checked, %FALSE otherwise. void gnt_menuitem_check_set_checked(GntMenuItemCheck *item, gboolean set);
--- a/gntslider.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntslider.h Wed Jan 29 10:01:14 2014 +0530
@@ -86,7 +86,7 @@
- * @orient: A vertical slider is created if @c TRUE, otherwise the slider is horizontal.+ * @orient: A vertical slider is created if %TRUE, otherwise the slider is horizontal. * @max: The maximum value for the slider
* @min: The minimum value for the slider
--- a/gntstyle.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntstyle.h Wed Jan 29 10:01:14 2014 +0530
@@ -47,18 +47,18 @@
* Get the user-setting for a style.
- * Returns: The user-setting, or @c NULL.+ * Returns: The user-setting, or %NULL. const char *gnt_style_get(GntStyle style);
* Get the value of a preference in ~/.gntrc.
- * @group: The name of the group in the keyfile. If @c NULL, the prgname+ * @group: The name of the group in the keyfile. If %NULL, the prgname * will be used first, if available. Otherwise, "general" will be used.
- * Returns: The value of the setting as a string, or @c NULL+ * Returns: The value of the setting as a string, or %NULL * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -67,7 +67,7 @@
* Get the value of a preference in ~/.gntrc.
- * @group: The name of the group in the keyfile. If @c NULL, the prgname+ * @group: The name of the group in the keyfile. If %NULL, the prgname * will be used first, if available. Otherwise, "general" will be used.
* @length: Return location for the number of strings returned, or NULL
@@ -81,7 +81,7 @@
* Get the value of a color pair in ~/.gntrc.
- * @group: The name of the group in the keyfile. If @c NULL, the prgname+ * @group: The name of the group in the keyfile. If %NULL, the prgname * will be used first, if available. Otherwise, "general" will be used.
@@ -93,7 +93,7 @@
* Parse a boolean preference. For example, if 'value' is "false" (ignoring case)
- * or "0", the return value will be @c FALSE, otherwise @c TRUE.+ * or "0", the return value will be %FALSE, otherwise %TRUE. * @value: The value of the boolean setting as a string
* Returns: The boolean value
@@ -129,7 +129,7 @@
* @name: The name of the window.
* @table: The hastable to store the accel information.
- * Returns: @c TRUE if some accels were read, @c FALSE otherwise.+ * Returns: %TRUE if some accels were read, %FALSE otherwise. gboolean gnt_style_read_menu_accels(const char *name, GHashTable *table);
--- a/gnttextview.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gnttextview.h Wed Jan 29 10:01:14 2014 +0530
@@ -172,8 +172,8 @@
* @name: The name of the tag.
- * @text: The new text for the text. If 'text' is @c NULL, the tag is removed.- * @all: @c TRUE if all of the instancess of the tag should be changed, @c FALSE if+ * @text: The new text for the text. If 'text' is %NULL, the tag is removed. + * @all: %TRUE if all of the instancess of the tag should be changed, %FALSE if * only the first instance should be changed.
* Returns: The number of instances changed.
--- a/gnttree.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gnttree.h Wed Jan 29 10:01:14 2014 +0530
@@ -210,7 +210,7 @@
* @key: A key corresponding to the row in question. If key
- * is @c NULL, the text list for the selected row will+ * is %NULL, the text list for the selected row will * Returns: A list of texts of a row. The list and its data should be
@@ -339,8 +339,8 @@
* @key: The key for the row
- * @parent: The parent of the row, or @c NULL- * @bigbro: The row to insert after, or @c NULL+ * @parent: The parent of the row, or %NULL + * @bigbro: The row to insert after, or %NULL * Returns: The row inserted.
@@ -356,7 +356,7 @@
* @key: The key for the row
- * @set: @c TRUE if the item should be checked, @c FALSE if not+ * @set: %TRUE if the item should be checked, %FALSE if not void gnt_tree_set_choice(GntTree *tree, void *key, gboolean set);
@@ -366,7 +366,7 @@
* @key: The key for the row
- * Returns: @c TRUE if the row is checked, @c FALSE otherwise.+ * Returns: %TRUE if the row is checked, %FALSE otherwise. gboolean gnt_tree_get_choice(GntTree *tree, void *key);
@@ -468,7 +468,7 @@
* Set whether to display the title of the columns.
- * @set: If @c TRUE, the column titles are displayed+ * @set: If %TRUE, the column titles are displayed * @see gnt_tree_set_column_title
* @see gnt_tree_set_column_titles
@@ -499,7 +499,7 @@
* Set whether to show column separators.
- * @set: If @c TRUE, the column separators are displayed+ * @set: If %TRUE, the column separators are displayed void gnt_tree_set_show_separator(GntTree *tree, gboolean set);
@@ -538,7 +538,7 @@
* @col: The index of the column
- * @vis: If @c FALSE, the column will not be displayed+ * @vis: If %FALSE, the column will not be displayed void gnt_tree_set_column_visible(GntTree *tree, int col, gboolean vis);
@@ -548,7 +548,7 @@
* @col: The index of the column
- * @res: If @c FALSE, the column will not be resized when the+ * @res: If %FALSE, the column will not be resized when the * @see gnt_tree_set_col_width
@@ -564,7 +564,7 @@
* @col: The index of the column
- * @bin: @c TRUE if the data for the column is binary+ * @bin: %TRUE if the data for the column is binary void gnt_tree_set_column_is_binary(GntTree *tree, int col, gboolean bin);
@@ -573,7 +573,7 @@
* @col: The index of the column
- * @right: @c TRUE if the text in the column should be right aligned+ * @right: %TRUE if the text in the column should be right aligned * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -609,7 +609,7 @@
* Check whether the user is currently in the middle of a search.
- * Returns: @c TRUE if the user is searching, @c FALSE otherwise.+ * Returns: %TRUE if the user is searching, %FALSE otherwise. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -622,7 +622,7 @@
* @func: The custom search function. The search function is
* sent the tree itself, the key of a row, the search
* string and the content of row in the search column.
- * If the function returns @c TRUE, the row is dislayed,+ * If the function returns %TRUE, the row is dislayed, * @since 2.0.0 (gnt), 2.1.0 (pidgin)
--- a/gntutils.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntutils.h Wed Jan 29 10:01:14 2014 +0530
@@ -36,8 +36,8 @@
* Compute the width and height required to view the text on the screen.
* @text: The text to be displayed.
- * @width: The width required is set here, if not @c NULL.- * @height: The height required is set here, if not @c NULL.+ * @width: The width required is set here, if not %NULL. + * @height: The height required is set here, if not %NULL. void gnt_util_get_text_bound(const char *text, int *width, int *height);
@@ -48,7 +48,7 @@
* @start: The beginning of the string.
* @end: The end of the string. The width returned is the width
* upto (but not including) end. If end is NULL, then start
- * is considered as a @c NULL-terminated string.+ * is considered as a %NULL-terminated string. * Returns: The on-screen width of the string.
@@ -59,7 +59,7 @@
* @len: The length to consider. If non-positive, the entire screenlength is used.
- * @param w The actual width of the string upto the returned offset, if not @c NULL.+ * @param w The actual width of the string upto the returned offset, if not %NULL. * Returns: The string after len offset.
@@ -138,7 +138,7 @@
* @string: The XHTML string
- * Returns: @c TRUE if the string was added to the textview properly, @c FALSE otherwise.+ * Returns: %TRUE if the string was added to the textview properly, %FALSE otherwise. --- a/gntwidget.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntwidget.h Wed Jan 29 10:01:14 2014 +0530
@@ -225,7 +225,7 @@
* @width: The requested width.
* @height: The requested height.
- * Returns: @c TRUE if the new size was confirmed, @c FALSE otherwise.+ * Returns: %TRUE if the new size was confirmed, %FALSE otherwise. gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height);
@@ -235,7 +235,7 @@
* @keys: The keypress on the widget.
- * Returns: @c TRUE if the key-press was handled, @c FALSE otherwise.+ * Returns: %TRUE if the key-press was handled, %FALSE otherwise. gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys);
@@ -247,17 +247,17 @@
* @param x The x-coordinate of the mouse.
* @param y The y-coordinate of the mouse.
- * Returns: @c TRUE if the event was handled, @c FALSE otherwise.+ * Returns: %TRUE if the event was handled, %FALSE otherwise. gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y);
* Give or remove focus to a widget.
- * @set: @c TRUE of focus should be given to the widget, @c FALSE if+ * @set: %TRUE of focus should be given to the widget, %FALSE if * focus should be removed.
- * Returns: @c TRUE if the focus has been changed, @c FALSE otherwise.+ * Returns: %TRUE if the focus has been changed, %FALSE otherwise. gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set);
@@ -291,7 +291,7 @@
* Set whether a widget can take focus or not.
- * @set: @c TRUE if the widget can take focus.+ * @set: %TRUE if the widget can take focus. void gnt_widget_set_take_focus(GntWidget *widget, gboolean set);
@@ -308,7 +308,7 @@
- * Returns: @c TRUE if the widget has shadows. This checks both the user-setting+ * Returns: %TRUE if the widget has shadows. This checks both the user-setting * and whether the widget can have shadows at all.
gboolean gnt_widget_has_shadow(GntWidget *widget);
--- a/gntwindow.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntwindow.h Wed Jan 29 10:01:14 2014 +0530
@@ -91,8 +91,8 @@
- * @homo: @c TRUE if the widgets inside the window should have the same dimensions.- * @vert: @c TRUE if the widgets inside the window should be stacked vertically.+ * @homo: %TRUE if the widgets inside the window should have the same dimensions. + * @vert: %TRUE if the widgets inside the window should be stacked vertically. * Returns: The newly created window.
@@ -112,7 +112,7 @@
- * Returns: The id of the menuitem bound to the keystroke, or @c NULL.+ * Returns: The id of the menuitem bound to the keystroke, or %NULL. --- a/gntwm.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntwm.h Wed Jan 29 10:01:14 2014 +0530
@@ -200,7 +200,7 @@
* @wm: The window-manager.
* @param n Index of the workspace to switch to.
- * Returns: @c TRUE if the switch was successful.+ * Returns: %TRUE if the switch was successful. gboolean gnt_wm_switch_workspace(GntWM *wm, gint n);
@@ -267,7 +267,7 @@
* @wm: The window-manager.
* @string: The input string to process.
- * Returns: @c TRUE of the string was processed, @c FALSE otherwise.+ * Returns: %TRUE of the string was processed, %FALSE otherwise. gboolean gnt_wm_process_input(GntWM *wm, const char *string);
@@ -279,7 +279,7 @@
* @param y The y-coordinate of the mouse.
* @widget: The widget under the mouse.
- * Returns: @c TRUE if the event was handled, @c FALSE otherwise.+ * Returns: %TRUE if the event was handled, %FALSE otherwise. gboolean gnt_wm_process_click(GntWM *wm, GntMouseEvent event, int x, int y, GntWidget *widget);
--- a/gntws.h Wed Jan 29 05:28:33 2014 +0530
+++ b/gntws.h Wed Jan 29 10:01:14 2014 +0530
@@ -79,7 +79,7 @@
* Create a new workspace with the specified name.
- * @name: The desired name of the workspace, or @c NULL.+ * @name: The desired name of the workspace, or %NULL. * Returns: The newly created workspace.
@@ -171,7 +171,7 @@
* Get the name of a workspace.
- * Returns: The name of the workspace (can be @c NULL).+ * Returns: The name of the workspace (can be %NULL). * @since 2.0.0 (gnt), 2.1.0 (pidgin)
