From 9fde3502b659d3858cd1978d2c6535c57efbe924 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Wed, 12 Nov 2014 23:27:13 +0000 Subject: doxygen cleanups in utils --- utils/filename.c | 2 +- utils/http/generics.c | 2 +- utils/idna.c | 3 ++- utils/libdom.c | 8 +++++--- utils/libdom.h | 2 ++ utils/nsoption.c | 4 +++- utils/nsoption.h | 5 +++-- utils/nsurl.h | 4 +--- utils/url.h | 4 +++- 9 files changed, 21 insertions(+), 13 deletions(-) (limited to 'utils') diff --git a/utils/filename.c b/utils/filename.c index a89a1ab59..5efd56177 100644 --- a/utils/filename.c +++ b/utils/filename.c @@ -367,7 +367,7 @@ bool filename_flush_directory(const char *folder, int depth) /** * Recursively deletes the contents of a directory * - * \param directory the directory to delete + * \param folder the directory to delete * \return true on success, false otherwise */ bool filename_delete_recursive(char *folder) diff --git a/utils/http/generics.c b/utils/http/generics.c index 129a56f69..e0798f901 100644 --- a/utils/http/generics.c +++ b/utils/http/generics.c @@ -43,7 +43,7 @@ void http___item_list_destroy(http__item *list) * \param input Pointer to current input byte. Updated on exit. * \param itemparser Pointer to function to parse list items * \param first Pointer to first item, or NULL. - * \param parameters Pointer to location to receive on-heap parameter list. + * \param items Pointer to location to receive on-heap parameter list. * \return NSERROR_OK on success, * NSERROR_NOMEM on memory exhaustion, * NSERROR_NOT_FOUND if no items could be parsed diff --git a/utils/idna.c b/utils/idna.c index b979e4ecf..0a492fadc 100644 --- a/utils/idna.c +++ b/utils/idna.c @@ -146,8 +146,9 @@ static bool idna__contexto_rule(int32_t cp) * Check if a CONTEXTJ codepoint has a rule defined, * and conforms to that rule. * - * \param string UCS-4 string + * \param label UCS-4 string * \param index character in the string which is CONTEXTJ + * \param len The length of the label * \return true if conforming */ static bool idna__contextj_rule(int32_t *label, int index, size_t len) diff --git a/utils/libdom.c b/utils/libdom.c index d6b26b46b..a996e98bf 100644 --- a/utils/libdom.c +++ b/utils/libdom.c @@ -314,9 +314,10 @@ static void ignore_dom_msg(uint32_t severity, void *ctx, const char *msg, ...) /** * Dump attribute/value for an element node * - * \param node The element node to dump attribute details for - * \param attribute The attribute to dump - * \return true on success, or false on error + * \param node The element node to dump attribute details for + * \param f file handle to dump to. + * \param attribute The attribute to dump + * \return true on success, or false on error */ static bool dump_dom_element_attribute(dom_node *node, FILE *f, const char *attribute) { @@ -376,6 +377,7 @@ static bool dump_dom_element_attribute(dom_node *node, FILE *f, const char *attr * Print a line in a DOM structure dump for an element * * \param node The node to dump + * \param f file handle to dump to. * \param depth The node's depth * \return true on success, or false on error */ diff --git a/utils/libdom.h b/utils/libdom.h index 4f78cd2e9..becada315 100644 --- a/utils/libdom.h +++ b/utils/libdom.h @@ -36,6 +36,8 @@ * depth-first walk the dom calling callback for each element * * \param root the dom node to use as the root of the tree walk + * \param callback The function called for each element + * \param ctx The context passed to teh callback. * \return true if all nodes were examined, false if the callback terminated * the walk early. */ diff --git a/utils/nsoption.c b/utils/nsoption.c index 669b26c3d..e987a4316 100644 --- a/utils/nsoption.c +++ b/utils/nsoption.c @@ -442,7 +442,9 @@ nsoption_output_value_text(struct nsoption_s *option, * * Allocates a new option table and copies an existing one into it. * - * @param src The source table to copy + * \param[in] src The source table to copy + * \param[out] pdst The output table + * \return NSERROR_OK on success or appropriate error code. */ static nserror nsoption_dup(struct nsoption_s *src, struct nsoption_s **pdst) diff --git a/utils/nsoption.h b/utils/nsoption.h index 134223aa5..75558f475 100644 --- a/utils/nsoption.h +++ b/utils/nsoption.h @@ -16,7 +16,8 @@ * along with this program. If not, see . */ -/** \file +/** + * \file * Option reading and saving (interface). * * Global options are defined in desktop/options.h @@ -172,7 +173,7 @@ typedef nserror(nsoption_set_default_t)(struct nsoption_s *defaults); * * @param set_default callback to allow the customisation of the default * options. - * @param ppots pointer to update to get options table or NULL. + * @param popts pointer to update to get options table or NULL. * @param pdefs pointer to update to get default options table or NULL. * @return The error status */ diff --git a/utils/nsurl.h b/utils/nsurl.h index ec00dede9..13f7e5f47 100644 --- a/utils/nsurl.h +++ b/utils/nsurl.h @@ -90,10 +90,8 @@ void nsurl_unref(nsurl *url); * \param url1 First NetSurf URL * \param url2 Second NetSurf URL * \param parts The URL components to be compared - * \param match Returns true if url1 and url2 matched, else false - * \return NSERROR_OK on success, appropriate error otherwise + * \return true on match else false * - * If return value != NSERROR_OK, match will be false. */ bool nsurl_compare(const nsurl *url1, const nsurl *url2, nsurl_component parts); diff --git a/utils/url.h b/utils/url.h index d6c5b917c..143a0a0fe 100644 --- a/utils/url.h +++ b/utils/url.h @@ -49,7 +49,9 @@ nserror url_escape(const char *unescaped, size_t toskip, bool sptoplus, const ch /** * Convert an escaped string to plain. - * \param result unescaped string owned by caller must be freed with free() + * + * \param[in] str String to unescape. + * \param[out] result unescaped string owned by caller must be freed with free() * \return NSERROR_OK on success */ nserror url_unescape(const char *str, char **result); -- cgit v1.2.3