Update pdfioStreamGetToken documentation (Issue #37)

This commit is contained in:
Michael R Sweet 2023-01-11 17:13:58 -05:00
parent 2b8a1c8481
commit 57d5894f33
No known key found for this signature in database
GPG Key ID: 999559A027815955
2 changed files with 9 additions and 1 deletions

View File

@ -10,6 +10,7 @@ v1.1.0 (Month DD, YYYY)
- Added `pdfioContentPathEnd` function. - Added `pdfioContentPathEnd` function.
- Added protection against opening multiple streams in the same file at the - Added protection against opening multiple streams in the same file at the
same time. same time.
- Documentation updates (Issue #37)
- Fixed "install-shared" target (Issue #32) - Fixed "install-shared" target (Issue #32)
- Fixed `pdfioFileGet...` metadata APIs (Issue #33) - Fixed `pdfioFileGet...` metadata APIs (Issue #33)
- Fixed `pdfioContentMatrixRotate` function. - Fixed `pdfioContentMatrixRotate` function.

View File

@ -1,7 +1,7 @@
// //
// PDF stream functions for PDFio. // PDF stream functions for PDFio.
// //
// Copyright © 2021-2022 by Michael R Sweet. // Copyright © 2021-2023 by Michael R Sweet.
// //
// Licensed under Apache License v2.0. See the file "LICENSE" for more // Licensed under Apache License v2.0. See the file "LICENSE" for more
// information. // information.
@ -366,6 +366,13 @@ pdfioStreamConsume(pdfio_stream_t *st, // I - Stream
// //
// 'pdfioStreamGetToken()' - Read a single PDF token from a stream. // 'pdfioStreamGetToken()' - Read a single PDF token from a stream.
// //
// This function reads a single PDF token from a stream. Operator tokens,
// boolean values, and numbers are returned as-is in the provided string buffer.
// String values start with the opening parenthesis ('(') but have all escaping
// resolved and the terminating parenthesis removed. Hexadecimal string values
// start with the opening angle bracket ('<') and have all whitespace and the
// terminating angle bracket removed.
//
bool // O - `true` on success, `false` on EOF bool // O - `true` on success, `false` on EOF
pdfioStreamGetToken( pdfioStreamGetToken(