Skip to content

Commit 79f0d57

Browse files
committed
Updated documentation for tidyOptIsReadOnly(). As this is documentation only,
no version bump.
1 parent 2957cb1 commit 79f0d57

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

include/tidy.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -714,6 +714,9 @@ TIDY_EXPORT TidyOptionType TIDY_CALL tidyOptGetType( TidyOption opt );
714714

715715
/** Is Option read-only? Some options (mainly internal use only options) are
716716
** read-only.
717+
** @deprecated This is no longer a valid test for the public API; instead
718+
** you should test an option's availability using `tidyOptGetCategory()`
719+
** against `TidyInternalCategory`. This API will be removed!
717720
** @param opt An instance of a TidyOption to query.
718721
** @result Returns `yes` or `no` depending on whether or not the specified
719722
** option is read-only.

0 commit comments

Comments
 (0)