summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2014-10-12 10:35:23 +0100
committerVincent Sanders <vince@kyllikki.org>2014-10-12 10:35:23 +0100
commit09509a90956ffb60105271fbee178897862b6d3b (patch)
treea65def23e3bd0c6570285d26e50ccd6c33f628b4
parent265f63e67968cfcc23e785fe7b8b38a7961572f1 (diff)
downloadnetsurf-09509a90956ffb60105271fbee178897862b6d3b.tar.gz
netsurf-09509a90956ffb60105271fbee178897862b6d3b.tar.bz2
Some minor documentation cleanups to reduce doxygen warnings
-rw-r--r--desktop/gui.h20
1 files changed, 15 insertions, 5 deletions
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.