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

[tterribe at svn.xiph.org]

Author: tterribe
Date: 2013-05-06 10:44:36 -0700 (Mon, 06 May 2013)
New Revision: 18935

Modified:
   trunk/ogg/doc/libogg/ogg_stream_check.html
   trunk/ogg/doc/libogg/ogg_stream_flush.html
   trunk/ogg/doc/libogg/ogg_stream_pagein.html
   trunk/ogg/doc/libogg/ogg_sync_check.html
   trunk/ogg/doc/libogg/oggpack_writecheck.html
Log:
Minor documentation fixes.

Fixes some broken links that were pointing to the wrong place, and
 some formatting errors.


Modified: trunk/ogg/doc/libogg/ogg_stream_check.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_check.html	2013-05-06 17:42:50 UTC (rev 18934)
+++ trunk/ogg/doc/libogg/ogg_stream_check.html	2013-05-06 17:44:36 UTC (rev 18935)
@@ -19,7 +19,7 @@
 
 <p>This function is used to check the error or readiness condition of an <a href="ogg_stream_state.html">ogg_stream_state</a> structure.  
 <p>It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an
-internal error occur, the <a href="ogg_stream_state.html">ogg_stream_state</a>structure will be cleared (equivalent to a
+internal error occur, the <a href="ogg_stream_state.html">ogg_stream_state</a> structure will be cleared (equivalent to a
 call to
 <a href="ogg_stream_clear.html">ogg_stream_clear</a>) and subsequent calls
 using this <a href="ogg_stream_state.html">ogg_stream_state</a> will be

Modified: trunk/ogg/doc/libogg/ogg_stream_flush.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_flush.html	2013-05-06 17:42:50 UTC (rev 18934)
+++ trunk/ogg/doc/libogg/ogg_stream_flush.html	2013-05-06 17:44:36 UTC (rev 18935)
@@ -18,7 +18,7 @@
 <p><i>declared in "ogg/ogg.h";</i></p>
 
 <p>This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page.
-<p>This should only be used when you want to flush an undersized page from the middle of the stream.  Otherwise, <a href="ogg_stream_pageout.html">ogg_stream_pageout</a> or <a href="ogg_stream_pageout_fill.html">ogg_stream_pageout_fill</a>should always be used.
+<p>This should only be used when you want to flush an undersized page from the middle of the stream.  Otherwise, <a href="ogg_stream_pageout.html">ogg_stream_pageout</a> or <a href="ogg_stream_pageout_fill.html">ogg_stream_pageout_fill</a> should always be used.
 <p>This function can also be used to verify that all packets have been flushed.  If the return value is 0, all packets have been placed into a page. Like <a href="ogg_stream_pageout.html">ogg_stream_pageout</a>, it should generally be called in a loop until available packet data has been flushes, since even a single packet may span multiple pages.
 
 <br><br>

Modified: trunk/ogg/doc/libogg/ogg_stream_pagein.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_pagein.html	2013-05-06 17:42:50 UTC (rev 18934)
+++ trunk/ogg/doc/libogg/ogg_stream_pagein.html	2013-05-06 17:44:36 UTC (rev 18935)
@@ -35,7 +35,7 @@
 <h3>Parameters</h3>
 <dl>
 <dt><i>os</i></dt>
-<dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
+<dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct, which represents the current logical bitstream.</dd>
 <dt><i>og</i></dt>
 <dd>Pointer to a page of data.  The data inside this page is being submitted to the streaming layer in order to be allocated into packets.
 </dl>

Modified: trunk/ogg/doc/libogg/ogg_sync_check.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_sync_check.html	2013-05-06 17:42:50 UTC (rev 18934)
+++ trunk/ogg/doc/libogg/ogg_sync_check.html	2013-05-06 17:44:36 UTC (rev 18935)
@@ -19,7 +19,7 @@
 
 <p>This function is used to check the error or readiness condition of an <a href="ogg_sync_state.html">ogg_sync_state</a> structure.  
 <p>It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an
-internal error occur, the <a href="ogg_sync_state.html">ogg_sync_state</a>structure will be cleared (equivalent to a
+internal error occur, the <a href="ogg_sync_state.html">ogg_sync_state</a> structure will be cleared (equivalent to a
 call to
 <a href="ogg_sync_clear.html">ogg_sync_clear</a>) and subsequent calls
 using this <a href="ogg_sync_state.html">ogg_sync_state</a> will be

Modified: trunk/ogg/doc/libogg/oggpack_writecheck.html
===================================================================
--- trunk/ogg/doc/libogg/oggpack_writecheck.html	2013-05-06 17:42:50 UTC (rev 18934)
+++ trunk/ogg/doc/libogg/oggpack_writecheck.html	2013-05-06 17:44:36 UTC (rev 18935)
@@ -26,7 +26,7 @@
 'not ready'.  Subsequent attempts to write using the buffer will
 silently fail. This error state may be detected at any later time by
 using oggpack_writecheck().  It is safe but not necessary to
-call <a href="oggpack_clear.html">oggpack_clear()</a> on a buffer that
+call <a href="oggpack_writeclear.html">oggpack_writeclear()</a> on a buffer that
 has flagged an error and released its resources. 
 
 <p><em>Important note to developers: Although libogg checks the