lavf: document av_dump_format()

1 files changed, 10 insertions, 0 deletions

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 473b8daedf..ac4cd31157 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -1835,6 +1835,16 @@ void av_url_split(char *proto,         int proto_size,
                   const char *url);
 
 
+/**
+ * Print detailed information about the input or output format, such as
+ * duration, bitrate, streams, container, programs, metadata, side data,
+ * codec and time base.
+ *
+ * @param ic        the context to analyze
+ * @param index     the index to print, if you have multiple inputs or outputs
+ * @param url       the URL to print, such as source or destination file
+ * @param is_output whether the context is input or ouput
+ */
 void av_dump_format(AVFormatContext *ic,
                     int index,
                     const char *url,