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>2018-12-31 11:37:48 -0500
commit901626455b80f63b6e0dc4ca45ac0a0319364c77 (patch)
treee44b30617a9b09b4d76ff7b8f6b4b29d0d1556a5 /serd/serd.h
parentdadf08057acf8a43b878b0448ce9019efbdf0309 (diff)
downloadserd-901626455b80f63b6e0dc4ca45ac0a0319364c77.tar.gz
serd-901626455b80f63b6e0dc4ca45ac0a0319364c77.tar.bz2
serd-901626455b80f63b6e0dc4ca45ac0a0319364c77.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 e4631dd4..a2645343 100644
--- a/serd/serd.h
+++ b/serd/serd.h
@@ -1134,6 +1134,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
@@ -1141,6 +1144,8 @@ serd_reader_finish(SerdReader* reader);
/**
Free `reader`.
+
+ The reader will be finished via `serd_reader_finish()` if necessary.
*/
SERD_API
void