Doxygenate init_put_bits().
authorStefano Sabatini <stefano.sabatini-lala@poste.it>
Fri, 10 Apr 2009 17:30:42 +0000 (17:30 +0000)
committerStefano Sabatini <stefano.sabatini-lala@poste.it>
Fri, 10 Apr 2009 17:30:42 +0000 (17:30 +0000)
Originally committed as revision 18423 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/bitstream.h

index 263fe9a..e586637 100644 (file)
@@ -89,6 +89,12 @@ typedef struct PutBitContext {
     int size_in_bits;
 } PutBitContext;
 
+/**
+ * Initializes the PutBitContext \p s.
+ *
+ * @param buffer the buffer where to put bits
+ * @param buffer_size the size in bytes of \p buffer
+ */
 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
 {
     if(buffer_size < 0) {