emelie/tidy-html5
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Added documentation per #744. No version bump for documentation change.

Browse source
This commit is contained in:
Jim Derry 2021-07-09 15:16:07 -04:00
parent bed8efb620
commit 2614283faf
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/tidy.h
View file

@ -1568,7 +1568,9 @@ TIDY_EXPORT int TIDY_CALL tidyParseFile(TidyDoc tdoc, /**< The tidy d
*/
TIDY_EXPORT int TIDY_CALL tidyParseStdin( TidyDoc tdoc );
/** Parse markup in given string.
/** Parse markup in given string. Note that the supplied string is of type
** `ctmbstr` based on `char` and therefore doesn't support the use of
** UTF-16 strings. Use `tidyParseBuffer()` if parsing multibyte strings.
** @result Returns the highest of `2` indicating that errors were present in
** the document, `1` indicating warnings, and `0` in the case of
** everything being okay.