X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=bitstream.h;h=5d6be3be2693a84f8107504f4a086dfa578c817b;hp=46038842092121e8dc2c7be675f07d01408738e6;hb=ffb2eaa90429f6d5c3d369509efcdf91c5463dad;hpb=5a8158c86d30905b0684fdf4e74a9bb1d1ba767b

diff --git a/bitstream.h b/bitstream.h
index 46038842..5d6be3be 100644
--- a/bitstream.h
+++ b/bitstream.h
@@ -21,10 +21,16 @@ struct getbit_context {
 
 #define VLC_TYPE int16_t
 
+/** A variable length code table. */
 struct vlc {
+	/** Number of bits of the table. */
 	int bits;
-	VLC_TYPE(*table)[2];	///< code, bits
-	int table_size, table_allocated;
+	/** The code and the bits table. */
+	VLC_TYPE(*table)[2];
+	/** The size of the table. */
+	int table_size;
+	/** Amount of memory allocated so far. */
+	int table_allocated;
 };
 
 static inline uint32_t show_bits(struct getbit_context *gbc, int num)
@@ -63,9 +69,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.
  */