summaryrefslogtreecommitdiff
path: root/src/framing.c
diff options
context:
space:
mode:
authorRalph Giles <giles@xiph.org>2002-09-29 07:10:37 +0000
committerRalph Giles <giles@xiph.org>2002-09-29 07:10:37 +0000
commite1fe1cacb3ff8d9cd9ce7310ac9bf971121532df (patch)
tree1614578dc37ef5eb701996380aa9dcd35b092c77 /src/framing.c
parent73ec1d6aef0516be807c4e27c5c0afa53289829f (diff)
downloadogg-git-e1fe1cacb3ff8d9cd9ce7310ac9bf971121532df.tar.gz
fix documentation errors. thanks to David K. Gasaway for pointing out the problem.
svn path=/trunk/ogg/; revision=3964
Diffstat (limited to 'src/framing.c')
-rw-r--r--src/framing.c12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/framing.c b/src/framing.c
index f08d295..655d99e 100644
--- a/src/framing.c
+++ b/src/framing.c
@@ -12,7 +12,7 @@
function: code raw [Vorbis] packets into framed OggSquish stream and
decode Ogg streams back into raw packets
- last mod: $Id: framing.c,v 1.22 2002/07/11 09:09:08 xiphmont Exp $
+ last mod: $Id: framing.c,v 1.23 2002/09/29 07:10:37 giles Exp $
note: The CRC code is directly derived from public domain code by
Ross Williams (ross@guest.adelaide.edu.au). See docs/framing.html
@@ -321,14 +321,14 @@ int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op){
(undersized page). If there are no packets or partial packets to
flush, ogg_stream_flush returns 0. Note that ogg_stream_flush will
try to flush a normal sized page like ogg_stream_pageout; a call to
- ogg_stream_flush does not gurantee that all packets have flushed.
+ ogg_stream_flush does not guarantee that all packets have flushed.
Only a return value of 0 from ogg_stream_flush indicates all packet
data is flushed into pages.
- ogg_stream_page will flush the last page in a stream even if it's
- undersized; you almost certainly want to use ogg_stream_pageout
- (and *not* ogg_stream_flush) unless you need to flush an undersized
- page in the middle of a stream for some reason. */
+ since ogg_stream_flush will flush the last page in a stream even if
+ it's undersized, you almost certainly want to use ogg_stream_pageout
+ (and *not* ogg_stream_flush) unless you specifically need to flush
+ an page regardless of size in the middle of a stream. */
int ogg_stream_flush(ogg_stream_state *os,ogg_page *og){
int i;