[xiph-commits] r14838 - trunk/vorbis/doc/vorbisfile

[giles at svn.xiph.org]

Author: giles
Date: 2008-05-05 20:04:19 -0700 (Mon, 05 May 2008)
New Revision: 14838

Modified:
   trunk/vorbis/doc/vorbisfile/ov_read.html
   trunk/vorbis/doc/vorbisfile/ov_read_float.html
Log:
Document that the ov_read functions can return OV_EINVAL if the
stream didn't open properly.


Modified: trunk/vorbis/doc/vorbisfile/ov_read.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_read.html	2008-05-05 11:32:41 UTC (rev 14837)
+++ trunk/vorbis/doc/vorbisfile/ov_read.html	2008-05-06 03:04:19 UTC (rev 14838)
@@ -84,6 +84,10 @@
 <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>

Modified: trunk/vorbis/doc/vorbisfile/ov_read_float.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_read_float.html	2008-05-05 11:32:41 UTC (rev 14837)
+++ trunk/vorbis/doc/vorbisfile/ov_read_float.html	2008-05-06 03:04:19 UTC (rev 14838)
@@ -60,6 +60,10 @@
 <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>