[FFmpeg-devel] Documented parameter of av_dump_format

[Michael Niedermayer]

On Thu, Mar 06, 2014 at 02:35:42PM +0530, anshul wrote:
> Hi
> 
> I have added the documentation about the parameter and function use
> 
> for av_dump_format
> 
> Thanks
> Anshul Maheshwari

>  avformat.h |   10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> db3164f12843c71c50c47b1ec3be70e6cfb40c76  0001-added-documentation-of-av_dump_format.patch
> From d414f295d3b5acf173eb238a4439c2ebb237a249 Mon Sep 17 00:00:00 2001
> From: Anshul Maheshwari <er.anshul.maheshwari at gmail.com>
> Date: Thu, 6 Mar 2014 14:32:47 +0530
> Subject: [PATCH] added documentation of av_dump_format
> 
> ---
>  libavformat/avformat.h | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> 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


> + * @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
> + * @param is_output whether specified context is of input or output

selects whether the specified ...


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

> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> http://ffmpeg.org/mailman/listinfo/ffmpeg-devel


-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

The misfortune of the wise is better than the prosperity of the fool.
-- Epicurus
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20140311/529b6f45/attachment.asc>