emelie/tidy-html5
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Improve tidySaveString API documentation.

Browse source 
This was suggested by Kevin Locke back in SF bug 917 Nov, 2009. Has taken
some time to filter through!
This commit is contained in:
Geoff McLane 2016-02-13 18:34:36 +01:00
parent fbde392af3
commit c66bb848f2
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/tidy.h
View file

@ -744,9 +744,13 @@ TIDY_EXPORT int TIDY_CALL tidySaveStdout( TidyDoc tdoc );
/** Save to given TidyBuffer object */ /** Save to given TidyBuffer object */
TIDY_EXPORT int TIDY_CALL tidySaveBuffer( TidyDoc tdoc, TidyBuffer* buf ); TIDY_EXPORT int TIDY_CALL tidySaveBuffer( TidyDoc tdoc, TidyBuffer* buf );
/** Save document to application buffer. If buffer is not big enough, /** Save document to application buffer. If TidyShowMarkup and
** ENOMEM will be returned and the necessary buffer size will be placed ** the document has no errors, or TidyForceOutput, the current
** in *buflen. ** document, per the current configuration, will be Pretty Printed
** to the application buffer. The document byte length,
** not character length, will be placed in *buflen. The document
** will not be null terminated. If the buffer is not big enough,
** ENOMEM will be returned, else the actual document status.
*/ */
TIDY_EXPORT int TIDY_CALL tidySaveString( TidyDoc tdoc, TIDY_EXPORT int TIDY_CALL tidySaveString( TidyDoc tdoc,
tmbstr buffer, uint* buflen ); tmbstr buffer, uint* buflen );