summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Drake <tlsa@netsurf-browser.org>2022-03-03 19:05:32 +0000
committerMichael Drake <tlsa@netsurf-browser.org>2022-03-03 19:15:28 +0000
commit0d5b742134940c65baa937697b39b94cc22a4e74 (patch)
treed4581b96593167861bd06a16830844b4b35ad41d
parente1695e96b0ecc60327f8cb287517f6009eb8ddc8 (diff)
downloadlibnsgif-0d5b742134940c65baa937697b39b94cc22a4e74.tar.gz
libnsgif-0d5b742134940c65baa937697b39b94cc22a4e74.tar.bz2
API: Document nsgif_data_scan return code errors being non-fatal.
-rw-r--r--include/nsgif.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/nsgif.h b/include/nsgif.h
index a8f384c..c2a98c1 100644
--- a/include/nsgif.h
+++ b/include/nsgif.h
@@ -210,6 +210,9 @@ void nsgif_destroy(nsgif_t *gif);
*
* If an error occurs, all previously scanned frames are retained.
*
+ * Note that an error returned from this function is purely informational.
+ * So long as at least one frame is available, you can display frames.
+ *
* \param[in] gif The \ref nsgif_t object.
* \param[in] size Number of bytes in data.
* \param[in] data Raw source GIF data.