dccp: sort out help text

[paraslash.git] / bitstream.c

diff --git a/bitstream.c b/bitstream.c
index d9d5233a9cde81ad2265ab06fe425f549ab85c51..1139edc0d01dfe3668906f747809e0bfb055c18e 100644 (file)
--- a/bitstream.c
+++ b/bitstream.c
@@ -132,10 +132,11 @@ static int build_table(struct vlc *vlc, int table_nb_bits, int nb_codes,
 /**
  * Build VLC decoding tables suitable for use with get_vlc().
  *
- * \param nb_bits Set the decoding table size (2^nb_bits)
- * entries. The bigger it is, the faster is the decoding. But
- * it should not be too big to save memory and L1 cache. '9'
- * is a good compromise.
+ * \param vlc The structure to be initialized.
+ *
+ * \param nb_bits Set the decoding table size (2^nb_bits) entries. The bigger
+ * it is, the faster is the decoding. But it should not be too big to save
+ * memory and L1 cache. '9' is a good compromise.
  *
  * \param nb_codes Number of vlcs codes.
  *
@@ -169,6 +170,8 @@ void free_vlc(struct vlc *vlc)
  *
  * \param gbc The getbit context structure.
  *
+ * \param table The vlc tables to use.
+ *
  * \param bits The number of bits which will be read at once, must be
  * identical to nb_bits in init_vlc().
  *
@@ -200,5 +203,5 @@ int get_vlc(struct getbit_context *gbc, VLC_TYPE(*table)[2], int bits,
                }
        }
        skip_bits(gbc, n);
-       return code;
+       return code >= 0? code : -E_VLC;
 }