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

[conrad at svn.annodex.net]

Author: conrad
Date: 2007-06-13 16:49:03 -0700 (Wed, 13 Jun 2007)
New Revision: 2913

Modified:
   liboggz/trunk/include/oggz/oggz_comments.h
Log:
fix documentation of comment editing functions to specify mode OGGZ_WRITE
not OGGZ_ENCODE (thanks OceanSpray for noticing)


Modified: liboggz/trunk/include/oggz/oggz_comments.h
===================================================================
--- liboggz/trunk/include/oggz/oggz_comments.h	2007-06-13 05:55:04 UTC (rev 2912)
+++ liboggz/trunk/include/oggz/oggz_comments.h	2007-06-13 23:49:03 UTC (rev 2913)
@@ -184,7 +184,7 @@
 
 /**
  * Add a comment
- * \param oggz A OGGZ* handle (created with mode OGGZ_ENCODE)
+ * \param oggz A OGGZ* handle (created with mode OGGZ_WRITE)
  * \param serialno Identify a logical bitstream within \a oggz
  * \param comment The comment to add
  * \retval 0 Success
@@ -196,7 +196,7 @@
 
 /**
  * Add a comment by name and value.
- * \param oggz A OGGZ* handle (created with mode OGGZ_ENCODE)
+ * \param oggz A OGGZ* handle (created with mode OGGZ_WRITE)
  * \param serialno Identify a logical bitstream within \a oggz
  * \param name The name of the comment to add
  * \param value The contents of the comment to add
@@ -210,7 +210,7 @@
 
 /**
  * Remove a comment
- * \param oggz A OGGZ* handle (created with OGGZ_ENCODE)
+ * \param oggz A OGGZ* handle (created with OGGZ_WRITE)
  * \param serialno Identify a logical bitstream within \a oggz
  * \param comment The comment to remove.
  * \retval 1 Success: comment removed
@@ -225,7 +225,7 @@
 
 /**
  * Remove all comments with a given name.
- * \param oggz A OGGZ* handle (created with OGGZ_ENCODE)
+ * \param oggz A OGGZ* handle (created with OGGZ_WRITE)
  * \param serialno Identify a logical bitstream within \a oggz
  * \param name The name of the comments to remove
  * \retval ">= 0" The number of comments removed
@@ -239,7 +239,7 @@
 
 /**
  * Output a comment packet for the specified stream
- * \param oggz A OGGZ* handle (created with OGGZ_ENCODE)
+ * \param oggz A OGGZ* handle (created with OGGZ_WRITE)
  * \param serialno Identify a logical bitstream within \a oggz
  * \param packet_type Type of comment packet to generate,
  * FLAC, OggPCM, Speex, Theora and Vorbis are supported