From 09509a90956ffb60105271fbee178897862b6d3b Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Sun, 12 Oct 2014 10:35:23 +0100 Subject: Some minor documentation cleanups to reduce doxygen warnings --- desktop/gui.h | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) (limited to 'desktop') diff --git a/desktop/gui.h b/desktop/gui.h index 21dd85e68..4dc638c39 100644 --- a/desktop/gui.h +++ b/desktop/gui.h @@ -106,8 +106,10 @@ struct gui_window_table { /** * Destroy previously created gui window + * + * \param gw The gui window to destroy. */ - void (*destroy)(struct gui_window *g); + void (*destroy)(struct gui_window *gw); /** * Force a redraw of the entire contents of a window. @@ -193,12 +195,20 @@ struct gui_window_table { void (*set_title)(struct gui_window *g, const char *title); /** - * set the navigation url. + * Set the navigation url. + * + * \param gw window to update. + * \param url The url to use as icon. */ - void (*set_url)(struct gui_window *g, const char *url); + void (*set_url)(struct gui_window *gw, const char *url); - /** set favicon */ - void (*set_icon)(struct gui_window *g, struct hlcache_handle *icon); + /** + * Set a favicon for a gui window. + * + * \param gw window to update. + * \param icon handle to object to use as icon. + */ + void (*set_icon)(struct gui_window *gw, struct hlcache_handle *icon); /** * Set the status bar of a browser window. -- cgit v1.2.3