Fix up some documentation mistakes as pointed out in bugs #615 and #616
authorMike Smith <msmith@xiph.org>
Fri, 18 Feb 2005 02:16:12 +0000 (02:16 +0000)
committerMike Smith <msmith@xiph.org>
Fri, 18 Feb 2005 02:16:12 +0000 (02:16 +0000)
svn path=/trunk/vorbis/; revision=8944

doc/vorbisfile/ov_open_callbacks.html
doc/vorbisfile/ov_pcm_total.html
doc/vorbisfile/ov_raw_total.html
doc/vorbisfile/ov_test_callbacks.html
doc/vorbisfile/ov_time_total.html

index a823f2e..485839f 100644 (file)
@@ -64,7 +64,7 @@ should be a pointer to a buffer containing the data read.</dd>
 read from the file and the stream is not seekable. In this case, <tt>ibytes</tt>
 should contain the length (in bytes) of the buffer.  Used together with <tt>initial</tt>.</dd>
 <dt><i>callbacks</i></dt>
-<dd>Pointer to a completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
+<dd>A completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
 </dl>
 
 
index 02e35ca..ce8fb1b 100644 (file)
@@ -45,7 +45,7 @@ functions.</dd>
 <li>OV_EINVAL means that the argument was invalid.  In this case, the requested bitstream did not exist or the bitstream is unseekable.</li>
 <li>
 total length in pcm samples of content if i=-1.</li>
-<li>length in pcm samples of logical bitstream if i=1 to n.</li>
+<li>length in pcm samples of logical bitstream if i=0 to n.</li>
 </blockquote>
 <p>
 
index dfb9f97..a6c71c7 100644 (file)
@@ -45,7 +45,7 @@ functions.</dd>
 <li>OV_EINVAL means that the argument was invalid.  In this case, the requested bitstream did not exist or the bitstream is nonseekable</li>
 <li><tt>n</tt>
 total length in compressed bytes of content if i=-1.</li>
-<li><tt>n</tt> length in compressed bytes of logical bitstream if i=1 to n.</li>
+<li><tt>n</tt> length in compressed bytes of logical bitstream if i=0 to n.</li>
 </blockquote>
 <p>
 
index edf798b..160b251 100644 (file)
@@ -52,7 +52,7 @@ should be a pointer to a buffer containing the data read.</dd>
 read from the file and the stream is not seekable. In this case, <tt>ibytes</tt>
 should contain the length (in bytes) of the buffer.  Used together with <tt>initial</tt>.</dd>
 <dt><i>callbacks</i></dt>
-<dd>Pointer to a completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
+<dd>A completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
 </dl>
 
 
index a0dcae1..a06f4c5 100644 (file)
@@ -46,7 +46,7 @@ functions.</dd>
 <blockquote>
 <li>OV_EINVAL means that the argument was invalid.  In this case, the requested bitstream did not exist or the bitstream is nonseekable.</li>
 <li><tt>n</tt> total length in seconds of content if i=-1.</li>
-<li><tt>n</tt> length in seconds of logical bitstream if i=1 to n.</li>
+<li><tt>n</tt> length in seconds of logical bitstream if i=0 to n.</li>
 </blockquote>
 <p>