[Ffmpeg-cvslog] r8082 - trunk/libavcodec/avcodec.h

[takis]

Author: takis
Date: Thu Feb 22 20:09:35 2007
New Revision: 8082

Modified:
   trunk/libavcodec/avcodec.h

Log:
Doxygenize the comments for the av_get_bits_per_sample() function.

Modified: trunk/libavcodec/avcodec.h
==============================================================================
--- trunk/libavcodec/avcodec.h	(original)
+++ trunk/libavcodec/avcodec.h	Thu Feb 22 20:09:35 2007
@@ -2776,7 +2776,10 @@
 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);