[xiph-commits] r14505 - trunk/ogg/doc/libogg

[giles at svn.xiph.org]

Author: giles
Date: 2008-02-13 18:03:39 -0800 (Wed, 13 Feb 2008)
New Revision: 14505

Modified:
   trunk/ogg/doc/libogg/oggpack_bytes.html
Log:
Document what oggpack_bytes() returns for read-initialized streams.


Modified: trunk/ogg/doc/libogg/oggpack_bytes.html
===================================================================
--- trunk/ogg/doc/libogg/oggpack_bytes.html	2008-02-13 23:32:54 UTC (rev 14504)
+++ trunk/ogg/doc/libogg/oggpack_bytes.html	2008-02-14 02:03:39 UTC (rev 14505)
@@ -17,8 +17,13 @@
 
 <p><i>declared in "ogg/ogg.h";</i></p>
 
-<p>This function returns the total number of bytes currently in the <a href="oggpack_buffer.html">oggpack_buffer</a>'s internal buffer.
-<p>The return value is the number of <b>complete</b> bytes in the buffer.  There may be extra (<8) bits.
+<p>This function returns the total number of bytes behind the current 
+access point in the <a href="oggpack_buffer.html">oggpack_buffer</a>. 
+For write-initialized buffers, this is the number of complete bytes 
+written so far. For read-initialized buffers, it is the number of 
+complete bytes that have been read so far.
+<p>The return value is the number of <b>complete</b> bytes in the buffer.
+There may be extra (<8) bits.
 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
 <tr bgcolor=#cccccc>
@@ -48,11 +53,11 @@
 <hr noshade>
 <table border=0 width=100%>
 <tr valign=top>
-<td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
+<td><p class=tiny>copyright &copy; 2008 xiph.org</p></td>
 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
 </tr><tr>
 <td><p class=tiny>libogg documentation</p></td>
-<td align=right><p class=tiny>libogg release 1.0 - 20020719</p></td>
+<td align=right><p class=tiny>libogg release 1.1 - 20080113</p></td>
 </tr>
 </table>