From 47b6e010af41a8dc2cc025e5c3a7750532bbdc63 Mon Sep 17 00:00:00 2001
From: Ralph Giles <giles@xiph.org>
Date: Thu, 14 Feb 2008 02:03:39 +0000
Subject: Document what oggpack_bytes() returns for read-initialized streams.

git-svn-id: http://svn.xiph.org/trunk/ogg@14505 0101bb08-14d6-0310-b084-bc0e0c8e3800
---
 doc/libogg/oggpack_bytes.html | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

(limited to 'doc')

diff --git a/doc/libogg/oggpack_bytes.html b/doc/libogg/oggpack_bytes.html
index 60ca762..5078f8e 100644
--- a/doc/libogg/oggpack_bytes.html
+++ b/doc/libogg/oggpack_bytes.html
@@ -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 @@ long oggpack_bytes(<a href="oggpack_buffer.html">oggpack_buffer</a> *b);
 <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>
 
-- 
cgit v1.2.1