Doxygenate init_put_bits().

[frescor/ffmpeg.git] / libavcodec / bitstream.h

diff --git a/libavcodec/bitstream.h b/libavcodec/bitstream.h
index 263fe9aa5a869db79decb916ed038cf5d9b0d835..e586637e9d265bd306281da976355598a90d3061 100644 (file)
--- a/libavcodec/bitstream.h
+++ b/libavcodec/bitstream.h
@@ -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) {