cmdutils: clarify documentation for filter_codec_opts()
authorStefano Sabatini <stefano.sabatini-lala@poste.it>
Sat, 16 Jul 2011 23:20:50 +0000 (01:20 +0200)
committerAnton Khirnov <anton@khirnov.net>
Thu, 28 Jul 2011 15:13:14 +0000 (17:13 +0200)
Signed-off-by: Anton Khirnov <anton@khirnov.net>
cmdutils.h

index 90e0a25..dcd0b79 100644 (file)
@@ -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);