aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2021-07-02 20:36:08 +0200
committerdec05eba <dec05eba@protonmail.com>2021-07-02 20:36:08 +0200
commitfd8f0358ceb43c423a4180e23fcd5b9f6201d829 (patch)
treed4edca21c5157cc354c7e080fea099fc63179d56 /include
parent27e448cf28cfe4ba24ab838cb6eb96711bf103a6 (diff)
Update docs
Diffstat (limited to 'include')
-rw-r--r--include/HtmlParser.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/HtmlParser.h b/include/HtmlParser.h
index a7cdb4f..5c1f4c1 100644
--- a/include/HtmlParser.h
+++ b/include/HtmlParser.h
@@ -56,7 +56,10 @@ struct HtmlParser {
/*
Returns the value returned from |parse_callback|. 0 meaning success.
- Note: HTML_PARSE_TAG_START is guaranteed to be called for a tag before HTML_PARSE_TAG_END
+ 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".
*/
int html_parser_parse(const char *html_source, size_t len, HtmlParseCallback parse_callback, void *userdata);