From: Andre Noll <maan@systemlinux.org>
Date: Sun, 20 Dec 2009 15:23:56 +0000 (+0100)
Subject: Add documentation of struct vlc.
X-Git-Tag: v0.4.1~5^2~6
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=d502f7a751160224ab0a0632ff972c49f6acf54a;p=paraslash.git

Add documentation of struct vlc.
---

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)