dox_bug_filter.pl File Reference
Input filter for Doxygen for most C/C++ code files.
More...
Go to the source code of this file.
Defines
Detailed Description
Input filter for Doxygen for most C/C++ code files.
This changes code comments and other items on-the-fly so that it can be more effectively processed by Doxygen. In particular, our coding standard calls for slash-slash-bang comments. However, these comments are not interpretted as blocks even when placed together. Sometimes comments from a file header were being placed on code items. By changing the comment style to be C-style, a true comment block could be created with no misinterpretation.
Other changes that this file does include:
- formatting some auto-generated classes to be correct for extraction.
- replacing @_bug with @_lim -- defined in the project file -- so that the word "bug" never appears in our output.
-
Parameters:
-
-
Returns:
-
Output is file with changes.
-
Author:
-
Glenn C. Maxey
Definition in file dox_bug_filter.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