changeset 4570:58be423405db libavcodec

Doxygenize the comments for the av_get_bits_per_sample() function.
author takis
date Thu, 22 Feb 2007 19:09:35 +0000
parents dcf43f64d80d
children 6f3ed8519dff
files avcodec.h
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/avcodec.h	Thu Feb 22 19:08:39 2007 +0000
+++ b/avcodec.h	Thu Feb 22 19:09:35 2007 +0000
@@ -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);