[FFmpeg-cvslog] r18447 - trunk/libavcodec/bitstream.h

[stefano]

Author: stefano
Date: Sat Apr 11 23:01:30 2009
New Revision: 18447

Log:
Document ff_put_string().

Modified:
   trunk/libavcodec/bitstream.h

Modified: trunk/libavcodec/bitstream.h
==============================================================================
--- trunk/libavcodec/bitstream.h	Sat Apr 11 22:48:56 2009	(r18446)
+++ trunk/libavcodec/bitstream.h	Sat Apr 11 23:01:30 2009	(r18447)
@@ -159,6 +159,12 @@ static inline void flush_put_bits(PutBit
  * Pads the bitstream with zeros up to the next byte boundary.
  */
 void align_put_bits(PutBitContext *s);
+
+/**
+ * Puts the string \p s in the bitstream.
+ *
+ * @param terminate_string 0-terminates the written string if value is 1
+ */
 void ff_put_string(PutBitContext * pbc, const char *s, int terminate_string);
 
 /**