Document ff_put_string().

git-svn-id: file:///var/local/repositories/ffmpeg/trunk@18447 9553f0bf-9b14-0410-a0b8-cfaf0461ba5b

diff --git a/libavcodec/bitstream.h b/libavcodec/bitstream.h
index 519c1884efe6118a63b193fe1b0a96603b0ad93e..a20efc710af26933703eb30d4a747d7ceaf9e075 100644 (file)
--- a/libavcodec/bitstream.h
+++ b/libavcodec/bitstream.h
@@ -159,6 +159,12 @@ static inline void flush_put_bits(PutBitContext *s)
  * 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);
 
 /**