avcodec/get_bits: Document the return code of get_vlc2()
authorMichael Niedermayer <michael@niedermayer.cc>
Sun, 28 Jan 2018 01:29:01 +0000 (02:29 +0100)
committerMichael Niedermayer <michael@niedermayer.cc>
Mon, 29 Jan 2018 03:11:28 +0000 (04:11 +0100)
Found-by: kierank
Reviewed-by: Kieran Kunhya <kieran618@googlemail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
libavcodec/get_bits.h

index c530015..0c7f5ff 100644 (file)
@@ -550,6 +550,7 @@ static inline const uint8_t *align_get_bits(GetBitContext *s)
  * @param max_depth is the number of times bits bits must be read to completely
  *                  read the longest vlc code
  *                  = (max_vlc_length + bits - 1) / bits
+ * @returns the code parsed or -1 if no vlc matches
  */
 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
                                      int bits, int max_depth)