From 3008150070484419b3de18a69df8d061e1343416 Mon Sep 17 00:00:00 2001
From: oggk <oggk@xiph.org>
Date: Sat, 4 Apr 2009 15:22:40 +0000
Subject: fix implication that op is updated when -1 is returned.

git-svn-id: http://svn.xiph.org/trunk/ogg@15906 0101bb08-14d6-0310-b084-bc0e0c8e3800
---
 doc/libogg/ogg_stream_packetout.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/libogg/ogg_stream_packetout.html b/doc/libogg/ogg_stream_packetout.html
index ac91cc8..8563849 100644
--- a/doc/libogg/ogg_stream_packetout.html
+++ b/doc/libogg/ogg_stream_packetout.html
@@ -60,7 +60,7 @@ on this stream state.</dd>
 <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>
-- 
cgit v1.2.1