From 33eb1f413a03042b330796780cb29ae74894c9fd Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Mon, 10 Nov 2014 20:15:14 +0000
Subject: Doxygen warning fixes

---
 riscos/gui/throbber.h | 27 +++++++++++++++------------
 riscos/theme.c        |  2 --
 riscos/window.c       |  4 ++--
 3 files changed, 17 insertions(+), 16 deletions(-)

(limited to 'riscos')

diff --git a/riscos/gui/throbber.h b/riscos/gui/throbber.h
index 10d39ebfd..6b2419b6e 100644
--- a/riscos/gui/throbber.h
+++ b/riscos/gui/throbber.h
@@ -82,14 +82,17 @@ bool ro_gui_throbber_get_dims(struct throbber *throbber,
 
 
 /**
- * Set or update the dimensions to be used by the throbber, in RO units.
+ * Set or update the dimensions to be used by the throbber in RO units
+ *
  * If these are greater than the minimum required, the throbber will fill
  * the extended space; if less, the call will fail.
  *
- * \param *throbber		The throbber to update.
- * \param width			The desired width.
- * \param height		The desired height.
- * \return			true if size updated; else false.
+ * \param throbber The throbber to update.
+ * \param x0       top left of bounding box x coordinate
+ * \param y0       top left of bounding box y coordinate
+ * \param x1       bottom right of bounding box x coordinate
+ * \param y1       bottom right of bounding box y coordinate
+ * \return true if size updated; else false.
  */
 
 bool ro_gui_throbber_set_extent(struct throbber *throbber,
@@ -110,13 +113,13 @@ bool ro_gui_throbber_hide(struct throbber *throbber, bool hide);
 /**
  * Translate mouse data into an interactive help message for the throbber.
  *
- * \param *throbber		The throbber to process.
- * \param i			The wimp icon under the pointer.
- * \param *mouse		The mouse position.
- * \param *state		The toolbar window state.
- * \param buttons		The mouse button state.
- * \param **suffix		Return a help token suffix, or "" for none.
- * \return			true if handled exclusively; else false.
+ * \param throbber   The throbber to process.
+ * \param i          The wimp icon under the pointer.
+ * \param screenpos  The screen position.
+ * \param state      The toolbar window state.
+ * \param buttons    The mouse button state.
+ * \param suffix     Return a help token suffix, or "" for none.
+ * \return true if handled exclusively; else false.
  */
 
 bool ro_gui_throbber_help_suffix(struct throbber *throbber, wimp_i i,
diff --git a/riscos/theme.c b/riscos/theme.c
index eccf3729f..40c374704 100644
--- a/riscos/theme.c
+++ b/riscos/theme.c
@@ -712,8 +712,6 @@ void ro_gui_theme_close(struct theme_descriptor *descriptor, bool list)
  * Frees any unused theme descriptors.
  *
  * \param descriptor  the theme_descriptor to free
- * \param list	      whether to open all themes in the list
- * \return whether the operation was successful
  */
 void ro_gui_theme_free(struct theme_descriptor *descriptor)
 {
diff --git a/riscos/window.c b/riscos/window.c
index 1be7a64a0..cf0735271 100644
--- a/riscos/window.c
+++ b/riscos/window.c
@@ -998,7 +998,7 @@ static void gui_window_update_extent(struct gui_window *g)
  * \param  text  new status text
  */
 
-static void gui_window_set_status(struct gui_window *g, const char *text)
+static void riscos_window_set_status(struct gui_window *g, const char *text)
 {
 	if (g->status_bar)
 		ro_gui_status_bar_set_text(g->status_bar, text);
@@ -5024,7 +5024,7 @@ static struct gui_window_table window_table = {
 	.set_title = gui_window_set_title,
 	.set_url = gui_window_set_url,
 	.set_icon = gui_window_set_icon,
-	.set_status = gui_window_set_status,
+	.set_status = riscos_window_set_status,
 	.set_pointer = gui_window_set_pointer,
 	.place_caret = gui_window_place_caret,
 	.remove_caret = gui_window_remove_caret,
-- 
cgit v1.2.3