Contents 
 Index 
 "TPT User's Guide" 
 < Previous 
 Next > 

dox_comment_chg.pl

Used when Doxygenating C/C++ code files. This is a tool to change the Doxygen comment style from C-style comments /** ... **/ to comments with //!.

The reason is that influential members of the Voyant coding convention group decided that they liked C++ style comments better and did not want to have mixed comment styles in their source files. Hence, our coding conventions specify this style.

This tool changes any existing C-style comments to this //! comments. This is used when the technical writer is editing those source files. This change gets checked in.

However, input filters need to be used to change those //! comments back into the C-style on-the-fly, because the C-style works better in Doxygen.



 "TPT User's Guide" 
 < Previous 
 Next > 


Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-hug-02