From 25cdea33516b200b9740a091e4437e48c0607372 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Tue, 24 Jul 2012 16:19:49 +0100 Subject: doxygen serious warning cleanup --- content/urldb.c | 2 +- css/select.c | 2 +- desktop/browser.c | 9 +++++---- desktop/browser.h | 2 +- desktop/download.c | 3 ++- desktop/download.h | 3 ++- desktop/plot_style.c | 4 +++- render/box.h | 4 ++-- utils/filepath.h | 5 ++++- utils/url.h | 9 ++++++--- 10 files changed, 27 insertions(+), 16 deletions(-) diff --git a/content/urldb.c b/content/urldb.c index 733875638..a8b4839fe 100644 --- a/content/urldb.c +++ b/content/urldb.c @@ -167,7 +167,7 @@ struct path_data { * the default port for given scheme, i.e. * 80 (http), 443 (https). */ char *segment; /**< Path segment for this node */ - unsigned int frag_cnt; /**< Number of entries in ::fragment */ + unsigned int frag_cnt; /**< Number of entries in path_data::fragment */ char **fragment; /**< Array of fragments */ bool persistent; /**< This entry should persist */ diff --git a/css/select.c b/css/select.c index 86f08ab06..59f2641cc 100644 --- a/css/select.c +++ b/css/select.c @@ -3367,7 +3367,7 @@ bool parse_number(const char *data, bool maybe_negative, bool real, } /** - * Parse a font @size attribute + * Parse a font \@size attribute * * \param size Data to parse (NUL-terminated) * \param val Pointer to location to receive enum value diff --git a/desktop/browser.c b/desktop/browser.c index 94330048a..bd819b412 100644 --- a/desktop/browser.c +++ b/desktop/browser.c @@ -1622,7 +1622,7 @@ void browser_window_update(struct browser_window *bw, bool scroll_to_top) browser_window_set_scroll(bw, 0, 0); /* if frag_id exists, then try to scroll to it */ - /** \TODO don't do this if the user has scrolled */ + /** @todo don't do this if the user has scrolled */ if (bw->frag_id && html_get_id_offset(bw->current_content, bw->frag_id, &x, &y)) { browser_window_set_scroll(bw, x, y); @@ -1641,7 +1641,7 @@ void browser_window_update(struct browser_window *bw, bool scroll_to_top) browser_window_set_scroll(bw, 0, 0); /* if frag_id exists, then try to scroll to it */ - /** \TODO don't do this if the user has scrolled */ + /** @todo don't do this if the user has scrolled */ if (bw->frag_id && html_get_id_offset(bw->current_content, bw->frag_id, &x, &y)) { browser_window_set_scroll(bw, x, y); @@ -1659,7 +1659,7 @@ void browser_window_update(struct browser_window *bw, bool scroll_to_top) browser_window_set_scroll(bw, 0, 0); /* if frag_id exists, then try to scroll to it */ - /** \TODO don't do this if the user has scrolled */ + /** @todo don't do this if the user has scrolled */ if (bw->frag_id && html_get_id_offset(bw->current_content, bw->frag_id, &x, &y)) { browser_window_set_scroll(bw, x, y); @@ -1849,7 +1849,8 @@ void browser_window_set_status(struct browser_window *bw, const char *text) /** * Change the shape of the mouse pointer * - * \param shape shape to use + * \param bw Browser window to set shape in + * \param shape The pointer shape to use */ void browser_window_set_pointer(struct browser_window *bw, diff --git a/desktop/browser.h b/desktop/browser.h index 09107a3e6..c8af7889c 100644 --- a/desktop/browser.h +++ b/desktop/browser.h @@ -202,7 +202,7 @@ struct browser_window { /** cache of the currently displayed status text. */ char *status_text; /**< Current status bar text. */ - int status_text_len; /**< Length of the ::status_text buffer. */ + int status_text_len; /**< Length of the browser_window::status_text buffer. */ int status_match; /**< Number of times an idempotent status-set operation was performed. */ int status_miss; /**< Number of times status was really updated. */ }; diff --git a/desktop/download.c b/desktop/download.c index fd91ed396..f4bedc8e9 100644 --- a/desktop/download.c +++ b/desktop/download.c @@ -17,7 +17,8 @@ */ /** - * \file Core download context (implementation) + * \file desktop/download.c + * \brief Core download context implementation */ #include diff --git a/desktop/download.h b/desktop/download.h index cbdf96718..f53f38b95 100644 --- a/desktop/download.h +++ b/desktop/download.h @@ -17,7 +17,8 @@ */ /** - * \file Core download context (interface) + * \file desktop/download.h + * \brief Core download context (interface) */ #ifndef NETSURF_DESKTOP_DOWNLOAD_H_ diff --git a/desktop/plot_style.c b/desktop/plot_style.c index 04d2885ff..85b898968 100644 --- a/desktop/plot_style.c +++ b/desktop/plot_style.c @@ -16,7 +16,9 @@ * along with this program. If not, see . */ -/** \file Plotter global styles. +/** + * \file desktop/plot_style.c + * \brief Plotter global styles. * * These plot styles are globaly available and used in many places. */ diff --git a/render/box.h b/render/box.h index 4414a058f..492cd838f 100644 --- a/render/box.h +++ b/render/box.h @@ -283,7 +283,7 @@ struct column { bool positioned; }; -/** Parameters for and similar elements. */ +/** Parameters for object element and similar elements. */ struct object_params { nsurl *data; char *type; @@ -293,7 +293,7 @@ struct object_params { struct object_param *params; }; -/** Linked list of parameters. */ +/** Linked list of object element parameters. */ struct object_param { char *name; char *value; diff --git a/utils/filepath.h b/utils/filepath.h index 08dd050d3..ff3ebe90e 100644 --- a/utils/filepath.h +++ b/utils/filepath.h @@ -16,7 +16,10 @@ * along with this program. If not, see . */ -/** \file Utility routines to obtain paths to file resources. */ +/** + * \file utils/filepath.h + * \brief Utility routines to obtain paths to file resources. + */ #ifndef _NETSURF_UTILS_FILEPATH_H_ #define _NETSURF_UTILS_FILEPATH_H_ diff --git a/utils/url.h b/utils/url.h index 8d41b139c..fa5c67faa 100644 --- a/utils/url.h +++ b/utils/url.h @@ -17,17 +17,20 @@ * along with this program. If not, see . */ -/** \file - * URL parsing and joining (interface). +/** + * \file utils/url.h + * \brief URL parsing and joining (interface). */ #ifndef _NETSURF_UTILS_URL_H_ #define _NETSURF_UTILS_URL_H_ -/* file url prefix */ +/** File url prefix */ #define FILE_SCHEME_PREFIX "file:///" +/** File url prefix length */ #define FILE_SCHEME_PREFIX_LEN 8 +/** URL utility function return codes */ typedef enum { URL_FUNC_OK, /**< No error */ URL_FUNC_NOMEM, /**< Insufficient memory */ -- cgit v1.2.3