Pontus,

On 2002.01.19 15:33 Pontus Lidman wrote:
> Hello,
> 
> Like Mr. Jose Fonseca, I have some very positive experiences with the
> Doxygen tool for documentation, and I warmly recommend it to the DRI
> project. It produces good API documentation, and the documentation is
> easy to maintain because of its integration in the source code.
> 
> To try to show what it could do, I took some of the existing HTML
> documentation from the web page, and put it into the appropriate
> source file, xf86drm.c, generated documentation using Doxygen, and
> published the result on a web page so you can take a look.
> 
> Please visit http://h90.ryd.student.liu.se/~pontus/index.html to see
> the results. The doxygen-annotated source is also available.
> 

It's a quite impressive demonstration of Doxygen capabilities indeed. 
With the cross references to the source it becomes superb to those 
newcomers that want to grasp the DRI code.

> The reason I post is that I have become interested in the DRI project,
> and will try to contribute. Based on the recent discussions on this
> list, documentation seems to be an important area, and in my
> experience the best time to contribute to that is while you are
> learning :)
> 

Agreed!

> Regards,
> 
> Pontus
> 
> --
> Pontus Lidman, [EMAIL PROTECTED], Software Engineer
> No matter how cynical you get, it's impossible to keep up.
> Scene: www.dc-s.com | MUD: tyme.envy.com 6969 | irc: irc.quakenet.eu.org
> 

Unless anyone has a better suggestion I think this is the way to go. What 
do the "elder" developers think?

Regards,

José Fonseca

_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com


_______________________________________________
Dri-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/dri-devel

Reply via email to