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

[xiphmont at svn.xiph.org]

Author: xiphmont
Date: 2007-06-18 14:11:34 -0700 (Mon, 18 Jun 2007)
New Revision: 13140

Modified:
   trunk/ogg/doc/libogg/ogg_sync_state.html
   trunk/ogg/doc/libogg/oggpack_writetrunc.html
   trunk/ogg/doc/libogg/reference.html
Log:
Correction to longstanding errors/omissions in libogg documentation.



Modified: trunk/ogg/doc/libogg/ogg_sync_state.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_sync_state.html	2007-06-18 19:18:23 UTC (rev 13139)
+++ trunk/ogg/doc/libogg/ogg_sync_state.html	2007-06-18 21:11:34 UTC (rev 13140)
@@ -19,7 +19,7 @@
 
 <p>
 The ogg_sync_state struct tracks the synchronization of the current page.
-<p>It is used during decoding to track the status of data as it is read in and 
+<p>It is used during decoding to track the status of data as it is read in, synchronized, verified, and parsed into pages belonging to the various logical bistreams in the current physical bitstream link. 
 <p>
 
 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
@@ -44,9 +44,19 @@
 <h3>Relevant Struct Members</h3>
 <dl>
 <dt><i>data</i></dt>
-<dd>Pointer to data from packet bodies.</dd>
+<dd>Pointer to buffered stream data.</dd>
 <dt><i>storage</i></dt>
-<dd>Pointer to data from packet bodies.</dd>
+<dd>Current allocated size of the stream buffer held in <tt>*data</tt>.</dd>
+<dt><i>fill</i></dt>
+<dd>The number of valid bytes currently held in <tt>*data</tt>; functions as the buffer head pointer.</dd>
+<dt><i>returned</i></dt>
+<dd>The number of bytes at the head of <tt>*data</tt> that have already been returned as pages; functions as the buffer tail pointer.</dd>
+<dt><i>unsynced</i></dt>
+<dd>Synchronization state flag; nonzero if sync has not yet been attained or has been lost.</dd>
+<dt><i>headerbytes</i></dt>
+<dd>If synced, the number of bytes used by the synced page's header.</dd>
+<dt><i>bodybytes</i></dt>
+<dd>If synced, the number of bytes used by the synced page's body.</dd>
 </dl>
 
 

Modified: trunk/ogg/doc/libogg/oggpack_writetrunc.html
===================================================================
--- trunk/ogg/doc/libogg/oggpack_writetrunc.html	2007-06-18 19:18:23 UTC (rev 13139)
+++ trunk/ogg/doc/libogg/oggpack_writetrunc.html	2007-06-18 21:11:34 UTC (rev 13140)
@@ -13,7 +13,7 @@
 </tr>
 </table>
 
-<h1>oggpack_write</h1>
+<h1>oggpack_writetrunc</h1>
 
 <p><i>declared in "ogg/ogg.h";</i></p>
 

Modified: trunk/ogg/doc/libogg/reference.html
===================================================================
--- trunk/ogg/doc/libogg/reference.html	2007-06-18 19:18:23 UTC (rev 13139)
+++ trunk/ogg/doc/libogg/reference.html	2007-06-18 21:11:34 UTC (rev 13140)
@@ -26,9 +26,9 @@
 <b>Bitpacking</b><br>
 <a href="oggpack_writeinit.html">oggpack_writeinit()</a><br>
 <a href="oggpack_reset.html">oggpack_reset()</a><br>
-<a href="oggpack_writeclear.html">oggpack_writetrunc()</a><br>
-<a href="oggpack_writeclear.html">oggpack_writealign()</a><br>
-<a href="oggpack_writeclear.html">oggpack_writecopy()</a><br>
+<a href="oggpack_writetrunc.html">oggpack_writetrunc()</a><br>
+<a href="oggpack_writealign.html">oggpack_writealign()</a><br>
+<a href="oggpack_writecopy.html">oggpack_writecopy()</a><br>
 <a href="oggpack_writeclear.html">oggpack_writeclear()</a><br>
 <a href="oggpack_readinit.html">oggpack_readinit()</a><br>
 <a href="oggpack_write.html">oggpack_write()</a><br>