[FFmpeg-devel] [PATCH] Indeo5 decoder

[Dave Dodge]

On Sat, Mar 28, 2009 at 07:21:52PM +0000, M?ns Rullg?rd wrote:
> Mike Melanson <mike at multimedia.cx> writes:
> > Let's repeat that, because it is often overlooked: to document global
> > objects (functions, typedefs, enum, macros, etc), you must document
> > the file in which they are defined. In other words, there must at
> > least be a
> >
> > /*! \file */
> >
> > or a
> >
> > /** @file */
> >
> > line in this file.
> 
> That's messed up.  What kind of app doesn't know the name of the file
> it just opened?

Doxygen does know the name.  The \file tag starts the documentation,
but you don't have to explicitly tell it the filename.  If you leave
it blank (as shown above) Doxygen should figure it out.  In my own C
code files usually start something like this:

/** \file
 * \brief The description of the file goes here blah blah blah.
 */

                                                  -Dave Dodge