summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2014-11-11 15:46:04 +0000
committerVincent Sanders <vince@kyllikki.org>2014-11-11 15:46:04 +0000
commit3e4f5737aab18858dd80c7b57e5aaa3eecaf21c7 (patch)
treee5fd8a60466bbdc8f0c88e0dceaf2e59cb029e0b
parent8a6500c539a1c253cb864f0b2665f66611ebfbd3 (diff)
downloadnetsurf-3e4f5737aab18858dd80c7b57e5aaa3eecaf21c7.tar.gz
netsurf-3e4f5737aab18858dd80c7b57e5aaa3eecaf21c7.tar.bz2
Doxygen cleanups in frontends
-rw-r--r--amiga/gui.c1
-rw-r--r--riscos/download.c7
-rw-r--r--riscos/filetype.h4
-rw-r--r--riscos/gui.c6
-rw-r--r--riscos/window.c8
-rw-r--r--windows/findfile.c10
-rw-r--r--windows/gui.c20
7 files changed, 32 insertions, 24 deletions
diff --git a/amiga/gui.c b/amiga/gui.c
index 35e3b4ed9..0ee84014a 100644
--- a/amiga/gui.c
+++ b/amiga/gui.c
@@ -4255,6 +4255,7 @@ static void ami_do_redraw_tiled(struct gui_window_2 *gwin, bool busy,
*
* \param g a struct gui_window
* \param bw a struct browser_window
+ * \param busy busy flag passed to tiled redraw.
* \param x0 top-left co-ordinate (in document co-ordinates)
* \param y0 top-left co-ordinate (in document co-ordinates)
* \param x1 bottom-right co-ordinate (in document co-ordinates)
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,
diff --git a/windows/findfile.c b/windows/findfile.c
index aed43b0bf..7323666d3 100644
--- a/windows/findfile.c
+++ b/windows/findfile.c
@@ -86,14 +86,14 @@ static char *realpath(const char *path, char *resolved_path)
/**
* Locate a shared resource file by searching known places in order.
*
+ * Search order is: ~/.netsurf/, $NETSURFRES/ (where NETSURFRES is an
+ * environment variable), then the path specified in
+ * NETSURF_WINDOWS_RESPATH in the Makefile then .\\res\\ [windows paths]
+ *
* \param buf buffer to write to. must be at least PATH_MAX chars
* \param filename file to look for
* \param def default to return if file not found
- * \return buf
- *
- * Search order is: ~/.netsurf/, $NETSURFRES/ (where NETSURFRES is an
- * environment variable), then the path specified in
- * NETSURF_WINDOWS_RESPATH in the Makefile then .\res\ [windows paths]
+ * \return The passed in buffer
*/
char *nsws_find_resource(char *buf, const char *filename, const char *def)
diff --git a/windows/gui.c b/windows/gui.c
index c1f87f9f3..487f59c8f 100644
--- a/windows/gui.c
+++ b/windows/gui.c
@@ -1244,8 +1244,12 @@ static HWND nsws_window_create(struct gui_window *gw)
}
/**
- * create a new gui_window to contain a browser_window
+ * create a new gui_window to contain a browser_window.
+ *
* \param bw the browser_window to connect to the new gui_window
+ * \param existing An existing window.
+ * \param flags The flags controlling the construction.
+ * \return The new win32 gui window or NULL on error.
*/
static struct gui_window *
gui_window_create(struct browser_window *bw,
@@ -1498,8 +1502,10 @@ static bool gui_window_get_scroll(struct gui_window *w, int *sx, int *sy)
/**
* scroll the window
- * \param sx the new 'absolute' scroll location
- * \param sy the new 'absolute' scroll location
+ *
+ * \param w The win32 gui window to scroll.
+ * \param sx the new 'absolute' horizontal scroll location
+ * \param sy the new 'absolute' vertical scroll location
*/
void gui_window_set_scroll(struct gui_window *w, int sx, int sy)
{
@@ -1832,6 +1838,8 @@ nsws_create_main_class(HINSTANCE hinstance) {
/**
* callback from core to reformat a window.
+ *
+ * \param gw The win32 gui window to reformat.
*/
static void win32_window_reformat(struct gui_window *gw)
{
@@ -1850,8 +1858,8 @@ static void win32_window_reformat(struct gui_window *gw)
* @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] ... The elements of the path as string pointers.
+ * @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.
*/
@@ -1905,7 +1913,7 @@ static nserror windows_basename(const char *path, char **str, size_t *size)
/**
* Create a path from a nsurl using windows 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