José Fonseca wrote: [...]
/**********************************************************************/
/** \name Read - Important */
/**********************************************************************/
/[EMAIL PROTECTED]/
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 source
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. /[EMAIL PROTECTED]/
I'm using it in all the new code I write. I'm also doxygen-izing existing comment blocks for functions when I'm in the neighborhood.
-Brian
------------------------------------------------------- This SF.net email is sponsored by: ValueWeb: Dedicated Hosting for just $79/mo with 500 GB of bandwidth! No other company gives more support or power for your dedicated server http://click.atdmt.com/AFF/go/sdnxxaff00300020aff/direct/01/ _______________________________________________ Dri-devel mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/dri-devel
