DoxygenFeatures¶

Doxygen will be used to generate online documentation of source code of Nel and Ryzom.
Some features that we can add or remove : (To see all options for configuration files : http://www.stack.nl/~dimitri/doxygen/config.html)

General¶

HAVE_DOT : Dot is part of GraphViz package. Set this option to enable graphs and/or histograms.

UML_LOOK : Generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language

Classes¶

COLLABORATION_GRAPH : A graph for each documented class showing the direct and indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes.

CLASS_GRAPH : A graph for each documented class showing the direct and indirect inheritance relations.

Same with UML_LOOK enabled:

CLASS_DIAGRAM : A class diagram for classes with base or super classes.

GRAPHICAL_HIERARCHY : A graphical hierarchy of all classes instead of a textual one.

Methodes¶

CALL_GRAPH : A call dependency graph for every global function or class method.

CALLER_GRAPH : A caller dependency graph for every global function or class method.

Files¶

INCLUDE_GRAPH : A graph for each documented file showing the direct and indirect include dependencies of the file with other documented files.

INCLUDED_BY_GRAPH : A graph for each documented header file showing the documented files that directly or indirectly include this file.