From 840b3f9c1e5ed9a5aa458fea36bc1e561402df94 Mon Sep 17 00:00:00 2001 From: Geoff McLane Date: Tue, 4 Sep 2018 20:21:48 +0200 Subject: [PATCH] Is #752 - Slightly enhance the API doxy docs --- include/tidy.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/tidy.h b/include/tidy.h index c701890..c1bbd41 100644 --- a/include/tidy.h +++ b/include/tidy.h @@ -481,16 +481,16 @@ TIDY_EXPORT void TIDY_CALL tidyGeneralInfo( TidyDoc tdoc ); /** Load an ASCII Tidy configuration file and set the configuration per its - ** contents. - ** @result Returns 0 upon success, or any other value if there was an error. + ** contents. Reports config option errors, which can be filtered. + ** @result Returns 0 upon success, or any other value if there was an option error. */ TIDY_EXPORT int TIDY_CALL tidyLoadConfig(TidyDoc tdoc, /**< The TidyDoc to which to apply the configuration. */ ctmbstr configFile /**< The complete path to the file to load. */ ); /** Load a Tidy configuration file with the specified character encoding, and - ** set the configuration per its contents. - ** @result Returns 0 upon success, or any other value if there was an error. + ** set the configuration per its contents. Reports config option errors, which can be filtered. + ** @result Returns 0 upon success, or any other value if there was an option error. */ TIDY_EXPORT int TIDY_CALL tidyLoadConfigEnc(TidyDoc tdoc, /**< The TidyDoc to which to apply the configuration. */ ctmbstr configFile, /**< The complete path to the file to load. */