summaryrefslogtreecommitdiff
path: root/windows
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 /windows
parent8a6500c539a1c253cb864f0b2665f66611ebfbd3 (diff)
downloadnetsurf-3e4f5737aab18858dd80c7b57e5aaa3eecaf21c7.tar.gz
netsurf-3e4f5737aab18858dd80c7b57e5aaa3eecaf21c7.tar.bz2
Doxygen cleanups in frontends
Diffstat (limited to 'windows')
-rw-r--r--windows/findfile.c10
-rw-r--r--windows/gui.c20
2 files changed, 19 insertions, 11 deletions
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