Update documentation of get_bit()'s buffer parameter.
authorAndre Noll <maan@systemlinux.org>
Sun, 18 Oct 2009 21:00:40 +0000 (23:00 +0200)
committerAndre Noll <maan@systemlinux.org>
Wed, 18 Nov 2009 18:34:24 +0000 (19:34 +0100)
bitstream.h

index 4603884..0999414 100644 (file)
@@ -63,9 +63,9 @@ static inline unsigned int get_bit(struct getbit_context *gbc)
 /**
  * Initialize a getbit_context structure.
  *
- * \param buffer The bitstream buffer. It must be FF_INPUT_BUFFER_PADDING_SIZE
- * bytes larger then the actual read bits * because some optimized bitstream
- * readers read 32 or 64 bit at once and could read over the end.
+ * \param buffer The bitstream buffer. It must be 4 bytes larger then the
+ * actual read bits because the bitstream reader might read 32 bits at once and
+ * could read over the end.
  *
  * \param bit_size The size of the buffer in bytes.
  */