From e32a2ad46e76438a53fb1157e90215493a93d2f5 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Sun, 9 Nov 2014 15:28:03 +0000 Subject: Doxygen fixes --- content/fs_backing_store.c | 1 + content/urldb.c | 4 ++-- css/css.c | 27 ++++++++++++++++----------- css/select.c | 2 +- css/utils.h | 4 ++-- utils/utils.h | 15 +++++++++------ 6 files changed, 31 insertions(+), 22 deletions(-) diff --git a/content/fs_backing_store.c b/content/fs_backing_store.c index 595d4bf6d..33f559671 100644 --- a/content/fs_backing_store.c +++ b/content/fs_backing_store.c @@ -236,6 +236,7 @@ remove_store_entry(struct store_state *state, * * @param state The store state to use. * @param ident The identifier to use. + * @param flags flags to control the filename used. * @return The filename string or NULL on allocation error. */ static char * diff --git a/content/urldb.c b/content/urldb.c index 8af6ae150..e7cb551d0 100644 --- a/content/urldb.c +++ b/content/urldb.c @@ -406,7 +406,7 @@ static void urldb_count_urls(const struct path_data *root, time_t expiry, /** * Save a search (sub)tree * - * \param root Root of (sub)tree to save + * \param parent root node of search tree to save. * \param fp File to write to */ static void urldb_save_search_tree(struct search_node *parent, FILE *fp) @@ -1515,7 +1515,7 @@ urldb_search_insert(struct search_node *root, const struct host_part *data) * \param c Cookie struct to populate * \param n Name component * \param v Value component - * \param was_quoted Whether ::v was quoted in the input + * \param was_quoted Whether \a v was quoted in the input * \return true on success, false on memory exhaustion */ static bool urldb_parse_avpair(struct cookie_internal_data *c, char *n, diff --git a/css/css.c b/css/css.c index 9dc6e8cba..641d988ad 100644 --- a/css/css.c +++ b/css/css.c @@ -79,10 +79,6 @@ typedef struct { * imports array */ } nscss_import_ctx; -static nserror nscss_create(const content_handler *handler, - lwc_string *imime_type, const http_parameter *params, - llcache_handle *llcache, const char *fallback_charset, - bool quirks, struct content **c); static bool nscss_process_data(struct content *c, const char *data, unsigned int size); static bool nscss_convert(struct content *c); @@ -117,14 +113,23 @@ static css_stylesheet *blank_import; /** * Initialise a CSS content * - * \param c Content to initialise - * \param params Content-Type parameters - * \return true on success, false on failure + * \param handler content handler + * \param imime_type mime-type + * \param params Content-Type parameters + * \param llcache handle to content + * \param fallback_charset The character set to fallback to. + * \param quirks allow quirks + * \param c Content to initialise + * \return NSERROR_OK or error cod eon faliure */ -nserror nscss_create(const content_handler *handler, - lwc_string *imime_type, const http_parameter *params, - llcache_handle *llcache, const char *fallback_charset, - bool quirks, struct content **c) +static nserror +nscss_create(const content_handler *handler, + lwc_string *imime_type, + const http_parameter *params, + llcache_handle *llcache, + const char *fallback_charset, + bool quirks, + struct content **c) { nscss_content *result; const char *charset = NULL; diff --git a/css/select.c b/css/select.c index cb98f24ec..2d7c30f7a 100644 --- a/css/select.c +++ b/css/select.c @@ -1473,7 +1473,7 @@ node_count_siblings_check(dom_node *node, * Callback to count a node's siblings. * * \param pw HTML document - * \param node DOM node + * \param n DOM node * \param same_name Only count siblings with the same name, or all * \param after Count anteceding instead of preceding siblings * \param count Pointer to location to receive result diff --git a/css/utils.h b/css/utils.h index f3131f1bb..e9650db97 100644 --- a/css/utils.h +++ b/css/utils.h @@ -30,7 +30,7 @@ extern css_fixed nscss_screen_dpi; * * ARGB -> (1-A)BGR * - * \param color The CSS color to convert + * \param c The CSS color to convert * \return Corresponding NetSurf colour primitive */ #define nscss_color_to_ns(c) \ @@ -45,7 +45,7 @@ extern css_fixed nscss_screen_dpi; * * (1-A)BGR -> ARGB * - * \param color The NetSurf color to convert + * \param c The NetSurf color to convert * \return Corresponding CSS colour primitive */ #define ns_color_to_nscss(c) \ diff --git a/utils/utils.h b/utils/utils.h index e2865d738..3fec34aa1 100644 --- a/utils/utils.h +++ b/utils/utils.h @@ -38,10 +38,10 @@ #include "utils/errors.h" -/* Rectangle coordinates */ +/** Rectangle coordinates */ struct rect { - int x0, y0; /* Top left */ - int x1, y1; /* Bottom right */ + int x0, y0; /**< Top left */ + int x1, y1; /**< Bottom right */ }; struct dirent; @@ -145,7 +145,10 @@ char * squash_whitespace(const char * s); /** * returns a string without its underscores + * + * \param s The string to change. * \param replacespace true to insert a space where there was an underscore + * \return The altered string */ char *remove_underscores(const char *s, bool replacespace); @@ -183,7 +186,7 @@ nserror regcomp_wrapper(regex_t *preg, const char *regex, int cflags); * @todo This implementation is strange doe sit need * reconsidering? * - * @param bsize The size in bytes. + * @param bytesize The size in bytes. * @return A human readable string representing the size. */ char *human_friendly_bytesize(unsigned long bytesize); @@ -222,7 +225,7 @@ unsigned int wallclock(void); * NULL on input and if not NULL set to the total * output length on output. * @param[in] sep The character to separete the elemnts with. - * @param[in] nemb The number of elements up to a maximum of 16. + * @param[in] nelm The number of elements up to a maximum of 16. * @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. @@ -244,7 +247,7 @@ nserror vsnstrjoin(char **str, size_t *size, char sep, size_t nelm, va_list ap); * NULL on input and if not NULL set to the total * output length on output. * @param[in] sep The character to separete the elemnts with. - * @param[in] nemb The number of elements up to a maximum of 16. + * @param[in] nelm The number of elements up to a maximum of 16. * @param[in] ... The elements of the path as string pointers. * @return NSERROR_OK and the complete path is written to str or error * code on faliure. -- cgit v1.2.3