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

[gmaxwell at svn.xiph.org]

Author: gmaxwell
Date: 2009-11-28 21:28:32 -0800 (Sat, 28 Nov 2009)
New Revision: 16743

Modified:
   trunk/ogg/doc/libogg/ogg_stream_pageout.html
Log:
ogg_stream_pageout.html: Comment on calling pageout in a loop based on feedback from Diablo-D3 in IRC

Modified: trunk/ogg/doc/libogg/ogg_stream_pageout.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_pageout.html	2009-11-28 22:04:25 UTC (rev 16742)
+++ trunk/ogg/doc/libogg/ogg_stream_pageout.html	2009-11-29 05:28:32 UTC (rev 16743)
@@ -23,7 +23,8 @@
 href="ogg_stream_packetin.html">ogg_stream_packetin()</a> to submit 
 data packets to the bitstream. Internally, this function assembles 
 the accumulated packet bodies into an Ogg page suitable for writing 
-to a stream.</p>
+to a stream. The function is typically called in a loop until there
+are no more pages ready for output.</p>
 
 <p>This function will only return a page when a "reasonable" amount of 
 packet data is available. Normally this is appropriate since it