aboutsummaryrefslogtreecommitdiffstats
path: root/libparsepsf.h
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2022-07-17 17:00:37 +0200
committerMattias Andrée <maandree@kth.se>2022-07-17 17:00:37 +0200
commitb78c7cfc38f81c11d59b1e891709d4935f91f09a (patch)
tree87d2c767a7b41aa1fd8bc5b7df1e46dbf0527192 /libparsepsf.h
parentFix support for unimap-free fonts (diff)
downloadlibparsepsf-b78c7cfc38f81c11d59b1e891709d4935f91f09a.tar.gz
libparsepsf-b78c7cfc38f81c11d59b1e891709d4935f91f09a.tar.bz2
libparsepsf-b78c7cfc38f81c11d59b1e891709d4935f91f09a.tar.xz
Clearify that output parameters are not updated if no glyph is found
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libparsepsf.h')
-rw-r--r--libparsepsf.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/libparsepsf.h b/libparsepsf.h
index d13c062..5a0b219 100644
--- a/libparsepsf.h
+++ b/libparsepsf.h
@@ -115,7 +115,8 @@ int libparsepsf_parse_font(const void *data, size_t size, struct libparsepsf_fon
* @return The index of the glyph, plus 1; 0 if the glyph if the
* end of the text is reached or if no glyph is found,
* or (only if `font->map` is `NULL`) if an illegal byte
- * sequence was found
+ * sequence was found. `*remp` and `*next_cp` are not
+ * updated if this function returns 0.
* @throws EILSEQ If an illegal byte sequence was found (only if
* `font->map` is `NULL`)
*/