Slightly stronger wording to emphasize that ov_clear() closes the file so
authorStan Seibert <volsung@xiph.org>
Sat, 20 Sep 2003 14:48:02 +0000 (14:48 +0000)
committerStan Seibert <volsung@xiph.org>
Sat, 20 Sep 2003 14:48:02 +0000 (14:48 +0000)
you shouldn't do it later.

svn path=/trunk/vorbis/; revision=5364

doc/vorbisfile/ov_clear.html

index d5b048e7e232c9a7573ef5aca41e356216c825cd..805f73c736efefe63b78819c207273704b3c9492 100644 (file)
@@ -18,7 +18,7 @@
 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
 
 <p> After a bitstream has been opened using <a href="ov_open.html">ov_open()</a>/<a href="ov_open_callbacks.html">ov_open_callbacks()</a> and decoding is complete, the application must call <tt>ov_clear()</tt> to clear
-the decoder's buffers and close the file.<p>
+the decoder's buffers.  <tt>ov_clear()</tt> will also close the file.<p>
 
 <tt>ov_clear()</tt> must also be called after a successful call to <a href="ov_test.html">ov_test()</a> or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>.<p>