# HG changeset patch
# User takis
# Date 1172171375 0
# Node ID 58be423405dba53094332bc62a37f84e44c20a18
# Parent  dcf43f64d80d7a27f00f80b93d9e6cb19a9f73f7
Doxygenize the comments for the av_get_bits_per_sample() function.

diff -r dcf43f64d80d -r 58be423405db avcodec.h
--- 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);