Document that the ov_read functions can return OV_EINVAL if the

stream didn't open properly.

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

diff --git a/doc/vorbisfile/ov_read.html b/doc/vorbisfile/ov_read.html
index 4e92354..08aab81 100644 (file)
--- a/doc/vorbisfile/ov_read.html
+++ b/doc/vorbisfile/ov_read.html
@@ -84,6 +84,10 @@ ig endian.  Typical value is 0.</dd>
 <dt>OV_EBADLINK</dt>
   <dd>indicates that an invalid stream section was supplied to
       libvorbisfile, or the requested link is corrupt.</dd>
+<dt>OV_EINVAL</dt>
+  <dd>indicates the initial file headers couldn't be read or 
+      are corrupt, or that the initial open call for <i>vf</i> 
+      failed.</dd>
 <dt>0</dt>
   <dd>indicates EOF</dd>
 <dt><i>n</i></dt>

diff --git a/doc/vorbisfile/ov_read_float.html b/doc/vorbisfile/ov_read_float.html
index 2a9c9f1..2462151 100644 (file)
--- a/doc/vorbisfile/ov_read_float.html
+++ b/doc/vorbisfile/ov_read_float.html
@@ -60,6 +60,10 @@ functions.</dd>
 <dt>OV_EBADLINK</dt>
   <dd>indicates that an invalid stream section was supplied to
       libvorbisfile, or the requested link is corrupt.</dd>
+<dt>OV_EINVAL</dt>
+  <dd>indicates the initial file headers couldn't be read or
+      are corrupt, or that the initial open call for <i>vf</i> 
+      failed.</dd>
 <dt>0</dt>
   <dd>indicates EOF</dd>
 <dt><i>n</i></dt>