From 4dd1eea406ba9180283c616bddf6741e2b5ee034 Mon Sep 17 00:00:00 2001 From: Monty Date: Mon, 18 Jun 2007 21:11:34 +0000 Subject: Correction to longstanding errors/omissions in libogg documentation. svn path=/trunk/ogg/; revision=13140 --- doc/libogg/ogg_sync_state.html | 16 +++++++++++++--- doc/libogg/oggpack_writetrunc.html | 2 +- doc/libogg/reference.html | 6 +++--- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/doc/libogg/ogg_sync_state.html b/doc/libogg/ogg_sync_state.html index 15a7e3c..c9e773c 100644 --- a/doc/libogg/ogg_sync_state.html +++ b/doc/libogg/ogg_sync_state.html @@ -19,7 +19,7 @@

The ogg_sync_state struct tracks the synchronization of the current page. -

It is used during decoding to track the status of data as it is read in and +

It is used during decoding to track the status of data as it is read in, synchronized, verified, and parsed into pages belonging to the various logical bistreams in the current physical bitstream link.

@@ -44,9 +44,19 @@ typedef struct {

Relevant Struct Members

data
-
Pointer to data from packet bodies.
+
Pointer to buffered stream data.
storage
-
Pointer to data from packet bodies.
+
Current allocated size of the stream buffer held in *data.
+
fill
+
The number of valid bytes currently held in *data; functions as the buffer head pointer.
+
returned
+
The number of bytes at the head of *data that have already been returned as pages; functions as the buffer tail pointer.
+
unsynced
+
Synchronization state flag; nonzero if sync has not yet been attained or has been lost.
+
headerbytes
+
If synced, the number of bytes used by the synced page's header.
+
bodybytes
+
If synced, the number of bytes used by the synced page's body.
diff --git a/doc/libogg/oggpack_writetrunc.html b/doc/libogg/oggpack_writetrunc.html index 7e8750c..e2af9a0 100644 --- a/doc/libogg/oggpack_writetrunc.html +++ b/doc/libogg/oggpack_writetrunc.html @@ -13,7 +13,7 @@
-

oggpack_write

+

oggpack_writetrunc

declared in "ogg/ogg.h";

diff --git a/doc/libogg/reference.html b/doc/libogg/reference.html index eddb2af..ca31072 100644 --- a/doc/libogg/reference.html +++ b/doc/libogg/reference.html @@ -26,9 +26,9 @@ Bitpacking
oggpack_writeinit()
oggpack_reset()
-oggpack_writetrunc()
-oggpack_writealign()
-oggpack_writecopy()
+oggpack_writetrunc()
+oggpack_writealign()
+oggpack_writecopy()
oggpack_writeclear()
oggpack_readinit()
oggpack_write()
-- cgit v1.2.1