dany/pdfio
1
0
Fork 0
mirror of https://github.com/michaelrsweet/pdfio.git synced 2025-08-29 23:32:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document how warning messages work (Issue #118)

Browse Source
This commit is contained in:
Michael R Sweet
2025-08-26 15:18:36 -04:00
parent c8017f50f6
commit ccf3a90c97
4 changed files with 153 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
pdfio-file.c
View File

@@ -190,8 +190,22 @@ pdfioFileClose(pdfio_file_t *pdf) // I - PDF file
//
// The "error_cb" and "error_cbdata" arguments specify an error handler callback
// and its data pointer - if `NULL` then the default error handler is used that
// writes error messages to `stderr`. The error handler callback should return
// `true` to continue writing the PDF file or `false` to stop.
// writes error and warning messages to `stderr`. The error handler callback
// should return `true` to continue writing the PDF file or `false` to stop.
// For example:
//
// ```
// bool
// my_error_cb(pdfio_file_t *pdf, const char *message, void *data)
// {
// (void)data; /* Not using data pointer in this callback */
//
// fprintf(stderr, "%s: %s\n", pdfioFileGetName(pdf), message);
//
// /* Return true to continue on warning messages, false otherwise... */
// return (!strncmp(message, "WARNING:", 8));
// }
// ```
//
pdfio_file_t * // O - PDF file or `NULL` on error
@@ -429,8 +443,22 @@ _pdfioFileCreateObj(
//
// The "error_cb" and "error_cbdata" arguments specify an error handler callback
// and its data pointer - if `NULL` then the default error handler is used that
// writes error messages to `stderr`. The error handler callback should return
// `true` to continue writing the PDF file or `false` to stop.
// writes error and warning messages to `stderr`. The error handler callback
// should return `true` to continue writing the PDF file or `false` to stop.
// For example:
//
// ```
// bool
// my_error_cb(pdfio_file_t *pdf, const char *message, void *data)
// {
// (void)data; /* Not using data pointer in this callback */
//
// fprintf(stderr, "%s: %s\n", pdfioFileGetName(pdf), message);
//
// /* Return true to continue on warning messages, false otherwise... */
// return (!strncmp(message, "WARNING:", 8));
// }
// ```
//
// > *Note*: Files created using this API are slightly larger than those
// > created using the @link pdfioFileCreate@ function since stream lengths are
@@ -1023,8 +1051,22 @@ pdfioFileGetVersion(
//
// The "error_cb" and "error_cbdata" arguments specify an error handler callback
// and its data pointer - if `NULL` then the default error handler is used that
// writes error messages to `stderr`. The error handler callback should return
// `true` to continue reading the PDF file or `false` to stop.
// writes error and warning messages to `stderr`. The error handler callback
// should return `true` to continue reading the PDF file or `false` to stop.
// For example:
//
// ```
// bool
// my_error_cb(pdfio_file_t *pdf, const char *message, void *data)
// {
// (void)data; /* Not using data pointer in this callback */
//
// fprintf(stderr, "%s: %s\n", pdfioFileGetName(pdf), message);
//
// /* Return true to continue on warning messages, false otherwise... */
// return (!strncmp(message, "WARNING:", 8));
// }
// ```
//
// > Note: Error messages starting with "WARNING:" are actually warning
// > messages - the callback should normally return `true` to allow PDFio to