diff -r 48f85579cc4c -r 8e2b68c79fa1 finch/libgnt/gnt.h --- a/finch/libgnt/gnt.h Wed Jan 29 00:28:08 2014 +0530 +++ b/finch/libgnt/gnt.h Wed Jan 29 05:28: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: @c FALSE if the terminal is capable of drawing UTF-8, @c 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,16 +87,16 @@ /** * Resize a widget. * - * @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); /** * Move a widget. * - * @param widget The widget to move. + * @widget: The widget to move. * @param x The desired x-coordinate. * @param y The desired y-coordinate. */ @@ -105,41 +105,41 @@ /** * Rename a widget. * - * @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. + * @widget: The widget. * - * @return @c TRUE if the widget has the current focus, @c FALSE otherwise. + * Returns: @c TRUE if the widget has the current focus, @c 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)); /** * Show a menu. * - * @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: @c TRUE if the menu is displayed, @c 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 @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. + * @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: @c TRUE if the child was successfully spawned, @c FALSE otherwise. */ gboolean gnt_giveup_console(const char *wd, char **argv, char **envp, gint *stin, gint *stout, gint *sterr, @@ -190,7 +190,7 @@ /** * 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 + * Returns: @c TRUE if a child process (eg., PAGER) is occupying the current * terminal, @c FALSE otherwise. */ gboolean gnt_is_refugee(void);