[Dri-devel] Re: [Mesa3d-dev] Small Doxygen tutorial (Was: DRI/Mesa Doxygen documentation)

[Brian P. <br...@tu...>]

Jos=E9 Fonseca wrote:
[...]
> /**********************************************************************=
/
> /** \name                  Read - Important                           *=
/
> /**********************************************************************=
/
> /*@{*/
> I really ask for the Doxygen markup being used in _every_ new piece of
> code in the DRI/Mesa project, regardless of how complete is the
> surrounding documentation. Let's assume that _all_ code will be
> documented so whatever can be done now is less work to be done later.
> Yes, there _is_ a real benefit in having all the code documented.
> Doxygen allows to produce documentation cross-referenced with the sourc=
e
> code, making a wonderfull source browsing tool for someone wanting to
> study the code.  Specifications as the ones found on
> http://dri.sf.net/doc are good for an initial draft but they require
> constant and time-consuming maintaince, and eventually get obsolete.
> Code documentation is not only easier to maintain - by updating
> simultaneously with the code -, as also benefits from the same
> versioning as the code.=20
> /*@}*/

I'm using it in all the new code I write.  I'm also doxygen-izing existin=
g=20
comment blocks for functions when I'm in the neighborhood.

-Brian