Add documentation of struct vlc.
authorAndre Noll <maan@systemlinux.org>
Sun, 20 Dec 2009 15:23:56 +0000 (16:23 +0100)
committerAndre Noll <maan@systemlinux.org>
Sun, 20 Dec 2009 15:23:56 +0000 (16:23 +0100)
bitstream.h

index 0999414..5d6be3b 100644 (file)
@@ -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)