From 3e4f5737aab18858dd80c7b57e5aaa3eecaf21c7 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Tue, 11 Nov 2014 15:46:04 +0000
Subject: Doxygen cleanups in frontends

---
 riscos/download.c | 7 +++----
 riscos/filetype.h | 4 ++--
 riscos/gui.c      | 6 +++---
 riscos/window.c   | 8 ++++----
 4 files changed, 12 insertions(+), 13 deletions(-)

(limited to 'riscos')

diff --git a/riscos/download.c b/riscos/download.c
index ff77cda1d..7570a1ca0 100644
--- a/riscos/download.c
+++ b/riscos/download.c
@@ -273,8 +273,9 @@ static nserror download_ro_filetype(download_context *ctx, bits *ftype_out)
 /**
  * Create and open a download progress window.
  *
- * \param  ctx         Download context
- * \return  a new gui_download_window structure, or 0 on error and error
+ * \param ctx  Download context
+ * \param gui  The RISCOS gui window to download for.
+ * \return A new gui_download_window structure, or NULL on error and error
  *          reported
  */
 
@@ -829,7 +830,6 @@ static void gui_download_window_done(struct gui_download_window *dw)
 /**
  * Handle Mouse_Click events in a download window.
  *
- * \param  dw       download window
  * \param  pointer  block returned by Wimp_Poll
  */
 
@@ -883,7 +883,6 @@ bool ro_gui_download_click(wimp_pointer *pointer)
 /**
  * Handler Key_Press events in a download window.
  *
- * \param  dw       download window
  * \param  key  key press returned by Wimp_Poll
  * \return true iff key press handled
  */
diff --git a/riscos/filetype.h b/riscos/filetype.h
index 20dfb6cbc..3ba613033 100644
--- a/riscos/filetype.h
+++ b/riscos/filetype.h
@@ -88,10 +88,10 @@ char *fetch_mimetype(const char *ro_path);
 /**
  * Determine the RISC OS filetype for a content.
  *
- * \param content The content to examine.
+ * \param h The handle of the content to examine.
  * \return The RISC OS filetype corresponding to the content
  */
-int ro_content_filetype(struct hlcache_handle *c);
+int ro_content_filetype(struct hlcache_handle *h);
 
 /**
  * Determine the native RISC OS filetype to export a content as
diff --git a/riscos/gui.c b/riscos/gui.c
index 198fd2391..290c9a34d 100644
--- a/riscos/gui.c
+++ b/riscos/gui.c
@@ -1400,7 +1400,7 @@ const char *ro_gui_default_language(void)
  * Perform the necessary operations on a path to generate a nsurl.
  *
  * @param[in] path The RISC OS pathname to convert.
- * @param[out] url pointer to recive the nsurl, The returned url must be
+ * @param[out] url_out pointer to recive the nsurl, The returned url must be
  *                 unreferenced by the caller.
  * @return NSERROR_OK and the url is placed in \a url or error code on faliure.
  */
@@ -1482,7 +1482,7 @@ static nserror ro_path_to_nsurl(const char *path, struct nsurl **url_out)
 /**
  * Create a path from a nsurl using posix file handling.
  *
- * @parm[in] url The url to encode.
+ * @param[in] url The url to encode.
  * @param[out] path_out A string containing the result path which should
  *                      be freed by the caller.
  * @return NSERROR_OK and the path is written to \a path or error code
@@ -2166,7 +2166,7 @@ bool ro_gui_prequit(void)
  * @param[in,out] size The size of the space available if \a str not
  *                     NULL on input and if not NULL set to the total
  *                     output length on output.
- * @param[in] nemb The number of elements.
+ * @param[in] nelm The number of elements.
  * @param[in] ap The elements of the path as string pointers.
  * @return NSERROR_OK and the complete path is written to str
  *         or error code on faliure.
diff --git a/riscos/window.c b/riscos/window.c
index cf0735271..188a1d6e3 100644
--- a/riscos/window.c
+++ b/riscos/window.c
@@ -4526,7 +4526,7 @@ void ro_gui_window_clone_options(
 /**
  * Makes a browser window's options the default.
  *
- * \param  bw  the browser window to read options from
+ * \param gui The riscos gui window to set default options in.
  */
 
 void ro_gui_window_default_options(struct gui_window *gui)
@@ -4564,9 +4564,9 @@ void ro_gui_window_default_options(struct gui_window *gui)
  * Prepare or reprepare a form select menu, setting up the menu handle
  * globals in the process.
  *
- * \param *bw		The browser window to contain the menu.
- * \param *control	The form control needing a menu.
- * \return		true if the menu is OK to be opened; else false.
+ * \param g        The RISC OS gui window the menu is in.
+ * \param control  The form control needing a menu.
+ * \return true if the menu is OK to be opened; else false.
  */
 
 bool ro_gui_window_prepare_form_select_menu(struct gui_window *g,
-- 
cgit v1.2.3