code comment tags



list,

I'll be updating the EMC/RCS source code documentation at
http://www.linuxcnc.org/handbook/fileref/  
over the weekend and was wondering if any of you who are 
active developers would be interested in adding comment tags
to the code you are working with in the CVS archive
to help flesh out some of the function descriptions
the tags tell doxygen to add the comment to the html files that are generated
from the source code and help make the pages a little more informative

the tags are just to add '!' at the start of descriptive 
comments already in the code like so
/*!  function description  */
or for one liners
//! brief comment
javadoc style tags are also recognized by doxygen
/**  stuff  */  
and 
 /// mo stuff

no rush ,I'll be updating the docs about every week or three 
so any changes will get included eventually

Brian






Date Index | Thread Index | Back to archive index | Back to Mailing List Page

Problems or questions? Contact