--- a/gnt.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gnt.h Fri Jan 31 18:14:33 2014 +0530
@@ -52,7 +52,7 @@
* Check whether the terminal is capable of UTF8 display.
- * @return @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);
@@ -60,7 +60,7 @@
* Present a window. If the event was triggered because of user interaction,
* the window is moved to the foreground. Otherwise, the Urgent hint is set.
- * @param window The window the present.+ * @window: The window the present. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -87,59 +87,59 @@
- * @param widget The widget to resize.- * @param width The desired width.- * @param height The desired height.+ * @widget: The widget to resize. + * @width: The desired width. + * @height: The desired height. void gnt_screen_resize_widget(GntWidget *widget, int width, int height);
- * @param widget The widget to move.- * @param x The desired x-coordinate.- * @param y The desired y-coordinate.+ * @widget: The widget to move. + * @x: The desired x-coordinate. + * @y: The desired y-coordinate. void gnt_screen_move_widget(GntWidget *widget, int x, int y);
- * @param widget The widget to rename.- * @param text The new name for the widget.+ * @widget: The widget to rename. + * @text: The new name for the widget. void gnt_screen_rename_widget(GntWidget *widget, const char *text);
* Check whether a widget has focus.
- * @param widget The widget.- * @return @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);
* Set the URGENT hint for a widget.
- * @param widget The widget to set the URGENT hint for.+ * @widget: The widget to set the URGENT hint for. void gnt_widget_set_urgent(GntWidget *widget);
* Register a global action.
- * @param label The user-visible label for the action.- * @param callback The callback function for the action.+ * @label: The user-visible label for the action. + * @callback: The callback function for the action. void gnt_register_action(const char *label, void (*callback)(void));
- * @param menu The menu to display.+ * @menu: The menu to display. - * @return @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);
@@ -151,37 +151,37 @@
* Get the global clipboard.
- * @return The clipboard.+ * Returns: The clipboard. GntClipboard * gnt_get_clipboard(void);
* Get the string in the clipboard.
- * @return A copy of the string in the clipboard. The caller must @c g_free the string.+ * Returns: A copy of the string in the clipboard. The caller must @c g_free the string. gchar * gnt_get_clipboard_string(void);
* Set the contents of the global clipboard.
- * @param string The new content of the new clipboard.+ * @string: The new content of the new clipboard. void gnt_set_clipboard_string(const gchar *string);
* Spawn a different application that will consume the console.
- * @param wd The working directory for the new application.- * @param argv The argument vector.- * @param envp The environment, or @c NULL.- * @param stin Location to store the child's stdin, or @c NULL.- * @param stout Location to store the child's stdout, or @c NULL.- * @param sterr Location to store the child's stderr, or @c NULL.- * @param callback The callback to call after the child exits.- * @param data The data to pass to the callback.+ * @wd: The working directory for the new application. + * @argv: The argument vector. + * @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. - * @return @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.
- * @return @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 Fri Jan 31 17:48:12 2014 +0530
+++ b/gntbindable.h Fri Jan 31 18:14:33 2014 +0530
@@ -69,7 +69,7 @@
GType gnt_bindable_get_gtype(void);
@@ -107,24 +107,24 @@
* Free a bindable action.
- * @param action The bindable action.+ * @action: The bindable action. void gnt_bindable_action_free(GntBindableAction *action);
* Free a GntBindableActionParam.
- * @param param The GntBindableActionParam to free.+ * @param: The GntBindableActionParam to free. void gnt_bindable_action_param_free(GntBindableActionParam *param);
* Register a bindable action for a class.
- * @param klass The class the binding is for.- * @param name The name of the binding.- * @param callback The callback for the binding.- * @param trigger The default trigger for the binding, or @c NULL, followed by a NULL-terminated+ * @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 %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, ...);
@@ -132,48 +132,48 @@
* Register a key-binding to an existing action.
- * @param klass The class the binding is for.- * @param name The name of the binding.- * @param trigger A new trigger for the binding, followed by a @c NULL-terminated list of parameters for the callback.+ * @klass: The class the binding is for. + * @name: The name of the binding. + * @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, ...);
* Perform an action from a keybinding.
- * @param bindable The bindable object.- * @param keys The key to trigger the action.+ * @bindable: The bindable object. + * @keys: The key to trigger the action. - * @return @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);
* Discover if a key is bound.
- * @param bindable The bindable object.- * @param keys The key to check for.+ * @bindable: The bindable object. + * @keys: The key to check for. - * @return @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);
* Perform an action on a bindable object.
- * @param bindable The bindable object.- * @param name The action to perform, followed by a @c NULL-terminated list of parameters.+ * @bindable: The bindable object. + * @name: The action to perform, followed by a %NULL-terminated list of parameters. - * @return @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;
* Returns a GntTree populated with "key" -> "binding" for the widget.
- * @param bind The object to list the bindings for.+ * @bind: The object to list the bindings for.
+ * Returns: The GntTree. GntBindable * gnt_bindable_bindings_view(GntBindable *bind);
@@ -181,9 +181,9 @@
* Builds a window that list the key bindings for a GntBindable object.
* From this window a user can select a listing to rebind a new key for the given action.
- * @param bindable The object to list the bindings for.+ * @bindable: The object to list the bindings for.
gboolean gnt_bindable_build_help_window(GntBindable *bindable);
--- a/gntbox.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gntbox.h Fri Jan 31 18:14:33 2014 +0530
@@ -89,7 +89,7 @@
GType gnt_box_get_gtype(void);
@@ -99,35 +99,35 @@
- * @param homo If @c TRUE, all the widgets in it will have the same width (or height)- * @param 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). - * @return The new GntBox.+ * Returns: The new GntBox. GntWidget * gnt_box_new(gboolean homo, gboolean vert);
* Add a widget in the box.
- * @param widget The widget to add+ * @widget: The widget to add void gnt_box_add_widget(GntBox *box, GntWidget *widget);
* Set a title for the box.
- * @param title The title to set+ * @title: The title to set void gnt_box_set_title(GntBox *box, const char *title);
* Set the padding to use between the widgets in the box.
- * @param pad The padding to use+ * @pad: The padding to use void gnt_box_set_pad(GntBox *box, int pad);
@@ -136,38 +136,38 @@
* then it will show borders, the title (if set) and shadow (if enabled in
- * @param 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);
* Reposition and refresh the widgets in the box.
void gnt_box_sync_children(GntBox *box);
* Set the alignment for the widgets in the box.
- * @param alignment The alignment to use+ * @alignment: The alignment to use void gnt_box_set_alignment(GntBox *box, GntAlignment alignment);
* Remove a widget from the box. Calling this does NOT destroy the removed widget.
- * @param widget The widget to remove+ * @widget: The widget to remove void gnt_box_remove(GntBox *box, GntWidget *widget);
* Remove all widgets from the box. This DOES destroy all widgets in the box.
void gnt_box_remove_all(GntBox *box);
@@ -175,23 +175,23 @@
* Readjust the size of each child widget, reposition the child widgets and
* recalculate the size of the box.
void gnt_box_readjust(GntBox *box);
* Set whether the widgets in the box should fill the empty spaces.
- * @param fill Whether the child widgets should fill the empty space+ * @fill: Whether the child widgets should fill the empty space void gnt_box_set_fill(GntBox *box, gboolean fill);
* Move the focus from one widget to the other.
- * @param dir The direction. If it's 1, then the focus is moved forwards, if it's+ * @dir: The direction. If it's 1, then the focus is moved forwards, if it's * -1, the focus is moved backwards.
void gnt_box_move_focus(GntBox *box, int dir);
@@ -199,8 +199,8 @@
* Give focus to a specific child widget.
- * @param widget The child widget to give focus+ * @widget: The child widget to give focus void gnt_box_give_focus_to_child(GntBox *box, GntWidget *widget);
--- a/gntentry.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gntentry.h Fri Jan 31 18:14:33 2014 +0530
@@ -104,64 +104,64 @@
- * @return GType for GntEntry.+ * Returns: GType for GntEntry. GType gnt_entry_get_gtype(void);
- * @param text The text in the new entry box.+ * @text: The text in the new entry box. - * @return The newly created entry box.+ * Returns: The newly created entry box. GntWidget * gnt_entry_new(const char *text);
* Set the maximum length of the text in the entry box.
- * @param entry The entry box.- * @param max The maximum length for text. A value of 0 means infinite length.+ * @entry: The entry box. + * @max: The maximum length for text. A value of 0 means infinite length. void gnt_entry_set_max(GntEntry *entry, int max);
* Set the text in an entry box.
- * @param entry The entry box.- * @param text The text to set in the box.+ * @entry: The entry box. + * @text: The text to set in the box. void gnt_entry_set_text(GntEntry *entry, const char *text);
* Set flags an entry box.
- * @param entry The entry box.- * @param flag The flags to set for the entry box.+ * @entry: The entry box. + * @flag: The flags to set for the entry box. void gnt_entry_set_flag(GntEntry *entry, GntEntryFlag flag);
* Get the text in an entry box.
- * @param entry The entry box.+ * @entry: The entry box. - * @return The current text in the entry box.+ * Returns: The current text in the entry box. const char *gnt_entry_get_text(GntEntry *entry);
* Clear the text in the entry box.
- * @param entry The entry box.+ * @entry: The entry box. void gnt_entry_clear(GntEntry *entry);
* Set whether the text in the entry box should be masked for display.
- * @param entry The entry box.- * @param set @c TRUE if the text should be masked, @c FALSE otherwise.+ * @entry: The entry box. + * @set: %TRUE if the text should be masked, %FALSE otherwise. void gnt_entry_set_masked(GntEntry *entry, gboolean set);
@@ -169,16 +169,16 @@
* Add a text to the history list for the text. The history length for the
* entry box needs to be set first by gnt_entry_set_history_length.
- * @param entry The entry box.- * @param text A new entry for the history list.+ * @entry: The entry box. + * @text: A new entry for the history list. void gnt_entry_add_to_history(GntEntry *entry, const char *text);
* Set the length of history for the entry box.
- * @param entry The entry box.- * @param num The maximum length of the history, -1 for unlimited.+ * @entry: The entry box. + * @num: The maximum length of the history, -1 for unlimited. void gnt_entry_set_history_length(GntEntry *entry, int num);
@@ -186,8 +186,8 @@
* Set whether the suggestions are for the entire entry box, or for each
* individual word in the entry box.
- * @param entry The entry box.- * @param word @c TRUE if the suggestions are for individual words, @c FALSE otherwise.+ * @entry: The entry box. + * @word: %TRUE if the suggestions are for individual words, %FALSE otherwise. void gnt_entry_set_word_suggest(GntEntry *entry, gboolean word);
@@ -195,24 +195,24 @@
* Set whether to always display the suggestions list, or only when the
* tab-completion key is pressed (the TAB key, by default).
- * @param entry The entry box.- * @param always @c TRUE if the suggestion list should always be displayed.+ * @entry: The entry box. + * @always: %TRUE if the suggestion list should always be displayed. void gnt_entry_set_always_suggest(GntEntry *entry, gboolean always);
* Add an item to the suggestion list.
- * @param entry The entry box.- * @param text An item to add to the suggestion list.+ * @entry: The entry box. + * @text: An item to add to the suggestion list. void gnt_entry_add_suggest(GntEntry *entry, const char *text);
* Remove an entry from the suggestion list.
- * @param entry The entry box.- * @param text The item to remove from the suggestion list.+ * @entry: The entry box. + * @text: The item to remove from the suggestion list. void gnt_entry_remove_suggest(GntEntry *entry, const char *text);
--- a/gntfilesel.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gntfilesel.h Fri Jan 31 18:14:33 2014 +0530
@@ -98,32 +98,32 @@
- * @return GType for GntFileSel.+ * Returns: GType for GntFileSel. GType gnt_file_sel_get_gtype(void);
* Create a new file selector.
- * @return The newly created file selector.+ * Returns: The newly created file selector. GntWidget * gnt_file_sel_new(void);
* Set the current location of the file selector.
- * @param sel The file selector.- * @param path The current path of the selector.+ * @sel: The file selector. + * @path: The current path of the selector. - * @return @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);
* Set wheter to only allow selecting directories.
- * @param sel The file selector.- * @param dirs @c TRUE if only directories can be selected, @c FALSE if files+ * @sel: The file selector. + * @dirs: %TRUE if only directories can be selected, %FALSE if files void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs);
@@ -131,26 +131,26 @@
* Check whether the file selector allows only selecting directories.
- * @param sel The file selector.+ * @sel: The file selector. - * @return @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);
* Set whether a selected file must exist.
- * @param sel The file selector.- * @param must @c TRUE if the selected file must exist.+ * @sel: The file selector. + * @must: %TRUE if the selected file must exist. void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must);
* Check whether the selector allows selecting non-existent files.
- * @param sel The file selector.+ * @sel: The file selector. - * @return @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);
@@ -158,9 +158,9 @@
* Get the selected file in the selector.
- * @param sel The file selector.+ * @sel: The file selector. - * @return The path of the selected file. The caller should g_free the returned+ * Returns: The path of the selected file. The caller should g_free the returned char * gnt_file_sel_get_selected_file(GntFileSel *sel);
@@ -168,9 +168,9 @@
* Get the list of selected files in the selector.
- * @param sel The file selector.+ * @sel: The file selector. - * @return A list of paths for the selected files. The caller must g_free the+ * Returns: A list of paths for the selected files. The caller must g_free the * contents of the list, and g_list_free the list.
GList * gnt_file_sel_get_selected_multi_files(GntFileSel *sel);
@@ -178,43 +178,43 @@
* Allow selecting multiple files.
- * @param sel The file selector.- * @param set @c TRUE if selecting multiple files should be allowed.+ * @sel: The file selector. + * @set: %TRUE if selecting multiple files should be allowed. void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set);
* Set the suggested file to have selected at startup.
- * @param sel The file selector.- * @param suggest The suggested filename.+ * @sel: The file selector. + * @suggest: The suggested filename. void gnt_file_sel_set_suggested_filename(GntFileSel *sel, const char *suggest);
* Set custom functions to read the names of files.
- * @param sel The file selector.- * @param read_fn The custom read function.+ * @sel: The file selector. + * @read_fn: The custom read function. void gnt_file_sel_set_read_fn(GntFileSel *sel, gboolean (*read_fn)(const char *path, GList **files, GError **error));
- * @param name The name of the file.- * @param size The size of the file.+ * @name: The name of the file. + * @size: The size of the file. - * @return The newly created GntFile.+ * Returns: The newly created GntFile. GntFile* gnt_file_new(const char *name, unsigned long size);
* Create a new GntFile for a directory.
- * @param name The name of the directory.+ * @name: The name of the directory. - * @return The newly created GntFile.+ * Returns: The newly created GntFile. GntFile* gnt_file_new_dir(const char *name);
--- a/gntstyle.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gntstyle.h Fri Jan 31 18:14:33 2014 +0530
@@ -40,25 +40,25 @@
* Read configuration from a file.
- * @param filename The filename to read configuration from.+ * @filename: The filename to read configuration from. void gnt_style_read_configure_file(const char *filename);
* Get the user-setting for a style.
- * @param style The style.- * @return 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.
- * @param 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.
- * @return 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,12 +67,12 @@
* Get the value of a preference in ~/.gntrc.
- * @param 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.
- * @param length Return location for the number of strings returned, or NULL+ * @length: Return location for the number of strings returned, or NULL - * @return NULL terminated string array. The array should be freed with g_strfreev().+ * Returns: NULL terminated string array. The array should be freed with g_strfreev(). @@ -81,11 +81,11 @@
* Get the value of a color pair in ~/.gntrc.
- * @param 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.
- * @return The value of the color as an int, or 0 on error.+ * Returns: The value of the color as an int, or 0 on error. @@ -93,10 +93,10 @@
* 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. - * @param value The value of the boolean setting as a string- * @return The boolean value+ * @value: The value of the boolean setting as a string + * Returns: The boolean value * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -105,11 +105,11 @@
* Get the boolean value for a user-setting.
- * @param style The style.- * @param def The default value (i.e, the value if the user didn't define+ * @def: The default value (i.e, the value if the user didn't define - * @return The value of the setting.+ * Returns: The value of the setting. gboolean gnt_style_get_bool(GntStyle style, gboolean def);
@@ -126,10 +126,10 @@
* Read menu-accels from ~/.gntrc
- * @param name The name of the window.- * @param table The hastable to store the accel information.+ * @name: The name of the window. + * @table: The hastable to store the accel information. - * @return @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 Fri Jan 31 17:48:12 2014 +0530
+++ b/gnttextview.h Fri Jan 31 18:14:33 2014 +0530
@@ -88,40 +88,40 @@
- * @return GType for GntTextView.+ * Returns: GType for GntTextView. GType gnt_text_view_get_gtype(void);
- * @return The newly created textview.+ * Returns: The newly created textview. GntWidget * gnt_text_view_new(void);
- * @param view The textview to scroll.- * @param scroll scroll > 0 means scroll up, < 0 means scroll down, == 0 means scroll to the end.+ * @view: The textview to scroll. + * @scroll: scroll > 0 means scroll up, < 0 means scroll down, == 0 means scroll to the end. void gnt_text_view_scroll(GntTextView *view, int scroll);
* Append new text in a textview.
- * @param view The textview.- * @param text The text to append to the textview.- * @param flags The text-flags to apply to the new text.+ * @text: The text to append to the textview. + * @flags: The text-flags to apply to the new text. void gnt_text_view_append_text_with_flags(GntTextView *view, const char *text, GntTextFormatFlags flags);
* Append text in the textview, with some identifier (tag) for the added text.
- * @param view The textview.- * @param text The text to append.- * @param flags The text-flags to apply to the new text.- * @param tag The tag for the appended text, so it can be changed later (@see gnt_text_view_tag_change)+ * @text: The text to append. + * @flags: The text-flags to apply to the new text. + * @tag: The tag for the appended text, so it can be changed later (@see gnt_text_view_tag_change) void gnt_text_view_append_text_with_tag(GntTextView *view, const char *text, GntTextFormatFlags flags, const char *tag);
@@ -129,54 +129,54 @@
* Move the cursor to the beginning of the next line and resets text-attributes.
* It first completes the current line with the current text-attributes.
- * @param view The textview. void gnt_text_view_next_line(GntTextView *view);
* Convert GNT-text formats to ncurses-text attributes.
- * @param flags The GNT text format.+ * @flags: The GNT text format. - * @return Nucrses text attribute.+ * Returns: Nucrses text attribute. chtype gnt_text_format_flag_to_chtype(GntTextFormatFlags flags);
* Clear the contents of the textview.
- * @param view The textview. void gnt_text_view_clear(GntTextView *view);
* The number of lines below the bottom-most visible line.
- * @param view The textview.- * @return Number of lines below the bottom-most visible line.+ * Returns: Number of lines below the bottom-most visible line. int gnt_text_view_get_lines_below(GntTextView *view);
* The number of lines above the topmost visible line.
- * @param view The textview.- * @return Number of lines above the topmost visible line.+ * Returns: Number of lines above the topmost visible line. int gnt_text_view_get_lines_above(GntTextView *view);
* Change the text of a tag.
- * @param view The textview.- * @param name The name of the tag.- * @param text The new text for the text. If 'text' is @c NULL, the tag is removed.- * @param all @c TRUE if all of the instancess of the tag should be changed, @c FALSE if+ * @name: The name of the tag. + * @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.
- * @return The number of instances changed.+ * Returns: The number of instances changed. int gnt_text_view_tag_change(GntTextView *view, const char *name, const char *text, gboolean all);
@@ -184,8 +184,8 @@
* Setup hooks so that pressing up/down/page-up/page-down keys when 'widget' is
* in focus scrolls the textview.
- * @param view The textview.- * @param widget The trigger widget.+ * @widget: The trigger widget. void gnt_text_view_attach_scroll_widget(GntTextView *view, GntWidget *widget);
@@ -203,8 +203,8 @@
- * @param view The textview.- * @param pager The widget to trigger the PAGER.+ * @pager: The widget to trigger the PAGER. void gnt_text_view_attach_pager_widget(GntTextView *view, GntWidget *pager);
@@ -222,16 +222,16 @@
- * @param view The textview.- * @param widget The widget to trigger the EDITOR.+ * @widget: The widget to trigger the EDITOR. void gnt_text_view_attach_editor_widget(GntTextView *view, GntWidget *widget);
* Set a GntTextViewFlag for the textview widget.
- * @param view The textview widget- * @param flag The flag to set+ * @view: The textview widget + * @flag: The flag to set * @since 2.0.0 (gnt), 2.1.0 (pidgin)
--- a/gnttree.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gnttree.h Fri Jan 31 18:14:33 2014 +0530
@@ -102,14 +102,14 @@
- * @return The GType for GntTree+ * Returns: The GType for GntTree GType gnt_tree_get_gtype(void);
* Create a tree with one column.
- * @return The newly created tree+ * Returns: The newly created tree * @see gnt_tree_new_with_columns
@@ -118,9 +118,9 @@
* Create a tree with a specified number of columns.
- * @param columns Number of columns+ * @columns: Number of columns - * @return The newly created tree+ * Returns: The newly created tree @@ -129,25 +129,25 @@
* The number of rows the tree should display at a time.
- * @param rows The number of rows+ * @rows: The number of rows void gnt_tree_set_visible_rows(GntTree *tree, int rows);
* Get the number visible rows.
- * @return The number of visible rows+ * Returns: The number of visible rows int gnt_tree_get_visible_rows(GntTree *tree);
* Scroll the contents of the tree.
- * @param count If positive, the tree will be scrolled down by count rows,+ * @count: If positive, the tree will be scrolled down by count rows, * otherwise, it will be scrolled up by count rows.
void gnt_tree_scroll(GntTree *tree, int count);
@@ -155,13 +155,13 @@
* Insert a row in the tree.
- * @param key The key for the row- * @param row The row to insert- * @param parent The key for the parent row- * @param bigbro The key for the row to insert the new row after.+ * @key: The key for the row + * @row: The row to insert + * @parent: The key for the parent row + * @bigbro: The key for the row to insert the new row after. - * @return The inserted row+ * Returns: The inserted row * @see gnt_tree_create_row
* @see gnt_tree_add_row_last
@@ -172,12 +172,12 @@
* Insert a row at the end of the tree.
- * @param key The key for the row- * @param row The row to insert- * @param parent The key for the parent row+ * @key: The key for the row + * @row: The row to insert + * @parent: The key for the parent row - * @return The inserted row+ * Returns: The inserted row * @see gnt_tree_create_row
* @see gnt_tree_add_row_after
@@ -188,18 +188,18 @@
* Get the key for the selected row.
- * @return The key for the selected row+ * Returns: The key for the selected row gpointer gnt_tree_get_selection_data(GntTree *tree);
* Get the text displayed for the selected row.
- * @return The text, which needs to be freed by the caller+ * Returns: The text, which needs to be freed by the caller * @see gnt_tree_get_row_text_list
* @see gnt_tree_get_selection_text_list
@@ -208,12 +208,12 @@
* Get a list of text for a row.
- * @param key A key corresponding to the row in question. If key- * is @c NULL, the text list for the selected row will+ * @key: A key corresponding to the row in question. If key + * is %NULL, the text list for the selected row will - * @return A list of texts of a row. The list and its data should be+ * Returns: A list of texts of a row. The list and its data should be * freed by the caller. The caller should make sure that if
* any column of the tree contains binary data, it's not freed.
* @see gnt_tree_get_selection_text_list
@@ -224,10 +224,10 @@
- * @param row The GntTreeRow object+ * @row: The GntTreeRow object - * @return The key of the row.+ * Returns: The key of the row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
gpointer gnt_tree_row_get_key(GntTree *tree, GntTreeRow *row);
@@ -235,10 +235,10 @@
- * @param row The GntTreeRow object+ * @row: The GntTreeRow object - * @return The next row.+ * Returns: The next row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
GntTreeRow * gnt_tree_row_get_next(GntTree *tree, GntTreeRow *row);
@@ -246,10 +246,10 @@
- * @param row The GntTreeRow object+ * @row: The GntTreeRow object - * @return The previous row.+ * Returns: The previous row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
GntTreeRow * gnt_tree_row_get_prev(GntTree *tree, GntTreeRow *row);
@@ -257,10 +257,10 @@
- * @param row The GntTreeRow object+ * @row: The GntTreeRow object - * @return The child row.+ * Returns: The child row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
GntTreeRow * gnt_tree_row_get_child(GntTree *tree, GntTreeRow *row);
@@ -268,10 +268,10 @@
- * @param row The GntTreeRow object+ * @row: The GntTreeRow object - * @return The parent row.+ * Returns: The parent row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
GntTreeRow * gnt_tree_row_get_parent(GntTree *tree, GntTreeRow *row);
@@ -279,9 +279,9 @@
* Get a list of text of the current row.
- * @return A list of texts of the currently selected row. The list+ * Returns: A list of texts of the currently selected row. The list * and its data should be freed by the caller. The caller
* should make sure that if any column of the tree contains
* binary data, it's not freed.
@@ -293,56 +293,56 @@
* Returns the list of rows in the tree.
- * @return The list of the rows. The list should not be modified by the caller.+ * Returns: The list of the rows. The list should not be modified by the caller. GList *gnt_tree_get_rows(GntTree *tree);
* Remove a row from the tree.
- * @param key The key for the row to remove+ * @key: The key for the row to remove void gnt_tree_remove(GntTree *tree, gpointer key);
* Remove all the item from the tree.
void gnt_tree_remove_all(GntTree *tree);
* Get the visible line number of the selected row.
- * @return The line number of the currently selected row+ * Returns: The line number of the currently selected row int gnt_tree_get_selection_visible_line(GntTree *tree);
* Change the text of a column in a row.
- * @param key The key for the row- * @param colno The index of the column- * @param text The new text+ * @key: The key for the row + * @colno: The index of the column void gnt_tree_change_text(GntTree *tree, gpointer key, int colno, const char *text);
* Add a checkable item in the tree.
- * @param key The key for the row- * @param row The row to add- * @param parent The parent of the row, or @c NULL- * @param bigbro The row to insert after, or @c NULL+ * @key: The key for the row + * @parent: The parent of the row, or %NULL + * @bigbro: The row to insert after, or %NULL - * @return The row inserted.+ * Returns: The row inserted. * @see gnt_tree_create_row
* @see gnt_tree_create_row_from_list
@@ -354,37 +354,37 @@
* Set whether a checkable item is checked or not.
- * @param key The key for the row- * @param set @c TRUE if the item should be checked, @c FALSE if not+ * @key: The key for the row + * @set: %TRUE if the item should be checked, %FALSE if not void gnt_tree_set_choice(GntTree *tree, void *key, gboolean set);
* Return whether a row is selected or not, where the row is a checkable item.
- * @param key The key for the row+ * @key: The key for the row - * @return @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);
* Set flags for the text in a row in the tree.
- * @param key The key for the row- * @param flags The flags to set+ * @key: The key for the row + * @flags: The flags to set void gnt_tree_set_row_flags(GntTree *tree, void *key, GntTextFormatFlags flags);
* Set color for the text in a row in the tree.
- * @param key The key for the row- * @param color The color+ * @key: The key for the row void gnt_tree_set_row_color(GntTree *tree, void *key, int color);
@@ -392,18 +392,18 @@
- * @param key The key of the row to select+ * @key: The key of the row to select void gnt_tree_set_selected(GntTree *tree , void *key);
* Create a row to insert in the tree.
- * @param ... A string for each column in the tree+ * @...: A string for each column in the tree
* @see gnt_tree_create_row_from_list
* @see gnt_tree_add_row_after
@@ -415,10 +415,10 @@
* Create a row from a list of text.
- * @param list The list containing the text for each column+ * @list: The list containing the text for each column
* @see gnt_tree_create_row
* @see gnt_tree_add_row_after
@@ -430,9 +430,9 @@
* Set the width of a column in the tree.
- * @param col The index of the column- * @param width The width for the column+ * @col: The index of the column + * @width: The width for the column * @see gnt_tree_set_column_width_ratio
* @see gnt_tree_set_column_resizable
@@ -442,9 +442,9 @@
* Set the title for a column.
- * @param index The index of the column- * @param title The title for the column+ * @index: The index of the column + * @title: The title for the column * @see gnt_tree_set_column_titles
* @see gnt_tree_set_show_title
@@ -456,8 +456,8 @@
* Set the titles of the columns
- * @param ... One title for each column in the tree+ * @...: One title for each column in the tree * @see gnt_tree_set_column_title
* @see gnt_tree_set_show_title
@@ -467,8 +467,8 @@
* Set whether to display the title of the columns.
- * @param 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
@@ -478,8 +478,8 @@
* Set the compare function for sorting the data.
- * @param func The comparison function, which is used to compare+ * @func: The comparison function, which is used to compare @@ -489,25 +489,25 @@
* Set whether a row, which has child rows, should be expanded.
- * @param key The key of the row- * @param expanded Whether to expand the child rows+ * @key: The key of the row + * @expanded: Whether to expand the child rows void gnt_tree_set_expanded(GntTree *tree, void *key, gboolean expanded);
* Set whether to show column separators.
- * @param 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);
* Sort a row in the tree.
- * @param row The row to sort+ * @row: The row to sort * @see gnt_tree_set_compare_func
@@ -516,17 +516,17 @@
* Automatically adjust the width of the columns in the tree.
void gnt_tree_adjust_columns(GntTree *tree);
* Set the hash functions to use to hash, compare and free the keys.
- * @param hash The hashing function- * @param eq The function to compare keys- * @param kd The function to use to free the keys when a row is removed+ * @hash: The hashing function + * @eq: The function to compare keys + * @kd: The function to use to free the keys when a row is removed void gnt_tree_set_hash_fns(GntTree *tree, gpointer hash, gpointer eq, gpointer kd);
@@ -536,9 +536,9 @@
* This can be useful when, for example, we want to store some data
* which we don't want/need to display.
- * @param col The index of the column- * @param vis If @c FALSE, the column will not be displayed+ * @col: The index of the column + * @vis: If %FALSE, the column will not be displayed void gnt_tree_set_column_visible(GntTree *tree, int col, gboolean vis);
@@ -546,9 +546,9 @@
* Set whether a column can be resized to keep the same ratio when the
- * @param col The index of the column- * @param res If @c FALSE, the column will not be resized when the+ * @col: The index of the column + * @res: If %FALSE, the column will not be resized when the * @see gnt_tree_set_col_width
@@ -562,18 +562,18 @@
* Set whether data in a column should be considered as binary data, and
* not as strings. A column containing binary data will be display empty text.
- * @param col The index of the column- * @param bin @c TRUE if the data for the column is binary+ * @col: The index of the column + * @bin: %TRUE if the data for the column is binary void gnt_tree_set_column_is_binary(GntTree *tree, int col, gboolean bin);
* Set whether text in a column should be right-aligned.
- * @param col The index of the column- * @param right @c TRUE if the text in the column should be right aligned+ * @col: The index of the column + * @right: %TRUE if the text in the column should be right aligned * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -583,8 +583,8 @@
* Set column widths to use when calculating column widths after a tree
- * @param cols Array of widths. The width must have the same number+ * @cols: Array of widths. The width must have the same number * of entries as the number of columns in the tree, or
* end with a negative value for a column-width.
@@ -598,8 +598,8 @@
* Set the column to use for typeahead searching.
- * @param col The index of the column+ * @col: The index of the column * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -608,8 +608,8 @@
* Check whether the user is currently in the middle of a search.
- * @return @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)
@@ -618,11 +618,11 @@
* Set a custom search function.
- * @param func The custom search function. The search function is+ * @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)
@@ -633,10 +633,10 @@
* Get the parent key for a row.
- * @param key The key for the row.+ * @key: The key for the row. - * @return The key of the parent row.+ * Returns: The key of the parent row. gpointer gnt_tree_get_parent_key(GntTree *tree, gpointer key);
--- a/gntutils.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gntutils.h Fri Jan 31 18:14:33 2014 +0530
@@ -35,9 +35,9 @@
* Compute the width and height required to view the text on the screen.
- * @param text The text to be displayed.- * @param width The width required is set here, if not @c NULL.- * @param height The height required is set here, if not @c NULL.+ * @text: The text to be displayed. + * @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);
@@ -45,23 +45,23 @@
* Get the onscreen width of a string, or a substring.
- * @param start The beginning of the string.- * @param end The end of the string. The width returned is the width+ * @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. - * @return The on-screen width of the string.+ * Returns: The on-screen width of the string. int gnt_util_onscreen_width(const char *start, const char *end);
* Computes and returns the string after a specific number of onscreen characters.
- * @param str The string.- * @param 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.+ * @len: The length to consider. If non-positive, the entire screenlength is used. + * @w: The actual width of the string upto the returned offset, if not %NULL. - * @return The string after len offset.+ * Returns: The string after len offset. const char *gnt_util_onscreen_width_to_pointer(const char *str, int len, int *w);
@@ -69,26 +69,26 @@
* Inserts newlines in 'string' where necessary so that its onscreen width is
- * @param string The string.- * @param maxw The width that the string should fit into. If maxw is <= 0,+ * @maxw: The width that the string should fit into. If maxw is <= 0, * then the available maximum width is used.
- * @return A newly allocated string that needs to be freed by the caller.+ * Returns: A newly allocated string that needs to be freed by the caller. char * gnt_util_onscreen_fit_string(const char *string, int maxw);
* Duplicate the contents of a hastable.
- * @param src The source hashtable.- * @param hash The hash-function to use.- * @param equal The hash-equal function to use.- * @param key_d The key-destroy function to use.- * @param value_d The value-destroy function to use.- * @param key_dup The function to use to duplicate the key.- * @param value_dup The function to use to duplicate the value.+ * @src: The source hashtable. + * @hash: The hash-function to use. + * @equal: The hash-equal function to use. + * @key_d: The key-destroy function to use. + * @value_d: The value-destroy function to use. + * @key_dup: The function to use to duplicate the key. + * @value_dup: The function to use to duplicate the value. - * @return The new hashtable.+ * Returns: The new hashtable. GHashTable * g_hash_table_duplicate(GHashTable *src, GHashFunc hash, GEqualFunc equal, GDestroyNotify key_d, GDestroyNotify value_d, GDupFunc key_dup, GDupFunc value_dup);
@@ -96,21 +96,21 @@
* To be used with g_signal_new. Look in the key_pressed signal-definition in
- * @param return_accu NA- * @param handler_return NA gboolean gnt_boolean_handled_accumulator(GSignalInvocationHint *ihint, GValue *return_accu, const GValue *handler_return, gpointer dummy);
* Get a helpful display about the bindings of a widget.
- * @param widget The widget to get bindings for.+ * @widget: The widget to get bindings for. - * @return Returns a GntTree populated with "key" -> "binding" for the widget.+ * Returns: Returns a GntTree populated with "key" -> "binding" for the widget. GntWidget * gnt_widget_bindings_view(GntWidget *widget);
@@ -127,8 +127,8 @@
- * @param string The XML string.- * @param num The number of widgets to return, followed by 'num' GntWidget **+ * @string: The XML string. + * @num: The number of widgets to return, followed by 'num' GntWidget ** void gnt_util_parse_widgets(const char *string, int num, ...);
@@ -136,9 +136,9 @@
* Parse an XHTML string and add it in a GntTextView with
* appropriate text flags.
- * @param string The XHTML string- * @param tv The GntTextView- * @return @c TRUE if the string was added to the textview properly, @c FALSE otherwise.+ * @string: The XHTML string + * Returns: %TRUE if the string was added to the textview properly, %FALSE otherwise. @@ -147,9 +147,9 @@
* Make some keypress activate a button when some key is pressed with 'wid' in focus.
- * @param widget The widget- * @param key The key to trigger the button- * @param button The button to trigger+ * @key: The key to trigger the button + * @button: The button to trigger * @since 2.0.0 (gnt), 2.1.0 (pidgin)
--- a/gntwidget.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gntwidget.h Fri Jan 31 18:14:33 2014 +0530
@@ -140,13 +140,13 @@
- * @return GType for GntWidget.+ * Returns: GType for GntWidget. GType gnt_widget_get_gtype(void);
- * @param widget The widget to destroy.+ * @widget: The widget to destroy. void gnt_widget_destroy(GntWidget *widget);
@@ -154,13 +154,13 @@
* Show a widget. This should only be used for toplevel widgets. For the rest
* of the widgets, use #gnt_widget_draw instead.
- * @param widget The widget to show.+ * @widget: The widget to show. void gnt_widget_show(GntWidget *widget);
- * @param widget The widget to draw.+ * @widget: The widget to draw. void gnt_widget_draw(GntWidget *widget);
@@ -172,112 +172,112 @@
- * @param widget The widget to hide.+ * @widget: The widget to hide. void gnt_widget_hide(GntWidget *widget);
* Get the position of a widget.
- * @param widget The widget.- * @param x Location to store the x-coordinate of the widget.- * @param y Location to store the y-coordinate of the widget.+ * @x: Location to store the x-coordinate of the widget. + * @y: Location to store the y-coordinate of the widget. void gnt_widget_get_position(GntWidget *widget, int *x, int *y);
* Set the position of a widget.
- * @param widget The widget to reposition.- * @param x The x-coordinate of the widget.- * @param y The x-coordinate of the widget.+ * @widget: The widget to reposition. + * @x: The x-coordinate of the widget. + * @y: The x-coordinate of the widget. void gnt_widget_set_position(GntWidget *widget, int x, int y);
* Request a widget to calculate its desired size.
- * @param widget The widget. void gnt_widget_size_request(GntWidget *widget);
* Get the size of a widget.
- * @param widget The widget.- * @param width Location to store the width of the widget.- * @param height Location to store the height of the widget.+ * @width: Location to store the width of the widget. + * @height: Location to store the height of the widget. void gnt_widget_get_size(GntWidget *widget, int *width, int *height);
* Set the size of a widget.
- * @param widget The widget to resize.- * @param width The width of the widget.- * @param height The height of the widget.+ * @widget: The widget to resize. + * @width: The width of the widget. + * @height: The height of the widget. - * @return If the widget was resized to the new size.+ * Returns: If the widget was resized to the new size. gboolean gnt_widget_set_size(GntWidget *widget, int width, int height);
* Confirm a requested a size for a widget.
- * @param widget The widget.- * @param width The requested width.- * @param height The requested height.+ * @width: The requested width. + * @height: The requested height. - * @return @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);
* Trigger the key-press callbacks for a widget.
- * @param widget The widget.- * @param keys The keypress on the widget.+ * @keys: The keypress on the widget. - * @return @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);
* Trigger the 'click' callback of a widget.
- * @param widget The widget.- * @param event The mouseevent.- * @param x The x-coordinate of the mouse.- * @param y The y-coordinate of the mouse.+ * @event: The mouseevent. + * @x: The x-coordinate of the mouse. + * @y: The y-coordinate of the mouse. - * @return @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.
- * @param widget The widget.- * @param 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.
- * @return @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);
* Activate a widget. This only applies to widgets that can be activated (eg. GntButton)
- * @param widget The widget to activate.+ * @widget: The widget to activate. void gnt_widget_activate(GntWidget *widget);
* Set the name of a widget.
- * @param widget The widget.- * @param name A new name for the widget.+ * @name: A new name for the widget. void gnt_widget_set_name(GntWidget *widget, const char *name);
* Get the name of a widget.
- * @param widget The widget.- * @return The name of the widget.+ * Returns: The name of the widget. const char *gnt_widget_get_name(GntWidget *widget);
@@ -290,25 +290,25 @@
* Set whether a widget can take focus or not.
- * @param widget The widget.- * @param 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);
* Set the visibility of a widget.
- * @param widget The widget.- * @param set Whether the widget is visible or not.+ * @set: Whether the widget is visible or not. void gnt_widget_set_visible(GntWidget *widget, gboolean set);
* Check whether the widget has shadows.
- * @param widget The widget.- * @return @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/gntwm.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gntwm.h Fri Jan 31 18:14:33 2014 +0530
@@ -184,134 +184,134 @@
- * @return GType for GntWM.+ * Returns: GType for GntWM. GType gnt_wm_get_gtype(void);
- * @param wm The window-manager.- * @param ws The workspace to add.+ * @wm: The window-manager. + * @ws: The workspace to add. void gnt_wm_add_workspace(GntWM *wm, GntWS *ws);
- * @param wm The window-manager.- * @param n Index of the workspace to switch to.+ * @wm: The window-manager. + * @n: Index of the workspace to switch to. - * @return @c TRUE if the switch was successful.+ * Returns: %TRUE if the switch was successful. gboolean gnt_wm_switch_workspace(GntWM *wm, gint n);
* Switch to the previous workspace from the current one.
- * @param wm The window-manager.+ * @wm: The window-manager. gboolean gnt_wm_switch_workspace_prev(GntWM *wm);
* Switch to the next workspace from the current one.
- * @param wm The window-manager.+ * @wm: The window-manager. gboolean gnt_wm_switch_workspace_next(GntWM *wm);
* Move a window to a specific workspace.
- * @param wm The window manager.- * @param neww The new workspace.- * @param widget The widget to move.+ * @wm: The window manager. + * @neww: The new workspace. + * @widget: The widget to move. void gnt_wm_widget_move_workspace(GntWM *wm, GntWS *neww, GntWidget *widget);
* Set the list of workspaces .
- * @param wm The window manager.- * @param workspaces The list of workspaces.+ * @wm: The window manager. + * @workspaces: The list of workspaces. void gnt_wm_set_workspaces(GntWM *wm, GList *workspaces);
* Find the workspace that contains a specific widget.
- * @param wm The window-manager.- * @param widget The widget to find.- * @return The workspace that has the widget.+ * @wm: The window-manager. + * @widget: The widget to find. + * Returns: The workspace that has the widget. GntWS *gnt_wm_widget_find_workspace(GntWM *wm, GntWidget *widget);
- * @param wm The window-manager.- * @param widget The new window.+ * @wm: The window-manager. + * @widget: The new window. void gnt_wm_new_window(GntWM *wm, GntWidget *widget);
- * @param wm The window-manager.- * @param widget The widget to decorate.+ * @wm: The window-manager. + * @widget: The widget to decorate. void gnt_wm_window_decorate(GntWM *wm, GntWidget *widget);
- * @param wm The window-manager.- * @param widget The window to close.+ * @wm: The window-manager. + * @widget: The window to close. void gnt_wm_window_close(GntWM *wm, GntWidget *widget);
- * @param wm The window-manager.- * @param string The input string to process.+ * @wm: The window-manager. + * @string: The input string to process. - * @return @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);
- * @param wm The window manager.- * @param event The mouse event.- * @param x The x-coordinate of the mouse.- * @param y The y-coordinate of the mouse.- * @param widget The widget under the mouse.+ * @wm: The window manager. + * @event: The mouse event. + * @x: The x-coordinate of the mouse. + * @y: The y-coordinate of the mouse. + * @widget: The widget under the mouse. - * @return @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);
- * @param wm The window manager.- * @param widget The window to resize.- * @param width The desired width of the window.- * @param height The desired height of the window.+ * @wm: The window manager. + * @widget: The window to resize. + * @width: The desired width of the window. + * @height: The desired height of the window. void gnt_wm_resize_window(GntWM *wm, GntWidget *widget, int width, int height);
- * @param wm The window manager.- * @param widget The window to move.- * @param x The desired x-coordinate of the window.- * @param y The desired y-coordinate of the window.+ * @wm: The window manager. + * @widget: The window to move. + * @x: The desired x-coordinate of the window. + * @y: The desired y-coordinate of the window. void gnt_wm_move_window(GntWM *wm, GntWidget *widget, int x, int y);
- * @param wm The window-manager.- * @param widget The window to update.+ * @wm: The window-manager. + * @widget: The window to update. void gnt_wm_update_window(GntWM *wm, GntWidget *widget);
- * @param wm The window-manager.- * @param widget The window to raise.+ * @wm: The window-manager. + * @widget: The window to raise. void gnt_wm_raise_window(GntWM *wm, GntWidget *widget);
@@ -326,7 +326,7 @@
void gnt_wm_copy_win(GntWidget *widget, GntNode *node);
- * @return The idle time of the user.+ * Returns: The idle time of the user. time_t gnt_wm_get_idle_time(void);
--- a/gntws.h Fri Jan 31 17:48:12 2014 +0530
+++ b/gntws.h Fri Jan 31 18:14:33 2014 +0530
@@ -70,7 +70,7 @@
- * @return The GType for GntWS.+ * Returns: The GType for GntWS. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -79,9 +79,9 @@
* Create a new workspace with the specified name.
- * @param name The desired name of the workspace, or @c NULL.+ * @name: The desired name of the workspace, or %NULL. - * @return The newly created workspace.+ * Returns: The newly created workspace. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -90,8 +90,8 @@
* Set the name of a workspace.
- * @param ws The workspace to rename.- * @param name The new name of the workspace.+ * @ws: The workspace to rename. + * @name: The new name of the workspace. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -100,8 +100,8 @@
* Add a widget to a workspace.
- * @param ws The workspace.- * @param widget The widget to add.+ * @widget: The widget to add. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -110,8 +110,8 @@
* Remove a widget from a workspace.
- * @param ws The workspace- * @param widget The widget to remove from the workspace.+ * @widget: The widget to remove from the workspace. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -120,8 +120,8 @@
* Hide a widget in a workspace.
- * @param widget The widget to hide.- * @param nodes A hashtable containing information about the widgets.+ * @widget: The widget to hide. + * @nodes: A hashtable containing information about the widgets. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -130,8 +130,8 @@
* Show a widget in a workspace.
- * @param widget The widget to show.- * @param nodes A hashtable containing information about the widgets.+ * @widget: The widget to show. + * @nodes: A hashtable containing information about the widgets. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -140,8 +140,8 @@
* Draw the taskbar in a workspace.
- * @param ws The workspace.- * @param reposition Whether the workspace should reposition the taskbar.+ * @reposition: Whether the workspace should reposition the taskbar. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -150,8 +150,8 @@
- * @param ws The workspace to hide.- * @param table A hashtable containing information about the widgets.+ * @ws: The workspace to hide. + * @table: A hashtable containing information about the widgets. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -160,8 +160,8 @@
- * @param ws The workspace to hide.- * @param table A hashtable containing information about the widgets.+ * @ws: The workspace to hide. + * @table: A hashtable containing information about the widgets. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -170,8 +170,8 @@
* Get the name of a workspace.
- * @param ws The workspace.- * @return 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)
