Doxygen Support
Doxygen is a "source code documentation generator tool" which can be downloaded at doxygen.org. It works similar to JavaDoc and is used here to check sourcecode comments.
The CppChecker is tested with Doxygen 1.5.2, 1.5.6, 1.5.7 and 1.5.8 The default options can be changed, however it is advisable not to change or add the settings for INPUT and OUTPUT! That is done automatically by the plug-in (INPUT) or by the setting in the properties (OUTPUT), which is also used to find the documentation from the doxygen view.
Features:
- markers placed at the beginning of the wrong comments.
- all markers generated for doxygen warnings have the same severity, which can be adjusted to info, warning and error.
- uses exclude-settings from CDT project file
- enhanced error reporting for undocumented parameters and wrong parameters (markers on the wrong parameter or comment)
- enhanced handling of full builds -> generate whole documentation
- enhanced handling of incremental builds -> only the changed files are updated - the common files are left unchanged. This also includes generated graphs with dot.
- doxygen view showing the doc of the currently edited or selected code / part. The currently selected part can also be marked in the doxygen view.
TODO's / in consideration:
- auto fix feature for specific error messages / warnings
- support for dynamic help in eclipse (probably won't be done, as the doxygen-view already shows the current help content).
::history::JAYlib/HomePage > CppChecker/GCCSupport > CppChecker/Screenshots > CppChecker/Installation > CppChecker/DoxygenSupport