From d1f2d29e102a3c429c892c70a7125cad3add5fe0 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Mon, 10 Nov 2014 17:00:15 +0000 Subject: Doxygen cleanups and documentation additions --- desktop/browser.h | 15 ++++++++------- desktop/frames.h | 2 +- desktop/print.c | 3 ++- desktop/selection.c | 20 +++++++++++--------- 4 files changed, 22 insertions(+), 18 deletions(-) (limited to 'desktop') diff --git a/desktop/browser.h b/desktop/browser.h index b24885d4f..1d184b6f8 100644 --- a/desktop/browser.h +++ b/desktop/browser.h @@ -227,7 +227,7 @@ struct history * browser_window_get_history(struct browser_window *bw); * \param bw browser window * \param scaled whether to apply current browser window scale * \param width updated to content width extent in px - * \param width updated to content height extent in px + * \param height updated to content height extent in px * \return NSERROR_OK, or appropriate error otherwise. */ nserror browser_window_get_extents(struct browser_window *bw, bool scaled, @@ -297,9 +297,10 @@ void browser_window_destroy(struct browser_window *bw); /** * Reformat a browser window contents to a new width or height. * - * \param bw the browser window to reformat - * \param width new width - * \param height new height + * \param bw The browser window to reformat. + * \param background Reformat in the background. + * \param width new width + * \param height new height */ void browser_window_reformat(struct browser_window *bw, bool background, int width, int height); @@ -643,9 +644,9 @@ bool browser_window_is_frameset(struct browser_window *bw); * e.g. if the gui toolkit style-guide says all windows must have * scrollbars then this API can be ignored. * - * \param bw browser window to look at - * \param h Updated to indicate horizontal scrollbar type - * \param h Updated to indicate vertical scrollbar type + * \param bw browser window to look at + * \param h Updated to indicate horizontal scrollbar type + * \param v Updated to indicate vertical scrollbar type * \return NSERROR_OK, or appropriate error otherwise */ nserror browser_window_get_scrollbar_type(struct browser_window *bw, diff --git a/desktop/frames.h b/desktop/frames.h index bca7f2e68..02c513c22 100644 --- a/desktop/frames.h +++ b/desktop/frames.h @@ -30,7 +30,7 @@ struct scrollbar_msg_data; * * \param bw The browser window to create iframes for. * \param iframe The iframes to create from. - * \param NSERROR_OK or error code on faliure. + * \return NSERROR_OK or error code on faliure. */ nserror browser_window_create_iframes(struct browser_window *bw, struct content_html_iframe *iframe); diff --git a/desktop/print.c b/desktop/print.c index 9b698f707..1f77c8ba4 100644 --- a/desktop/print.c +++ b/desktop/print.c @@ -217,6 +217,7 @@ bool print_apply_settings(hlcache_handle *content, * * \param content The original content * \param printer The printer interface for the printer to be used + * \param settings The print settings to use. * \return true if successful, false otherwise */ bool print_cleanup(hlcache_handle *content, const struct printer *printer, @@ -241,7 +242,7 @@ bool print_cleanup(hlcache_handle *content, const struct printer *printer, * * \param configuration the requested configuration * \param filename the filename or NULL - * \param font handling functions + * \param font_func font handling functions * \return print_settings in case if successful, NULL if unknown * configuration or lack of memory. */ diff --git a/desktop/selection.c b/desktop/selection.c index 0f395a7a2..e2bd74722 100644 --- a/desktop/selection.c +++ b/desktop/selection.c @@ -216,9 +216,8 @@ void selection_init(struct selection *s, struct box *root) * Label each text box in the given box subtree with its position * in a textual representation of the content. * - * \param s selection object - * \param node box at root of subtree - * \param idx current position within textual representation + * \param box The box at root of subtree + * \param idx current position within textual representation * \return updated position */ @@ -550,8 +549,9 @@ bool traverse_tree(struct box *box, unsigned start_idx, unsigned end_idx, * Traverse the current selection, calling the handler function (with its * handle) for all boxes that lie (partially) within the given range * - * \param handler handler function to call - * \param handle handle to pass + * \param s The selection context. + * \param handler handler function to call + * \param handle handle to pass * \return false iff traversal abandoned part-way through */ @@ -674,10 +674,11 @@ void selection_redraw(struct selection *s, unsigned start_idx, unsigned end_idx) /** * Append text to selection string. * - * \param text text to be added - * \param length length of text in bytes - * \param space indicates whether a trailing space should be appended - * \param sel_string string to append to, may be resized + * \param text text to be added + * \param length length of text in bytes + * \param space indicates whether a trailing space should be appended + * \param style The font style to use. + * \param sel_string string to append to, may be resized * \return true iff successful */ @@ -959,6 +960,7 @@ void selection_set_end(struct selection *s, unsigned offset) * * \param s the selection object * \param start byte offset of start of text + * \param end byte offset of end of text * \param start_idx receives the start index (in bytes) of the highlighted portion * \param end_idx receives the end index (in bytes) * \return true iff part of the given box lies within the selection -- cgit v1.2.3