From 49329b82f16aa2856500dc772362401ca2f2a979 Mon Sep 17 00:00:00 2001 From: Tim Terriberry Date: Mon, 6 May 2013 17:44:36 +0000 Subject: Minor documentation fixes. Fixes some broken links that were pointing to the wrong place, and some formatting errors. git-svn-id: http://svn.xiph.org/trunk/ogg@18935 0101bb08-14d6-0310-b084-bc0e0c8e3800 --- doc/libogg/ogg_stream_check.html | 2 +- doc/libogg/ogg_stream_flush.html | 2 +- doc/libogg/ogg_stream_pagein.html | 2 +- doc/libogg/ogg_sync_check.html | 2 +- doc/libogg/oggpack_writecheck.html | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/libogg/ogg_stream_check.html b/doc/libogg/ogg_stream_check.html index 60bb552..556a484 100644 --- a/doc/libogg/ogg_stream_check.html +++ b/doc/libogg/ogg_stream_check.html @@ -19,7 +19,7 @@

This function is used to check the error or readiness condition of an ogg_stream_state structure.

It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an -internal error occur, the ogg_stream_statestructure will be cleared (equivalent to a +internal error occur, the ogg_stream_state structure will be cleared (equivalent to a call to ogg_stream_clear) and subsequent calls using this ogg_stream_state will be diff --git a/doc/libogg/ogg_stream_flush.html b/doc/libogg/ogg_stream_flush.html index 33b799c..2f5998d 100644 --- a/doc/libogg/ogg_stream_flush.html +++ b/doc/libogg/ogg_stream_flush.html @@ -18,7 +18,7 @@

declared in "ogg/ogg.h";

This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page. -

This should only be used when you want to flush an undersized page from the middle of the stream. Otherwise, ogg_stream_pageout or ogg_stream_pageout_fillshould always be used. +

This should only be used when you want to flush an undersized page from the middle of the stream. Otherwise, ogg_stream_pageout or ogg_stream_pageout_fill should always be used.

This function can also be used to verify that all packets have been flushed. If the return value is 0, all packets have been placed into a page. Like ogg_stream_pageout, it should generally be called in a loop until available packet data has been flushes, since even a single packet may span multiple pages.

diff --git a/doc/libogg/ogg_stream_pagein.html b/doc/libogg/ogg_stream_pagein.html index 2185961..703e297 100644 --- a/doc/libogg/ogg_stream_pagein.html +++ b/doc/libogg/ogg_stream_pagein.html @@ -35,7 +35,7 @@ int ogg_stream_pagein(ogg_stream_state *os,

Parameters

os
-
Pointer to a previously declared ogg_stream struct, which represents the current logical bitstream.
+
Pointer to a previously declared ogg_stream_state struct, which represents the current logical bitstream.
og
Pointer to a page of data. The data inside this page is being submitted to the streaming layer in order to be allocated into packets.
diff --git a/doc/libogg/ogg_sync_check.html b/doc/libogg/ogg_sync_check.html index 5c9dbad..0238a74 100644 --- a/doc/libogg/ogg_sync_check.html +++ b/doc/libogg/ogg_sync_check.html @@ -19,7 +19,7 @@

This function is used to check the error or readiness condition of an ogg_sync_state structure.

It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an -internal error occur, the ogg_sync_statestructure will be cleared (equivalent to a +internal error occur, the ogg_sync_state structure will be cleared (equivalent to a call to ogg_sync_clear) and subsequent calls using this ogg_sync_state will be diff --git a/doc/libogg/oggpack_writecheck.html b/doc/libogg/oggpack_writecheck.html index 8762f33..c7f5a21 100644 --- a/doc/libogg/oggpack_writecheck.html +++ b/doc/libogg/oggpack_writecheck.html @@ -26,7 +26,7 @@ its internal state and release any in-use memory, flagging itself as 'not ready'. Subsequent attempts to write using the buffer will silently fail. This error state may be detected at any later time by using oggpack_writecheck(). It is safe but not necessary to -call oggpack_clear() on a buffer that +call oggpack_writeclear() on a buffer that has flagged an error and released its resources.

Important note to developers: Although libogg checks the -- cgit v1.2.1