From f5792d4ef89317329076a5143eb346b7f5e6651d Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Tue, 1 Sep 2015 12:55:03 +0100 Subject: Fix doxygen warnings --- docs/Doxyfile | 1 - include/hubbub/functypes.h | 2 +- src/charset/detect.c | 2 +- src/parser.c | 2 +- src/tokeniser/entities.c | 8 ++++---- 5 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index 67fdf69..43fc260 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -657,7 +657,6 @@ WARN_LOGFILE = INPUT = src \ src/charset \ - src/input \ src/tokeniser \ src/treebuilder \ src/utils \ diff --git a/include/hubbub/functypes.h b/include/hubbub/functypes.h index e7cbe6e..d8c9175 100644 --- a/include/hubbub/functypes.h +++ b/include/hubbub/functypes.h @@ -33,7 +33,7 @@ typedef hubbub_error (*hubbub_token_handler)( * Type of parse error handling function * * \param line Source line on which error occurred - * \param col Column in ::line of start of erroneous input + * \param col Column in \p line of start of erroneous input * \param message Error message * \param pw Pointer to client data */ diff --git a/src/charset/detect.c b/src/charset/detect.c index efb900a..93cbe63 100644 --- a/src/charset/detect.c +++ b/src/charset/detect.c @@ -36,7 +36,7 @@ static bool hubbub_charset_get_attribute(const uint8_t **data, * \param source Pointer to location containint current charset source * \return PARSERUTILS_OK on success, appropriate error otherwise * - * ::mibenum and ::source will be updated on exit + * \p mibenum and \p source will be updated on exit * * The larger a chunk of data fed to this routine, the better, as it allows * charset autodetection access to a larger dataset for analysis. diff --git a/src/parser.c b/src/parser.c index 671e129..abd9dc8 100644 --- a/src/parser.c +++ b/src/parser.c @@ -36,7 +36,7 @@ struct hubbub_parser { * \return HUBBUB_OK on success, * HUBBUB_BADPARM on bad parameters, * HUBBUB_NOMEM on memory exhaustion, - * HUBBUB_BADENCODING if ::enc is unsupported + * HUBBUB_BADENCODING if \p enc is unsupported */ hubbub_error hubbub_parser_create(const char *enc, bool fix_enc, hubbub_parser **parser) diff --git a/src/tokeniser/entities.c b/src/tokeniser/entities.c index ac47d80..c977fad 100644 --- a/src/tokeniser/entities.c +++ b/src/tokeniser/entities.c @@ -30,11 +30,11 @@ typedef struct hubbub_entity_node { * HUBBUB_NEEDDATA if more steps are required * HUBBUB_INVALID if nothing matches * - * The value pointed to by ::context must be NULL for the first call. + * The value pointed to by \p context must be NULL for the first call. * Thereafter, pass in the same value as returned by the previous call. * The context is opaque to the caller and should not be inspected. * - * The location pointed to by ::result will be set to NULL unless a match + * The location pointed to by \p result will be set to NULL unless a match * is found. */ static hubbub_error hubbub_entity_tree_search_step(uint8_t c, @@ -93,11 +93,11 @@ static hubbub_error hubbub_entity_tree_search_step(uint8_t c, * HUBBUB_NEEDDATA if more steps are required * HUBBUB_INVALID if nothing matches * - * The value pointed to by ::context should be -1 for the first call. + * The value pointed to by \p context should be -1 for the first call. * Thereafter, pass in the same value as returned by the previous call. * The context is opaque to the caller and should not be inspected. * - * The location pointed to by ::result will be set to U+FFFD unless a match + * The location pointed to by \p result will be set to U+FFFD unless a match * is found. */ hubbub_error hubbub_entities_search_step(uint8_t c, uint32_t *result, -- cgit v1.2.3