aboutsummaryrefslogtreecommitdiffstats
path: root/serd/serd.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2018-06-16 10:25:08 -0400
committerDavid Robillard <d@drobilla.net>2020-06-21 18:12:04 +0200
commitd398b559d7487822e56d62cb2c0197b772e9b35b (patch)
tree5f3bbc5f0bd67fa29091ccd9104e4b7f5bc7c2e8 /serd/serd.h
parent3cd7fc8423cb5bcc061183b3fa6512ff136a8bdf (diff)
downloadserd-d398b559d7487822e56d62cb2c0197b772e9b35b.tar.gz
serd-d398b559d7487822e56d62cb2c0197b772e9b35b.tar.bz2
serd-d398b559d7487822e56d62cb2c0197b772e9b35b.zip
Automatically finish reader on destruction
Diffstat (limited to 'serd/serd.h')
-rw-r--r--serd/serd.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/serd/serd.h b/serd/serd.h
index 7ad4d36b..7571c82b 100644
--- a/serd/serd.h
+++ b/serd/serd.h
@@ -1169,6 +1169,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
@@ -1176,6 +1179,8 @@ serd_reader_finish(SerdReader* reader);
/**
Free `reader`.
+
+ The reader will be finished via `serd_reader_finish()` if necessary.
*/
SERD_API
void