gui: Make curses_active a bool.

[paraslash.git] / bitstream.c

diff --git a/bitstream.c b/bitstream.c
index 1139edc0d01dfe3668906f747809e0bfb055c18e..ddad67bb177211b3909f88d3be9dcb3d5c381238 100644 (file)
--- a/bitstream.c
+++ b/bitstream.c
@@ -27,6 +27,7 @@
 #include "wma.h"
 #include "bitstream.h"
 
+/** Read an 8, 16, or 32 bit entity from a VLC table. */
 #define GET_DATA(v, table, i, size) \
 {\
        const uint8_t *ptr = (const uint8_t *)table + i * size; \
@@ -160,6 +161,14 @@ void init_vlc(struct vlc *vlc, int nb_bits, int nb_codes, const void *bits,
        build_table(vlc, nb_bits, nb_codes, bits, codes, codes_size, 0, 0);
 }
 
+/**
+ * Deallocate all resources of a VLC table.
+ *
+ * \param vlc Pointer to an initialized vlc structure.
+ *
+ * The table given by \a vlc must have been initialized earlier via \ref
+ * init_vlc().
+ */
 void free_vlc(struct vlc *vlc)
 {
        freep(&vlc->table);