[FFmpeg-cvslog] cmdutils: clarify documentation for filter_codec_opts()

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefano.sabatini-lala at poste.it> | Sun Jul 17 01:20:50 2011 +0200| [ce23ca814b0fa6327b21e03be09b81f9b0d7113d] | committer: Anton Khirnov

cmdutils: clarify documentation for filter_codec_opts()

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

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=ce23ca814b0fa6327b21e03be09b81f9b0d7113d
---

 cmdutils.h |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/cmdutils.h b/cmdutils.h
index 90e0a25..dcd0b79 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);