Doxygenize the comments for the av_get_bits_per_sample() function.
authorPanagiotis Issaris <takis.issaris@uhasselt.be>
Thu, 22 Feb 2007 19:09:35 +0000 (19:09 +0000)
committerPanagiotis Issaris <takis.issaris@uhasselt.be>
Thu, 22 Feb 2007 19:09:35 +0000 (19:09 +0000)
Originally committed as revision 8082 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/avcodec.h

index e956f73..1b1946a 100644 (file)
@@ -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);