Section 4. Development Tools

The following is a list and description of what outside tools are used in the development of Covered, how they are used within the project, and where to find these tools.
Section 4.1. Doxygen
Doxygen is a command-line tool that takes in a configuration file to specify how to generate the appropriate documentation. The name of Covered's Doxygen configuration file is located in the doc directory of Covered called covered.dox. To generate documentation for the source files, enter the following command:
doxygen covered.dox
The Covered project uses Doxygen's source file documentation extraction capabilities for generating this developer's document. The output of Doxygen is two directories underneath the doc/devel directory: html and latex. It also places a Makefile in the latex directory for creating PDF versions of the documentation.
The input files for Doxygen are all *.h and *.c files located in the covered/src directory. Because Doxygen is unable to understand/parse Flex and Bison files, the *.l and *.y files are omitted from documentation generation. Placing Doxygen-style comments in these files will not result in developer documentation apart from the source file itself.
For a complete description on how to use Doxygen and where to download it from, check out the Doxygen homepage at:

Section 4.2. CVS
CVS is used as the file revision and project management tool for Covered. The CVS server is provided by SourceForge ( ). It was chosen due its ability to allow multiple developer's from all over the globe to access and work on this project simultaneously. It was also chosen because of its availability for most development platforms.

Section 4.3. Valgrind
The valgrind utility is useful for performing lots of various runtime checks. Most UNIX variants come equipped with the valgrind utility. For those environments that do not have this utility available, it can be downloaded and fairly easily built and installed. Please see its documentation for information on how to use it.
To use valgrind for memory checking (is most useful function, in my opinion), simply run any command prefixed with
 valgrind --tool=memcheck -v
This will run the given Covered command using Valgrind to perform memory checking. No further configuration of Covered is necessary.

Go To Section...
Generated on Sun Nov 21 00:55:42 2010 for Covered by  doxygen 1.6.3