Document ogg_sync_wrote() on the ogg_sync_wrote page instead of half of ogg_sync_destroy().

git-svn-id: http://svn.xiph.org/trunk/ogg@9283 0101bb08-14d6-0310-b084-bc0e0c8e3800

1 files changed, 13 insertions, 3 deletions

diff --git a/doc/ogg/ogg_sync_wrote.html b/doc/ogg/ogg_sync_wrote.html
index 2110526..06318ab 100644
--- a/doc/ogg/ogg_sync_wrote.html
+++ b/doc/ogg/ogg_sync_wrote.html
@@ -19,12 +19,20 @@
 
 <p>This function is used to tell the <a href="ogg_sync_state.html">ogg_sync_state</a> struct how many bytes we wrote into the buffer. 
 
-<br><br>
+<p>
+The general proceedure is to request a pointer into an internal 
+<a href="ogg_sync_state.html">ogg_sync_state</a> buffer by calling 
+<a href="ogg_sync_buffer.html">ogg_sync_buffer()</a>. The buffer
+is then filled up to the requested size with new input, and 
+ogg_sync_wrote() is called to advance the fill pointer by however
+much data was actually available.</p>
+
+<br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
 <tr bgcolor=#cccccc>
 	<td>
 <pre><b>
-int ogg_sync_destroy(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
+int ogg_sync_wrote(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, long bytes);
 </b></pre>
 	</td>
 </tr>
@@ -34,6 +42,8 @@ int ogg_sync_destroy(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
 <dl>
 <dt><i>oy</i></dt>
 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
+<dt><i>bytes</i></dt>
+<dd>Number of bytes of new data written.</dd>
 </dl>
 
 
@@ -43,7 +53,7 @@ int ogg_sync_destroy(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
 <li>
 0 in all other cases.</li>
 </blockquote>
-<p>
+
 
 <br><br>
 <hr noshade>