aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/HtmlParser.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/include/HtmlParser.h b/include/HtmlParser.h
index 5c1f4c1..1e23d0d 100644
--- a/include/HtmlParser.h
+++ b/include/HtmlParser.h
@@ -56,10 +56,12 @@ struct HtmlParser {
/*
Returns the value returned from |parse_callback|. 0 meaning success.
+ Input text is expected to be in utf8 and may or may not have UTF8-BOM.
Note: HTML_PARSE_TAG_START is guaranteed to be called for a tag before HTML_PARSE_TAG_END.
Note: HTML_PARSE_TEXT may be called multiple times for a tag. For example if a tag has multiple text items split between child tags
like this: <div>hello<h1>text</h1>world</div>.
In this case, HTML_PARSE_TEXT will be called twice for the div tag. First with "hello" and then with "world".
+ This function does 0 dynamic memory allocations.
*/
int html_parser_parse(const char *html_source, size_t len, HtmlParseCallback parse_callback, void *userdata);