Example
Doxygen
Installing dot on Linux
Create file g01.dot
digraph G {
main -> glut;
main -> d4tri;
main -> zpr;
main -> d4tessdraw;
main -> d4tess;
}
Make the graph.
dot -Tpng g01.dot -o g01.png
doxygen -g
to generate Doxyfile. Edit this configuration
file. To generate the documentation run doxygen Doxyfile.
EXTRACT_ALL = YES
Extract documentation even from those elements you haven't yet commented.
INLINE_SOURCE = YES
Extract the relevant parts of the source and associate them with your description.
HAVE_DOT = YES
Use Graphviz for class and collaboration diagrammes.
CALL_GRAPH = YES
Generate a dependency graph for functions and methods.
GENERATE_LATEX = NO
Skip generating LaTeX sources for PDF.
An example of documentation in the file
/**
* \file tutorial.h
* \author Chris Olsen
* \date 2-26-04
*/
#ifndef __TUTORIAL__
#define __TUTORIAL__
/**
* An example class for the Doxygen tutorial
*/
class Tutorial
{
public:
/// The Constructor
Tutorial();
/** The Destructor */
virtual ~Tutorial();
/**
Takes three inputs and does something
\param a A float paramater
\param b An int paramater
\param c A char paramater
\return Returns an integer
*/
int Method1(float a, int b, char c);
int var; ///< This was commented after declaration
};
#endif