ov_read_float() was missing from this reference to vorbisfile functions, as

[platform/upstream/libvorbis.git] / doc / vorbisfile / ov_clear.html
diff --git a/doc/vorbisfile/ov_clear.html b/doc/vorbisfile/ov_clear.html

index 81eb0ea..805f73c 100644 (file)
--- a/doc/vorbisfile/ov_clear.html
+++ b/doc/vorbisfile/ov_clear.html
@@ -1,15 +1,15 @@
  <html>
  
  <head>
-<title>vorbisfile - function - ov_clear</title>
+<title>Vorbisfile - function - ov_clear</title>
  <link rel=stylesheet href="style.css" type="text/css">
  </head>
  
  <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
  <table border=0 width=100%>
  <tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
+<td><p class=tiny>Vorbisfile documentation</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
  </tr>
  </table>
  
@@ -17,8 +17,11 @@
  
  <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> and decoding is complete, you must call <tt>ov_clear()</tt> to clear
-the decoder's buffers and close the file for you.
+<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.  <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>
+
  <br><br>
  <table border=0 color=black cellspacing=0 cellpadding=7>
  <tr bgcolor=#cccccc>
@@ -33,15 +36,14 @@ int ov_clear(OggVorbis_File *vf);
  <h3>Parameters</h3>
  <dl>
  <dt><i>vf</i></dt>
-<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
+<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
  functions.  After <tt>ov_clear</tt> has been called, the structure is deallocated and can no longer be used.</dd>
  </dl>
  
  
  <h3>Return Values</h3>
  <blockquote>
-<li>
-0 for success</li>
+<li>0 for success</li>
  </blockquote>
  
  
@@ -49,15 +51,14 @@ functions.  After <tt>ov_clear</tt> has been called, the structure is deallocate
  <hr noshade>
  <table border=0 width=100%>
  <tr valign=top>
-<td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
+<td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  </tr><tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
+<td><p class=tiny>Vorbisfile documentation</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
  </tr>
  </table>
  
-
  </body>
  
  </html>