From: Stefano Sabatini <stefano.sabatini-lala@poste.it>
Date: Sat, 16 Jul 2011 23:20:50 +0000 (+0200)
Subject: cmdutils: clarify documentation for filter_codec_opts()
X-Git-Tag: v0.8b1~1895
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ce23ca814b0fa6327b21e03be09b81f9b0d7113d;p=platform%2Fupstream%2Flibav.git

cmdutils: clarify documentation for filter_codec_opts()

Signed-off-by: Anton Khirnov <anton@khirnov.net>
---

diff --git a/cmdutils.h b/cmdutils.h
index 90e0a2585..dcd0b79a1 100644
--- a/cmdutils.h
+++ b/cmdutils.h
@@ -150,6 +150,12 @@ void parse_options(int argc, char **argv, const OptionDef *options,
 
 /**
  * Filter out options for given codec.
+ *
+ * Create a new options dictionary containing only the options from
+ * opts which apply to the codec with ID codec_id.
+ *
+ * @param encoder if non-zero the codec is an encoder, otherwise is a decoder
+ * @return a pointer to the created dictionary
  */
 AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, int encoder);