DoxygenSummary

From NAMIC

Jump to: navigation, search

Contents

Description

Doxygen is a documentation system for C++, C, Java, Objective-C, IDL (Corba and Microsoft flavors). Doxygen extracts information directly from the source code, including specially formated text added by the user. It then produces the documentation in HTML or LaTeX form. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. Doxygen also automatically produces dependency graphs, inheritance diagrams, and collaboration diagrams.

In NAMIC, Doxygen is a utility program used to extract documentation from most of the core pieces of software including VTK, ITK, CMake, Slicer and DART.

Typical Usage

Doxygen requires the creation of a configuration file {e.g., doxygen.config). The configuration file refers to the location of the source code. Doxygen parses the source code and extracts user information embeded in the code (marked by special constructs such comments delimited by /** **/ comments). Other information, such as inheritance information, is extracted directly from the structure of the source code itself. Docygen then outputs documentation in the format specified by the configuration file.

Documentation, Tutorials and Examples

The latest documentation can be downloaded from here.

Several real world examples are available as well. See also the VTK, ITK, CMake and Slicer projects to see Doxygen in use in the NAMIC project.

License

GNU General Public License

Personal tools