summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGregory Maxwell <greg@xiph.org>2009-11-29 05:28:32 +0000
committerGregory Maxwell <greg@xiph.org>2009-11-29 05:28:32 +0000
commit6baff18d8454e700d9f9980181f488aee9a7c439 (patch)
treee9a424082c7fa65680bf7c5045354253af4707a5 /doc
parentda91556dc84fa6e2a0497696f6c7a052a01cb4e7 (diff)
downloadogg-git-6baff18d8454e700d9f9980181f488aee9a7c439.tar.gz
ogg_stream_pageout.html: Comment on calling pageout in a loop based on feedback from Diablo-D3 in IRC
svn path=/trunk/ogg/; revision=16743
Diffstat (limited to 'doc')
-rw-r--r--doc/libogg/ogg_stream_pageout.html3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/libogg/ogg_stream_pageout.html b/doc/libogg/ogg_stream_pageout.html
index d916467..a3324be 100644
--- a/doc/libogg/ogg_stream_pageout.html
+++ b/doc/libogg/ogg_stream_pageout.html
@@ -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