[Ffmpeg-devel] [PATCH 01/31] Doxygenize existing comments

[Michael Niedermayer]

Hi

On Sun, Mar 04, 2007 at 11:11:26PM +0100, takis.issaris at uhasselt.be wrote:
> Doxygenize the existing comments in avformat.h. The contents of the comment was
> left unaltered.

patch ok
comments unrelated to the doxygenization but rather related to the
comments/doxy are below


[...]
> -/* This is a hack - the packet memory allocation stuff is broken. The
> -   packet is allocated if it was not really allocated */
> +/**
> + * @warning This is a hack - the packet memory allocation stuff is broken. The
> + * packet is allocated if it was not really allocated
> + */

i wouldnt call t broken considering it works fairly well ...


>  int av_dup_packet(AVPacket *pkt);
>  
>  /**
> @@ -122,7 +124,7 @@ struct AVCodecTag;
>  
>  struct AVFormatContext;
>  
> -/* this structure contains the data a format has to probe a file */
> +/** this structure contains the data a format has to probe a file */
>  typedef struct AVProbeData {

i think this should be rephrased ...


[...]
>  typedef struct AVOutputFormat {
>      const char *name;
>      const char *long_name;
>      const char *mime_type;
> -    const char *extensions; /* comma separated extensions */
> -    /* size of private data so that it can be allocated in the wrapper */
> +    const char *extensions; /**< comma separated extensions */

_filename_ extensions


[...]
>      int flags;
> -    /* currently only used to set pixel format if not YUV420P */
> +    /** currently only used to set pixel format if not YUV420P */
>      int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);

this is wrong i think


[...]
>      /* ffmpeg.c private use */
> -    int stream_copy; /* if TRUE, just copy stream */
> +    int stream_copy; /* *<if TRUE, just copy stream */

TRUE? this isnt C++

[...]

>      float quality;
>      /* decoding: position of the first frame of the component, in
>         AV_TIME_BASE fractional seconds. */
>      int64_t start_time;

not doxygenized?


> -    /* decoding: duration of the stream, in AV_TIME_BASE fractional
> +    /** decoding: duration of the stream, in AV_TIME_BASE fractional
>         seconds. */
>      int64_t duration;

i do think that all stream specific time "things" are in AVStream.timebase
units


[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Dictatorship naturally arises out of democracy, and the most aggravated
form of tyranny and slavery out of the most extreme liberty. -- Plato
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070304/861637df/attachment.pgp>