diff options
author | John Mark Bell <jmb@netsurf-browser.org> | 2009-01-08 19:38:36 +0000 |
---|---|---|
committer | John Mark Bell <jmb@netsurf-browser.org> | 2009-01-08 19:38:36 +0000 |
commit | 5a8784817cc0ff505a502d20e6eb6975ef281d15 (patch) | |
tree | 899dff475bfc40c3dcc72bf4808a0859752a8dbe /src/tokeniser | |
parent | 024709d09ec4dbf301588258360fa9891c17000e (diff) | |
download | libhubbub-5a8784817cc0ff505a502d20e6eb6975ef281d15.tar.gz libhubbub-5a8784817cc0ff505a502d20e6eb6975ef281d15.tar.bz2 |
Use doxygen to create API documentation.
Add a bunch of extra commentary to stop doxygen warning.
svn path=/trunk/hubbub/; revision=5994
Diffstat (limited to 'src/tokeniser')
-rw-r--r-- | src/tokeniser/entities.c | 7 | ||||
-rw-r--r-- | src/tokeniser/tokeniser.c | 25 | ||||
-rw-r--r-- | src/tokeniser/tokeniser.h | 8 |
3 files changed, 22 insertions, 18 deletions
diff --git a/src/tokeniser/entities.c b/src/tokeniser/entities.c index 23756a6..8bea1aa 100644 --- a/src/tokeniser/entities.c +++ b/src/tokeniser/entities.c @@ -11,9 +11,12 @@ typedef struct hubbub_entity hubbub_entity; +/** + * Entity mapping table + */ static const struct hubbub_entity { - const char *name; - uint32_t ucs4; + const char *name; /**< Entity name */ + uint32_t ucs4; /**< UCS-4 codepoint */ } entities[] = { { "Aacute;", 0x000C1 }, { "Aacute", 0x000C1 }, diff --git a/src/tokeniser/tokeniser.c b/src/tokeniser/tokeniser.c index 6ffa8b7..fbc9534 100644 --- a/src/tokeniser/tokeniser.c +++ b/src/tokeniser/tokeniser.c @@ -107,21 +107,22 @@ typedef struct hubbub_tokeniser_context { uint8_t last_start_tag_name[10]; /**< Name of the last start tag * emitted */ - size_t last_start_tag_len; + size_t last_start_tag_len; /**< Length of last start tag */ struct { uint32_t count; bool match; - } close_tag_match; + } close_tag_match; /**< State for matching close + * tags */ struct { uint32_t count; /**< Index into "DOCTYPE" */ - } match_doctype; + } match_doctype; /**< State for matching doctype */ struct { uint32_t count; /**< Index into "[CDATA[" */ uint32_t end; /**< Index into "]]>" */ - } match_cdata; + } match_cdata; /**< State for matching cdata */ struct { size_t offset; /**< Offset in buffer */ @@ -145,15 +146,15 @@ typedef struct hubbub_tokeniser_context { * numeric entity value */ hubbub_tokeniser_state return_state; /**< State we were * called from */ - } match_entity; + } match_entity; /**< Entity matching state */ struct { uint32_t line; /**< Current line of input */ uint32_t col; /**< Current character in * line */ - } position; + } position; /**< Position in source data */ - uint32_t allowed_char; + uint32_t allowed_char; /**< Used for quote matching */ } hubbub_tokeniser_context; /** @@ -164,18 +165,18 @@ struct hubbub_tokeniser { hubbub_content_model content_model; /**< Current content * model flag */ bool escape_flag; /**< Escape flag **/ - bool process_cdata_section; + bool process_cdata_section; /**< Whether to process CDATA sections*/ parserutils_inputstream *input; /**< Input stream */ parserutils_buffer *buffer; /**< Input buffer */ hubbub_tokeniser_context context; /**< Tokeniser context */ - hubbub_token_handler token_handler; - void *token_pw; + hubbub_token_handler token_handler; /**< Token handling callback */ + void *token_pw; /**< Token handler data */ - hubbub_error_handler error_handler; - void *error_pw; + hubbub_error_handler error_handler; /**< Error handling callback */ + void *error_pw; /**< Error handler data */ hubbub_alloc alloc; /**< Memory (de)allocation function */ void *alloc_pw; /**< Client private data */ diff --git a/src/tokeniser/tokeniser.h b/src/tokeniser/tokeniser.h index a5bc8de..0ccb7d1 100644 --- a/src/tokeniser/tokeniser.h +++ b/src/tokeniser/tokeniser.h @@ -36,18 +36,18 @@ typedef union hubbub_tokeniser_optparams { struct { hubbub_token_handler handler; void *pw; - } token_handler; + } token_handler; /**< Token handling callback */ struct { hubbub_error_handler handler; void *pw; - } error_handler; + } error_handler; /**< Error handling callback */ struct { hubbub_content_model model; - } content_model; + } content_model; /**< Current content model */ - bool process_cdata; + bool process_cdata; /**< Whether to process CDATA sections*/ } hubbub_tokeniser_optparams; /* Create a hubbub tokeniser */ |