[FFmpeg-devel] Documented parameter of av_dump_format

[Timothy Gu]

On Mar 10, 2014 5:27 PM, "Michael Niedermayer" <michaelni at gmx.at> wrote:
>
> On Thu, Mar 06, 2014 at 02:35:42PM +0530, anshul wrote:

> > diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> > index e0ec3da..17cc80e 100644
> > --- a/libavformat/avformat.h
> > +++ b/libavformat/avformat.h
> > @@ -2371,7 +2371,15 @@ void av_url_split(char *proto,         int
proto_size,
> >                    char *path,          int path_size,
> >                    const char *url);
> >
> > -
> > +/**
> > + * Dump the Context of input or output
>
> sounds odd, some englishman should check/reword this i think

Print information dump of a context

>
>
> > + * @param ic already initialized Format Context, NULL pointer will end
up
> > + *            in segfault.
>
> "must not be NULL"
>
>
> > + * @param index index of stream
>
> index of the stream to dumpp information about
>
>

> > + * @param url name of file or url of stream used for printing purpose

name of file or URL of stream to print information about

> > + * @param is_output whether specified context is of input or output
>
> selects whether the specified ...

If it's input should it be 0? If it's output should it be 1? Document it!

>
>
> > + *
> > + */
> >  void av_dump_format(AVFormatContext *ic,
> >                      int index,
> >                      const char *url,
> > --
> > 1.8.1.4
> >

Timothy