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-11-25 22:12:47 +0100
commit42ebdc8f2c9f237f676065e1ee8357b8a82b9121 (patch)
tree7ef7728681c2688bc4a16343c1b9524d263c9317 /serd/serd.h
parentc452f0c1051186b920fdbf9a1ee2d5ad159ebb68 (diff)
downloadserd-42ebdc8f2c9f237f676065e1ee8357b8a82b9121.tar.gz
serd-42ebdc8f2c9f237f676065e1ee8357b8a82b9121.tar.bz2
serd-42ebdc8f2c9f237f676065e1ee8357b8a82b9121.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 d518aaba..4a1ccd0d 100644
--- a/serd/serd.h
+++ b/serd/serd.h
@@ -1137,6 +1137,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
@@ -1144,6 +1147,8 @@ serd_reader_finish(SerdReader* reader);
/**
Free `reader`.
+
+ The reader will be finished via `serd_reader_finish()` if necessary.
*/
SERD_API
void