From: Andre Noll <maan@systemlinux.org>
Date: Sun, 18 Oct 2009 21:00:40 +0000 (+0200)
Subject: Update documentation of get_bit()'s buffer parameter.
X-Git-Tag: v0.4.1~54
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=bc038d18139ca595b5ff968f1f621158a792a594

Update documentation of get_bit()'s buffer parameter.
---

diff --git a/bitstream.h b/bitstream.h
index 46038842..09994142 100644
--- a/bitstream.h
+++ b/bitstream.h
@@ -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.
  */