summaryrefslogtreecommitdiff
path: root/src
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
commit104966e64e51f761ff524ecfc3ff6353bcd2ff1c (patch)
tree1614578dc37ef5eb701996380aa9dcd35b092c77 /src
parente352c105ab0da51773e58e980c1480099ef6eafa (diff)
downloadogg-104966e64e51f761ff524ecfc3ff6353bcd2ff1c.tar.gz
fix documentation errors. thanks to David K. Gasaway for pointing out the problem.
git-svn-id: http://svn.xiph.org/trunk/ogg@3964 0101bb08-14d6-0310-b084-bc0e0c8e3800
Diffstat (limited to 'src')
-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;