[FFmpeg-devel,2/3] avcodec/get_bits: Document the return code of get_vlc2()

Submitted by Michael Niedermayer on Jan. 28, 2018, 1:29 a.m.

Details

Message ID 20180128012902.22504-2-michael@niedermayer.cc
State New
Headers show

Commit Message

Michael Niedermayer Jan. 28, 2018, 1:29 a.m.
Found-by: kierank
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
---
 libavcodec/get_bits.h | 1 +
 1 file changed, 1 insertion(+)

Patch hide | download patch | download mbox

diff --git a/libavcodec/get_bits.h b/libavcodec/get_bits.h
index c530015169..0c7f5ff0c6 100644
--- a/libavcodec/get_bits.h
+++ b/libavcodec/get_bits.h
@@ -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)