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

[stefano]

Author: stefano
Date: Fri Apr 10 19:30:42 2009
New Revision: 18423

Log:
Doxygenate init_put_bits().

Modified:
   trunk/libavcodec/bitstream.h

Modified: trunk/libavcodec/bitstream.h
==============================================================================
--- trunk/libavcodec/bitstream.h	Fri Apr 10 19:23:38 2009	(r18422)
+++ trunk/libavcodec/bitstream.h	Fri Apr 10 19:30:42 2009	(r18423)
@@ -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) {