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

[msmith at motherfish-iii.xiph.org]

Author: msmith
Date: 2005-02-17 18:16:12 -0800 (Thu, 17 Feb 2005)
New Revision: 8944

Modified:
   trunk/vorbis/doc/vorbisfile/ov_open_callbacks.html
   trunk/vorbis/doc/vorbisfile/ov_pcm_total.html
   trunk/vorbis/doc/vorbisfile/ov_raw_total.html
   trunk/vorbis/doc/vorbisfile/ov_test_callbacks.html
   trunk/vorbis/doc/vorbisfile/ov_time_total.html
Log:
Fix up some documentation mistakes as pointed out in bugs #615 and #616


Modified: trunk/vorbis/doc/vorbisfile/ov_open_callbacks.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_open_callbacks.html	2005-02-18 01:54:09 UTC (rev 8943)
+++ trunk/vorbis/doc/vorbisfile/ov_open_callbacks.html	2005-02-18 02:16:12 UTC (rev 8944)
@@ -64,7 +64,7 @@
 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>
 
 

Modified: trunk/vorbis/doc/vorbisfile/ov_pcm_total.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_pcm_total.html	2005-02-18 01:54:09 UTC (rev 8943)
+++ trunk/vorbis/doc/vorbisfile/ov_pcm_total.html	2005-02-18 02:16:12 UTC (rev 8944)
@@ -45,7 +45,7 @@
 <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>
 

Modified: trunk/vorbis/doc/vorbisfile/ov_raw_total.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_raw_total.html	2005-02-18 01:54:09 UTC (rev 8943)
+++ trunk/vorbis/doc/vorbisfile/ov_raw_total.html	2005-02-18 02:16:12 UTC (rev 8944)
@@ -45,7 +45,7 @@
 <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>
 

Modified: trunk/vorbis/doc/vorbisfile/ov_test_callbacks.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_test_callbacks.html	2005-02-18 01:54:09 UTC (rev 8943)
+++ trunk/vorbis/doc/vorbisfile/ov_test_callbacks.html	2005-02-18 02:16:12 UTC (rev 8944)
@@ -52,7 +52,7 @@
 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>
 
 

Modified: trunk/vorbis/doc/vorbisfile/ov_time_total.html
===================================================================
--- trunk/vorbis/doc/vorbisfile/ov_time_total.html	2005-02-18 01:54:09 UTC (rev 8943)
+++ trunk/vorbis/doc/vorbisfile/ov_time_total.html	2005-02-18 02:16:12 UTC (rev 8944)
@@ -46,7 +46,7 @@
 <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>