From 2614283fafdd5e43bc53177553429b6555b2ea49 Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Fri, 9 Jul 2021 15:16:07 -0400 Subject: [PATCH] Added documentation per #744. No version bump for documentation change. --- include/tidy.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/include/tidy.h b/include/tidy.h index 35c3b21..c8c77a3 100644 --- a/include/tidy.h +++ b/include/tidy.h @@ -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.