cmdutils: clarify documentation for filter_codec_opts()

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

diff --git a/cmdutils.h b/cmdutils.h
index 90e0a2585090fe8b5063a6bc44d3ed24c3996402..dcd0b79a1fdc1b7d33a21d50d1606b20a4423751 100644 (file)
--- 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);