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

[oggk at svn.xiph.org]

Author: oggk
Date: 2009-04-04 08:22:40 -0700 (Sat, 04 Apr 2009)
New Revision: 15906

Modified:
   trunk/ogg/doc/libogg/ogg_stream_packetout.html
Log:
fix implication that op is updated when -1 is returned.



Modified: trunk/ogg/doc/libogg/ogg_stream_packetout.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_packetout.html	2009-04-04 06:42:22 UTC (rev 15905)
+++ trunk/ogg/doc/libogg/ogg_stream_packetout.html	2009-04-04 15:22:40 UTC (rev 15906)
@@ -60,7 +60,7 @@
 <h3>Return Values</h3>
 <blockquote>
 <ul>
-<li>-1 if we are out of sync and there is a gap in the data. Usually this will not be a fatal error. <i>op</i> contains a the first packet decodable after the hole.</li>
+<li>-1 if we are out of sync and there is a gap in the data. Usually this will not be a fatal error and subsequent calls to ogg_stream_packetout are likely to succeed. <i>op</i> has not been updated.</li>
 <li>0 if there is insufficient data available to complete a packet. <i>op</i> has not been updated.
 <li>1 if a packet was assembled normally. <i>op</i> contains the next packet from the stream.</li>
 </ul>