[FFmpeg-devel] [PATCH 4/6] Add a @file doxy.

Stefano Sabatini stefano.sabatini-lala
Sun Apr 25 22:39:13 CEST 2010

On date Sunday 2010-04-25 10:59:09 +0200, Luca Abeni encoded:
> On Sat, 2010-04-24 at 20:53 +0200, Stefano Sabatini wrote:
> > ---
> >  libavdevice/v4l2.c |    6 +++++-
> >  1 files changed, 5 insertions(+), 1 deletions(-)
> [...]
> This patch does not do what the subject says: it adds a "@file" (BTW,
> what's the advantage in adding such a doxy tag?), but it also moves the
> description of the file.
> Right now, when I open the file I can immediately read its description;
> after this patch, I will have to scroll down. So, I do not think it is a
> good idea.

@file description is showed in the doxygen documentation, and many
files are following the convention to put description in @file, while
copyright is put in the standard FFmpeg header.

Ideally we shoul put the @file doxy at the begin of the file, and put
there also the copyright stuff (note: this should be done globally).

Please check again.
FFmpeg = Fast and Faithful Mythic Philosophical Enlightening Geek

More information about the ffmpeg-devel mailing list