dox_comment_chg.pl File Reference
Used when Doxygenating C/C++ code files.
More...
Go to the source code of this file.
Defines
Detailed Description
Used when Doxygenating C/C++ code files.
This is a tool to change the Doxygen comment style from C-style comments to comments with slash-slash-bang. The reason is that influential members of the coding convention group decided that they liked more C++ style comments and did not want to have mixed comment styles. Hence, our coding conventions specify this style.
This tool changes existing C style comments to this slash-slash-bang comments.
-
Note:
-
Input filters need to be used to change those slash-slash-bang comments into the other style, because the other style works better in Doxygen. If the engineers want to see one style comments in the code that they own, more power to them. The filters will get it back to what Doxygen likes better.
I suspect that this tool will not actually be used much despite the coding conventions. Existing comment styles are grandfathered in. Also, new development tools like TogetherSoft produce more JavaDoc like files and prefer those comments. Hence, another suspicion is that our coding conventions will flop back to the C-style JavaDoc comments making this tool never used.-
Parameters:
-
-
Returns:
-
Output is file with changes.
-
Author:
-
Glenn C. Maxey
Definition in file dox_comment_chg.pl.
Define Documentation
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-perl-hcr-02