From d502f7a751160224ab0a0632ff972c49f6acf54a Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 20 Dec 2009 16:23:56 +0100 Subject: [PATCH] Add documentation of struct vlc. --- bitstream.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/bitstream.h b/bitstream.h index 09994142..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) -- 2.39.2