[Ffmpeg-cvslog] r6161 - in trunk: libavcodec/dv.c libavcodec/dvdata.h libavformat/avformat.h libavformat/dv.c tests/ffmpeg.regression.ref tests/libav.regression.ref tests/rotozoom.regression.ref

[Guillaume POIRIER]

Hi,

On 9/4/06, Michael Niedermayer <michaelni at gmx.at> wrote:
> Hi
>
> On Mon, Sep 04, 2006 at 05:33:12AM +0200, romansh wrote:
> > Author: romansh
> > Date: Mon Sep  4 05:33:11 2006
> > New Revision: 6161
> >
> > Modified:
> >    trunk/libavcodec/dv.c
> >    trunk/libavcodec/dvdata.h
> >    trunk/libavformat/avformat.h
> >    trunk/libavformat/dv.c
> >    trunk/tests/ffmpeg.regression.ref
> >    trunk/tests/libav.regression.ref
> >    trunk/tests/rotozoom.regression.ref
> >
> > Log:
> >
> >   * Restructuring the division of labor between DV codec and DV format
> >     [ Based on a patch by Brian Brice (bbrice at newtek dot com) ]
>
> [...]
> > +enum dv_pack_type {
> > +     dv_header525     = 0x3f, /* see dv_write_pack for important details on */
> > +     dv_header625     = 0xbf, /* these two packs */
>
> not doxygen compatible comment

FWIW, it should be:

dv_header525     = 0x3f, ///< see dv_write_pack for important details on ...

I don't know how you can refer to the 2 packs as a whole without
either copying/pasting the comment 2 times
You may also try smth such as:

//! see dv_write_pack for important details on ...
enum dv_pack_type {
...

which allows you to document the whole enum.

Guillaume
-- 
A thing is not necessarily true because a man dies for it.
-- Oscar Wilde