[xiph-commits] r3463 - liboggz/trunk/include/oggz

conrad at svn.annodex.net conrad at svn.annodex.net
Fri Feb 15 00:00:34 PST 2008


Author: conrad
Date: 2008-02-15 00:00:33 -0800 (Fri, 15 Feb 2008)
New Revision: 3463

Modified:
   liboggz/trunk/include/oggz/oggz_read.h
   liboggz/trunk/include/oggz/oggz_seek.h
   liboggz/trunk/include/oggz/oggz_write.h
Log:
Correct capitalization of Oggz when referring to the library generally,
in Doxygen docs


Modified: liboggz/trunk/include/oggz/oggz_read.h
===================================================================
--- liboggz/trunk/include/oggz/oggz_read.h	2008-02-15 07:48:30 UTC (rev 3462)
+++ liboggz/trunk/include/oggz/oggz_read.h	2008-02-15 08:00:33 UTC (rev 3463)
@@ -37,18 +37,18 @@
  * Interfaces for reading Ogg files and streams
  */
 
-/** \defgroup read_api OGGZ Read API
+/** \defgroup read_api Oggz Read API
  *
- * OGGZ parses Ogg bitstreams, forming ogg_packet structures, and calling
+ * Oggz parses Ogg bitstreams, forming ogg_packet structures, and calling
  * your OggzReadPacket callback(s).
  *
- * You provide Ogg data to OGGZ with oggz_read() or oggz_read_input(), and
+ * You provide Ogg data to Oggz with oggz_read() or oggz_read_input(), and
  * independently process it in OggzReadPacket callbacks.
  * It is possible to set a different callback per \a serialno (ie. for each
  * logical bitstream in the Ogg bitstream - see the \ref basics section for
  * more detail).
  *
- * When using an OGGZ* opened with the OGGZ_AUTO flag set, OGGZ will
+ * When using an OGGZ* opened with the OGGZ_AUTO flag set, Oggz will
  * internally calculate the granulepos for each packet, even though these
  * are not all recorded in the file: only the last packet ending on a page
  * will have its granulepos recorded in the page header.
@@ -71,7 +71,7 @@
  * \param serialno Identify the logical bistream in \a oggz that contains
  *                 \a op
  * \param user_data A generic pointer you have provided earlier
- * \returns 0 to continue, non-zero to instruct OGGZ to stop.
+ * \returns 0 to continue, non-zero to instruct Oggz to stop.
  *
  * \note It is possible to provide different callbacks per logical
  * bitstream -- see oggz_set_read_callback() for more information.
@@ -113,7 +113,7 @@
  * \param oggz The OGGZ handle
  * \param op The full ogg_page (see <ogg/ogg.h>)
  * \param user_data A generic pointer you have provided earlier
- * \returns 0 to continue, non-zero to instruct OGGZ to stop.
+ * \returns 0 to continue, non-zero to instruct Oggz to stop.
  */
 typedef int (*OggzReadPage) (OGGZ * oggz, const ogg_page * og,
 			     long serialno, void * user_data);
@@ -178,7 +178,7 @@
  */
 
 /**
- * Erase any input buffered in OGGZ. This discards any input read from the
+ * Erase any input buffered in Oggz. This discards any input read from the
  * underlying IO system but not yet delivered as ogg_packets.
  *
  * \param oggz An OGGZ handle

Modified: liboggz/trunk/include/oggz/oggz_seek.h
===================================================================
--- liboggz/trunk/include/oggz/oggz_seek.h	2008-02-15 07:48:30 UTC (rev 3462)
+++ liboggz/trunk/include/oggz/oggz_seek.h	2008-02-15 08:00:33 UTC (rev 3463)
@@ -37,7 +37,7 @@
  * Seeking within files
  */
 
-/** \defgroup seek_api OGGZ Seek API
+/** \defgroup seek_api Oggz Seek API
  *
  * Oggz can seek on multitrack, multicodec bitstreams.
  *
@@ -125,7 +125,7 @@
  * \note When reading, the value returned by oggz_tell() reflects the
  * data offset of the start of the most recent packet processed, so that
  * when called from an OggzReadPacket callback it reflects the byte
- * offset of the start of the packet. As OGGZ may have internally read
+ * offset of the start of the packet. As Oggz may have internally read
  * ahead, this may differ from the current offset of the associated file
  * descriptor.
  */
@@ -176,7 +176,7 @@
  * \link basics Ogg Basics \endlink section).
  *
  * For data such as media, for which it is possible to provide a mapping
