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

[Stefano Sabatini]

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

cmdutils: clarify documentation for setup_find_stream_info_opts()

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

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

 cmdutils.h |   12 ++++++++++--
 1 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/cmdutils.h b/cmdutils.h
index a47f157..90e0a25 100644
--- a/cmdutils.h
+++ b/cmdutils.h
@@ -153,8 +153,16 @@ void parse_options(int argc, char **argv, const OptionDef *options,
  */
 AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, int encoder);
 
-/*
- * Setup AVCodecContext options for avformat_find_stream_info.
+/**
+ * Setup AVCodecContext options for avformat_find_stream_info().
+ *
+ * Create an array of dictionaries, one dictionary for each stream
+ * contained in s.
+ * Each dictionary will contain the options from codec_opts which can
+ * be applied to the corresponding stream codec context.
+ *
+ * @return pointer to the created array of dictionaries, NULL if it
+ * cannot be created
  */
 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s);