Updated documentation for tidyOptIsReadOnly(). As this is documentation only,

no version bump.
This commit is contained in:
Jim Derry 2017-11-17 21:47:26 -05:00
parent 2957cb135b
commit 79f0d5752f

View file

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