[FFmpeg-devel] [PATCH 04/13] Doxygen av_codec_get_id() and av_codec_get_tag().

[Michael Niedermayer]

On Tue, May 11, 2010 at 12:59:22AM +0200, Stefano Sabatini wrote:
> On date Sunday 2010-05-09 23:23:16 +0200, Michael Niedermayer encoded:
> > On Sun, May 09, 2010 at 04:26:41PM +0200, Stefano Sabatini wrote:
> > > ---
> > >  libavformat/avformat.h |   14 +++++++++++++-
> > >  1 files changed, 13 insertions(+), 1 deletions(-)
> > > 
> > > diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> > > index 9928e84..e5e8e1b 100644
> > > --- a/libavformat/avformat.h
> > > +++ b/libavformat/avformat.h
> > > @@ -868,8 +868,20 @@ void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
> > >   */
> > >  void av_register_all(void);
> > >  
> > > -/** codec tag <-> codec id */
> > > +/**
> > > + * Gets the first CodecID found in tags corresponding to tag.
> > > + * If no codec id is found returns CODEC_ID_NONE.
> > > + *
> > > + * @param tags a list of list of tags
> > > + */
> > 
> > Gets the CodecID for the given tag.
> > beyond that you describe the private implementation. That can be desribed
> > too but not in a public header.
> 
> Updated.
> -- 
> FFmpeg = Fierce and Funny Meaningful Pacific Excellent Game

>  avformat.h |   14 +++++++++++++-
>  1 file changed, 13 insertions(+), 1 deletion(-)
> e0333b00755a226084dbdcc099f88994fc919ea1  0001-Doxygen-av_codec_get_id-and-av_codec_get_tag.patch
> >From 0ac02ba176740f89f46e99e4602492bd7f9d5b0e Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefano.sabatini-lala at poste.it>
> Date: Wed, 24 Mar 2010 01:32:41 +0100
> Subject: [PATCH 1/9] Doxygen av_codec_get_id() and av_codec_get_tag().
> 
> ---
>  libavformat/avformat.h |   14 +++++++++++++-
>  1 files changed, 13 insertions(+), 1 deletions(-)
> 
> diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> index 9928e84..a0acf0e 100644
> --- a/libavformat/avformat.h
> +++ b/libavformat/avformat.h
> @@ -868,8 +868,20 @@ void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
>   */
>  void av_register_all(void);
>  
> -/** codec tag <-> codec id */
> +/**
> + * Gets the CodecID for the given codec tag tag.
> + * If no codec id is found returns CODEC_ID_NONE.
> + *

> + * @param tags a NULL-terminated list of lists of tags

for the user, tags is the thing from AVIn/OutputFormat.codec_tag
if thats a null terminated list is a implementation details the user
doesnt need to know nor do we gurantee this to be so in the future

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Let us carefully observe those good qualities wherein our enemies excel us
and endeavor to excel them, by avoiding what is faulty, and imitating what
is excellent in them. -- Plutarch
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20100511/4f1e7e7c/attachment.pgp>