aboutsummaryrefslogtreecommitdiffstats
path: root/serd
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2018-06-16 10:25:08 -0400
committerDavid Robillard <d@drobilla.net>2019-12-19 20:55:26 -0500
commit13eb1a4deb05c902edd4f4b7f631abb208052dd1 (patch)
tree7f8524b8d8daaa02fc0b65b2de783b59037ab15d /serd
parentc566f7ca434f28f68959c6c345babd07aa12e716 (diff)
downloadserd-13eb1a4deb05c902edd4f4b7f631abb208052dd1.tar.gz
serd-13eb1a4deb05c902edd4f4b7f631abb208052dd1.tar.bz2
serd-13eb1a4deb05c902edd4f4b7f631abb208052dd1.zip
Automatically finish reader on destruction
Diffstat (limited to 'serd')
-rw-r--r--serd/serd.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/serd/serd.h b/serd/serd.h
index 687d6398..bca6c857 100644
--- a/serd/serd.h
+++ b/serd/serd.h
@@ -1175,6 +1175,9 @@ serd_reader_read_document(SerdReader* reader);
/**
Finish reading from the source.
+
+ This will close the open file, if applicable, and ensure the reader has
+ processed all input.
*/
SERD_API
SerdStatus
@@ -1182,6 +1185,8 @@ serd_reader_finish(SerdReader* reader);
/**
Free `reader`.
+
+ The reader will be finished via `serd_reader_finish()` if necessary.
*/
SERD_API
void