From 0f69965805dda51cc7b6ea8404226d5f75a3b533 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Sun, 19 Feb 2017 11:32:17 +0000 Subject: clean up some of the doxygen generation warnings --- frontends/windows/cookies.c | 17 +++++++++++++++-- frontends/windows/global_history.c | 2 ++ frontends/windows/hotlist.c | 2 ++ frontends/windows/localhistory.c | 10 ++++++---- frontends/windows/localhistory.h | 22 ++++++++++++++++++---- frontends/windows/ssl_cert.c | 8 +++++--- frontends/windows/window.c | 7 ++++--- 7 files changed, 52 insertions(+), 16 deletions(-) (limited to 'frontends/windows') diff --git a/frontends/windows/cookies.c b/frontends/windows/cookies.c index 27949fac1..c4880fa1c 100644 --- a/frontends/windows/cookies.c +++ b/frontends/windows/cookies.c @@ -58,6 +58,7 @@ nsw32_cookie_key(struct nsw32_corewindow *nsw32_cw, uint32_t nskey) return NSERROR_NOT_IMPLEMENTED; } + /** * callback for mouse action on cookie window * @@ -69,18 +70,21 @@ nsw32_cookie_key(struct nsw32_corewindow *nsw32_cw, uint32_t nskey) */ static nserror nsw32_cookie_mouse(struct nsw32_corewindow *nsw32_cw, - browser_mouse_state mouse_state, - int x, int y) + browser_mouse_state mouse_state, + int x, int y) { cookie_manager_mouse_action(mouse_state, x, y); return NSERROR_OK; } + /** * callback on draw event for cookie window * * \param nsw32_cw The nsw32 core window structure. + * \param scrollx The horizontal scroll offset. + * \param scrolly The vertical scroll offset. * \param r The rectangle of the window that needs updating. * \return NSERROR_OK on success otherwise apropriate error code */ @@ -102,6 +106,12 @@ nsw32_cookie_draw(struct nsw32_corewindow *nsw32_cw, } +/** + * callback on close event for cookie window + * + * \param nsw32_cw The nsw32 core window structure. + * \return NSERROR_OK on success otherwise apropriate error code + */ static nserror nsw32_cookie_close(struct nsw32_corewindow *nsw32_cw) { @@ -110,9 +120,11 @@ nsw32_cookie_close(struct nsw32_corewindow *nsw32_cw) return NSERROR_OK; } + /** * Creates the window for the cookie tree. * + * \param hInstance The application instance * \return NSERROR_OK on success else appropriate error code on faliure. */ static nserror nsw32_cookie_init(HINSTANCE hInstance) @@ -169,6 +181,7 @@ nserror nsw32_cookies_present(HINSTANCE hInstance) return res; } + /* exported interface documented in windows/cookie.h */ nserror nsw32_cookies_finalise(void) { diff --git a/frontends/windows/global_history.c b/frontends/windows/global_history.c index 0ef09632d..9ebe4381b 100644 --- a/frontends/windows/global_history.c +++ b/frontends/windows/global_history.c @@ -81,6 +81,8 @@ nsw32_global_history_mouse(struct nsw32_corewindow *nsw32_cw, * callback on draw event for global_history window * * \param nsw32_cw The nsw32 core window structure. + * \param scrollx The horizontal scroll offset. + * \param scrolly The vertical scroll offset. * \param r The rectangle of the window that needs updating. * \return NSERROR_OK on success otherwise apropriate error code */ diff --git a/frontends/windows/hotlist.c b/frontends/windows/hotlist.c index c184619bf..07804fee2 100644 --- a/frontends/windows/hotlist.c +++ b/frontends/windows/hotlist.c @@ -85,6 +85,8 @@ nsw32_hotlist_mouse(struct nsw32_corewindow *nsw32_cw, * callback on draw event for hotlist window * * \param nsw32_cw The nsw32 core window structure. + * \param scrollx The horizontal scroll offset. + * \param scrolly The vertical scroll offset. * \param r The rectangle of the window that needs updating. * \return NSERROR_OK on success otherwise apropriate error code */ diff --git a/frontends/windows/localhistory.c b/frontends/windows/localhistory.c index ae3b7f521..ea913c1a2 100644 --- a/frontends/windows/localhistory.c +++ b/frontends/windows/localhistory.c @@ -108,11 +108,13 @@ nsws_localhistory_up(struct nsws_localhistory *l, struct gui_window *gw) } -void nsws_localhistory_close(struct gui_window *w) +/* exported interface documented in windows/localhistory.h */ +void nsws_localhistory_close(struct gui_window *gw) { - struct nsws_localhistory *l = gui_window_localhistory(w); - if (l != NULL) - CloseWindow(l->hwnd); + struct nsws_localhistory *lh = gui_window_localhistory(gw); + if (lh != NULL) { + CloseWindow(lh->hwnd); + } } diff --git a/frontends/windows/localhistory.h b/frontends/windows/localhistory.h index b0ad07491..eed417f28 100644 --- a/frontends/windows/localhistory.h +++ b/frontends/windows/localhistory.h @@ -16,17 +16,31 @@ * along with this program. If not, see . */ -#ifndef _NETSURF_WINDOWS_LOCALHISTORY_H_ -#define _NETSURF_WINDOWS_LOCALHISTORY_H_ +#ifndef NETSURF_WINDOWS_LOCALHISTORY_H +#define NETSURF_WINDOWS_LOCALHISTORY_H struct nsws_localhistory; -void nsws_localhistory_open(struct gui_window *gw); +/** + * Close win32 localhistory window. + * + * \param gw The win32 gui window to close local history for. + */ void nsws_localhistory_close(struct gui_window *gw); -/* creates localhistory window */ +/** + * creates localhistory window + * + * \param gw The win32 gui window to create a local history for. + */ struct nsws_localhistory *nsws_window_create_localhistory(struct gui_window *gw); +/** + * Create the win32 window class + * + * \param hinstance The application instance to create the window class under + * \return NSERROR_OK on success else error code. + */ nserror nsws_create_localhistory_class(HINSTANCE hinstance); #endif diff --git a/frontends/windows/ssl_cert.c b/frontends/windows/ssl_cert.c index 72d1d3b55..50fb7652c 100644 --- a/frontends/windows/ssl_cert.c +++ b/frontends/windows/ssl_cert.c @@ -117,6 +117,8 @@ nsw32_sslcert_viewer_mouse(struct nsw32_corewindow *nsw32_cw, * callback on draw event for hotlist window * * \param nsw32_cw The nsw32 core window structure. + * \param scrollx The horizontal scroll offset. + * \param scrolly The vertical scroll offset. * \param r The rectangle of the window that needs updating. * \return NSERROR_OK on success otherwise apropriate error code */ @@ -332,10 +334,10 @@ static nserror nsw32_crtvrfy_destroy(struct nsw32_sslcert_window *crtwin) } /** - * handle command message on main browser window + * handle command message on ssl certificate window. * - * \param hwnd The win32 window handle - * \param gw win32 gui window + * \param hwnd The win32 window handle. + * \param crtwin certificate window context. * \param notification_code notifiction code * \param identifier notification identifier * \param ctrl_window The win32 control window handle diff --git a/frontends/windows/window.c b/frontends/windows/window.c index 94dc7c10e..bb6d6232f 100644 --- a/frontends/windows/window.c +++ b/frontends/windows/window.c @@ -809,11 +809,12 @@ static void nsws_update_edit(struct gui_window *w) * * \param gw win32 frontends graphical window. * \param hwnd The win32 window handle - * \param int x The x coordinate of the event. + * \param x The x coordinate of the event. * \param y the y cooordiante of the event. + * \return true if menu displayed else false */ static bool -nsws_ctx_menu(struct gui_window *w, HWND hwnd, int x, int y) +nsws_ctx_menu(struct gui_window *gw, HWND hwnd, int x, int y) { RECT rc; /* client area of window */ POINT pt = { x, y }; /* location of mouse click */ @@ -828,7 +829,7 @@ nsws_ctx_menu(struct gui_window *w, HWND hwnd, int x, int y) if (PtInRect(&rc, pt)) { ClientToScreen(hwnd, &pt); nsws_update_edit(w); - TrackPopupMenu(GetSubMenu(w->rclick, 0), + TrackPopupMenu(GetSubMenu(gw->rclick, 0), TPM_CENTERALIGN | TPM_TOPALIGN, x, y, -- cgit v1.2.3