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

[conrad at svn.annodex.net]

Author: conrad
Date: 2008-11-06 01:49:50 -0800 (Thu, 06 Nov 2008)
New Revision: 3772

Modified:
   liboggz/trunk/include/oggz/oggz_constants.h
Log:
oggz_constants.h: document use of OGGZ_PREFIX and OGGZ_SUFFIX


Modified: liboggz/trunk/include/oggz/oggz_constants.h
===================================================================
--- liboggz/trunk/include/oggz/oggz_constants.h	2008-11-06 09:48:37 UTC (rev 3771)
+++ liboggz/trunk/include/oggz/oggz_constants.h	2008-11-06 09:49:50 UTC (rev 3772)
@@ -41,7 +41,7 @@
  * Flags to oggz_new(), oggz_open(), and oggz_openfd().
  * Can be or'ed together in the following combinations:
  * - OGGZ_READ | OGGZ_AUTO
- * - OGGZ_WRITE | OGGZ_NONSTRICT
+ * - OGGZ_WRITE | OGGZ_NONSTRICT | OGGZ_PREFIX | OGGZ_SUFFIX
  */
 enum OggzFlags {
   /** Read only */
@@ -63,12 +63,16 @@
   OGGZ_AUTO         = 0x20,
 
   /**
-   * Prefix
+   * Write Prefix: Assume that we are only writing the prefix of an
+   * Ogg stream, ie. disable checking for conformance with end-of-stream
+   * constraints.
    */
   OGGZ_PREFIX       = 0x40,
 
   /**
-   * Suffix
+   * Write Suffix: Assume that we are only writing the suffix of an
+   * Ogg stream, ie. disable checking for conformance with
+   * beginning-of-stream constraints.
    */
   OGGZ_SUFFIX       = 0x80