Documenting the Code and Viewing the documentation 

Documenting the Code

This is done using Doxygen. The user first needs to install Doxygen on their local machine. Here is a link to the Doxygen Home Page Doxygen.

There are several aspects to consider vis-à-vis documenting GLAST code

• Please read the Code Recommendations document available from the Documentation Task Force Home Page.
• We are using Doxygen-style comments within the code.  A help page explains the basic Doxygen concepts, as well as certain GLAST conventions.

Viewing the Code Documentation

There are several different types of documentation for Glast code.

• Doxygen documentation is available for tagged version of several checkout packages

Last Modified August 04, 2004

Back To Main Menu        Previous Step  (Windows) (Unix)     Next Step