[FFmpeg-devel] [PATCH] Indeo5 decoder

[Måns Rullgård]

Mike Melanson <mike at multimedia.cx> writes:

> Michael Niedermayer wrote:
>> On Sat, Mar 28, 2009 at 01:17:34PM +0000, M?ns Rullg?rd wrote:
>>> Michael Niedermayer <michaelni at gmx.at> writes:
>>>
>>>> On Fri, Mar 27, 2009 at 04:45:15PM +0000, M?ns Rullg?rd wrote:
>>>>> Diego Biurrun <diego at biurrun.de> writes:
>>>>>
>>>>>> On Fri, Mar 27, 2009 at 04:41:18PM +0100, Maxim wrote:
>>>>>>> Any further reviews plz!
>>>>>> Your patch is missing a documentation and changelog update.
>>>>>>
>>>>>>> --- libavcodec/indeo5.c	(Revision 0)
>>>>>>> +++ libavcodec/indeo5.c	(Revision 0)
>>>>>>> @@ -0,0 +1,846 @@
>>>>>>> +
>>>>>>> +/**
>>>>>>> + * @file indeo5.c
>>>>>> Add the subdirectory prefix, i.e. libavcodec/.
>>>>> What are these tags good for anyway?
>>>> doxygen uses them to generate documentation in html or tex and possibly
>>>> a few other formats
>>> I know it's for doxygen.  What is not clear is why doxygen is unable
>>> to determine the filename from, well, the filename.
>> i dont know that ...
>
> http://www.stack.nl/~dimitri/doxygen/docblocks.html
>
> 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?

-- 
M?ns Rullg?rd
mans at mansr.com