Skip to content

Commit 840b3f9

Browse files
committed
Is #752 - Slightly enhance the API doxy docs
1 parent 4ba6106 commit 840b3f9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

include/tidy.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -481,16 +481,16 @@ TIDY_EXPORT void TIDY_CALL tidyGeneralInfo( TidyDoc tdoc );
481481

482482

483483
/** Load an ASCII Tidy configuration file and set the configuration per its
484-
** contents.
485-
** @result Returns 0 upon success, or any other value if there was an error.
484+
** contents. Reports config option errors, which can be filtered.
485+
** @result Returns 0 upon success, or any other value if there was an option error.
486486
*/
487487
TIDY_EXPORT int TIDY_CALL tidyLoadConfig(TidyDoc tdoc, /**< The TidyDoc to which to apply the configuration. */
488488
ctmbstr configFile /**< The complete path to the file to load. */
489489
);
490490

491491
/** Load a Tidy configuration file with the specified character encoding, and
492-
** set the configuration per its contents.
493-
** @result Returns 0 upon success, or any other value if there was an error.
492+
** set the configuration per its contents. Reports config option errors, which can be filtered.
493+
** @result Returns 0 upon success, or any other value if there was an option error.
494494
*/
495495
TIDY_EXPORT int TIDY_CALL tidyLoadConfigEnc(TidyDoc tdoc, /**< The TidyDoc to which to apply the configuration. */
496496
ctmbstr configFile, /**< The complete path to the file to load. */

0 commit comments

Comments
 (0)