From 41331542154594970fb6c36bc1c147c244fe9279 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Sun, 12 Apr 2015 21:42:33 +0100 Subject: fix documentation errors in gtk introduced by recent updates. --- gtk/compat.h | 12 ++++++++---- gtk/window.c | 13 +++++++++++-- 2 files changed, 19 insertions(+), 6 deletions(-) (limited to 'gtk') diff --git a/gtk/compat.h b/gtk/compat.h index e90cdc615..088cd79fe 100644 --- a/gtk/compat.h +++ b/gtk/compat.h @@ -172,7 +172,9 @@ enum { * * Compatability interface for original deprecated in GTK 3.10 * - * \param stock_id the name of the stock item + * \param entry The entry widget to set the icon on. + * \param icon_pos The position of the icon. + * \param stock_id the name of the stock item. */ void nsgtk_entry_set_icon_from_stock(GtkWidget *entry, GtkEntryIconPosition icon_pos, const gchar *stock_id); @@ -181,7 +183,9 @@ void nsgtk_entry_set_icon_from_stock(GtkWidget *entry, GtkEntryIconPosition icon * * Compatability interface for original deprecated in GTK 3.10 * - * \param stock_id the name of the stock item + * \param stock_id the name of the stock item. + * \param size The size of icon to create. + * \return The created image widget or NULL on error */ GtkWidget *nsgtk_image_new_from_stock(const gchar *stock_id, GtkIconSize size); @@ -195,12 +199,12 @@ GtkWidget *nsgtk_image_new_from_stock(const gchar *stock_id, GtkIconSize size); GtkWidget *nsgtk_button_new_from_stock(const gchar *stock_id); /** - * Fills item with the registered values for stock_id. * * Compatability interface for original deprecated in GTK 3.10 * - * \param stock_id the name of the stock item + * \param stock_id the name of the stock item. + * \param item The structure to update if the stock_id was known. * \return TRUE if stock_id was known. */ gboolean nsgtk_stock_lookup(const gchar *stock_id, GtkStockItem *item); diff --git a/gtk/window.c b/gtk/window.c index 685ff913a..7fa089a5c 100644 --- a/gtk/window.c +++ b/gtk/window.c @@ -17,6 +17,11 @@ * along with this program. If not, see . */ +/** + * \file + * Implementation of gtk windowing. + */ + #include #include #include @@ -60,7 +65,8 @@ static void nsgtk_select_menu_clicked(GtkCheckMenuItem *checkmenuitem, gpointer user_data); struct gui_window { - /** The gtk scaffold object containing menu, buttons, url bar, [tabs], + /** + * The gtk scaffold object containing menu, buttons, url bar, [tabs], * drawing area, etc that may contain one or more gui_windows. */ struct nsgtk_scaffolding *scaffold; @@ -118,7 +124,10 @@ struct gui_window { struct gui_window *next, *prev; }; -struct gui_window *window_list = NULL; /**< first entry in win list*/ +/**< first entry in window list */ +struct gui_window *window_list = NULL; + +/** flag controlling opening of tabs in teh background */ int temp_open_background = -1; struct nsgtk_scaffolding *nsgtk_get_scaffold(struct gui_window *g) -- cgit v1.2.3