- * such as 'time', OGGZ can efficiently navigate through an Ogg stream
+ * such as 'time', Oggz can efficiently navigate through an Ogg stream
  * by use of an OggzMetric callback, thus allowing automatic seeking to
  * points in 'time'.
  *
@@ -318,7 +318,7 @@
  * This is the signature of a function to correlate Ogg streams.
  * If every position in an Ogg stream can be described by a metric (eg. time)
  * then define this function that returns some arbitrary unit value.
- * This is the normal use of OGGZ for media streams. The meaning of units is
+ * This is the normal use of Oggz for media streams. The meaning of units is
  * arbitrary, but must be consistent across all logical bitstreams; for
  * example a conversion of the time offset of a given packet into nanoseconds
  * or a similar stream-specific subdivision may be appropriate.
@@ -431,7 +431,7 @@
 #endif /* _UNIMPLEMENTED */
 
 /**
- * Tell OGGZ to remember the given offset as the start of data.
+ * Tell Oggz to remember the given offset as the start of data.
  * This informs the seeking mechanism that when seeking back to unit 0,
  * go to the given offset, not to the start of the file, which is usually
  * codec headers.

Modified: liboggz/trunk/include/oggz/oggz_write.h
===================================================================
--- liboggz/trunk/include/oggz/oggz_write.h	2008-02-15 07:48:30 UTC (rev 3462)
+++ liboggz/trunk/include/oggz/oggz_write.h	2008-02-15 08:00:33 UTC (rev 3463)
@@ -37,7 +37,7 @@
  * Interfaces for writing Ogg files and streams
  */
 
-/** \defgroup force_feed Writing by force feeding OGGZ
+/** \defgroup force_feed Writing by force feeding Oggz
  *
  * Force feeding involves synchronously:
  * - Creating an \a ogg_packet structure
@@ -48,7 +48,7 @@
  * This process is illustrated in the following diagram:
  *
  * \image html forcefeed.png
- * \image latex forcefeed.eps "Force Feeding OGGZ" width=10cm
+ * \image latex forcefeed.eps "Force Feeding Oggz" width=10cm
  *
  * The following example code generates a stream of ten packets, each
  * containing a single byte ('A', 'B', ... , 'J'):
@@ -58,7 +58,7 @@
 
 /** \defgroup hungry Writing with OggzHungry callbacks
  *
- * You can add packets to the OGGZ packet queue only when it is "hungry"
+ * You can add packets to the Oggz packet queue only when it is "hungry"
  * by providing an OggzHungry callback.
  *
  * An OggzHungry callback will:
@@ -66,7 +66,7 @@
  * - Add it to the packet queue with oggz_write_feed()
  *
  * Once you have set such a callback with oggz_write_set_hungry_callback(),
- * simply call oggz_write() or oggz_write_output() repeatedly, and OGGZ
+ * simply call oggz_write() or oggz_write_output() repeatedly, and Oggz
  * will call your callback to provide packets when it is hungry.
  *
  * This process is illustrated in the following diagram:
@@ -80,14 +80,14 @@
  * \include write-hungry.c
  */
 
-/** \defgroup write_api OGGZ Write API
+/** \defgroup write_api Oggz Write API
  *
- * OGGZ maintains a packet queue, such that you can independently add
+ * Oggz maintains a packet queue, such that you can independently add
  * packets to the queue and write an Ogg bitstream.
  * There are two complementary methods for adding packets to the
  * packet queue.
  *
- * - by \link force_feed force feeding OGGZ \endlink
+ * - by \link force_feed force feeding Oggz \endlink
  * - by using \link hungry OggzHungry \endlink callbacks
  *
  * As each packet is enqueued, its validity is checked against the framing
@@ -118,7 +118,7 @@
  *        empty. A value of 0 indicates that the packet queue is not empty.
  * \param user_data A generic pointer you have provided earlier
  * \retval 0 Continue
- * \retval non-zero Instruct OGGZ to stop.
+ * \retval non-zero Instruct Oggz to stop.
  */
 typedef int (*OggzWriteHungry) (OGGZ * oggz, int empty, void * user_data);
 
@@ -129,8 +129,8 @@
  * \param oggz An OGGZ handle previously opened for writing
  * \param hungry Your callback function
  * \param only_when_empty When to call: a value of 0 indicates that
- * OGGZ should call \a hungry() after each and every packet is written;
- * a value of 1 indicates that OGGZ should call \a hungry() only when
+ * Oggz should call \a hungry() after each and every packet is written;
+ * a value of 1 indicates that Oggz should call \a hungry() only when
  * its packet queue is empty
  * \param user_data Arbitrary data you wish to pass to your callback
  * \retval 0 Success



More information about the commits mailing list