summaryrefslogtreecommitdiff
path: root/libavcodec/avcodec.h
diff options
context:
space:
mode:
authorPanagiotis Issaris <takis.issaris@uhasselt.be>2007-02-22 19:09:35 +0000
committerPanagiotis Issaris <takis.issaris@uhasselt.be>2007-02-22 19:09:35 +0000
commit2fa378a72ca885c2c7ffc04d09fbc216f951f4bc (patch)
treef75f1c780e3b091c3201c7c7abb62099eb1bcb42 /libavcodec/avcodec.h
parent8f6260af48a5884efddc7687035024bb35be54a9 (diff)
Doxygenize the comments for the av_get_bits_per_sample() function.
Originally committed as revision 8082 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavcodec/avcodec.h')
-rw-r--r--libavcodec/avcodec.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index e956f73ff0..1b1946a64a 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -2776,7 +2776,10 @@ void avcodec_default_free_buffers(AVCodecContext *s);
char av_get_pict_type_char(int pict_type);
/**
- * returns codec bits per sample
+ * Returns codec bits per sample.
+ *
+ * @param[in] codec_id The codec.
+ * @return Number of bits per sample or zero if unknown for the given codec.
*/
int av_get_bits_per_sample(enum CodecID codec_id);