DoxygenFeatures
Version 1 (kervala, 09/30/2010 09:50 am)
| 1 | 1 | kervala | h1. DoxygenFeatures |
|---|---|---|---|
| 2 | 1 | kervala | |
| 3 | 1 | kervala | Doxygen will be used to generate online documentation of source code of Nel and Ryzom. |
| 4 | 1 | kervala | Some features that we can add or remove : (To see all options for configuration files : http://www.stack.nl/~dimitri/doxygen/config.html) |
| 5 | 1 | kervala | |
| 6 | 1 | kervala | h2. General |
| 7 | 1 | kervala | |
| 8 | 1 | kervala | _HAVE_DOT_ : Dot is part of GraphViz package. Set this option to enable graphs and/or histograms. |
| 9 | 1 | kervala | |
| 10 | 1 | kervala | _UML_LOOK_ : Generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language |
| 11 | 1 | kervala | |
| 12 | 1 | kervala | h2. Classes |
| 13 | 1 | kervala | |
| 14 | 1 | kervala | _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. |
| 15 | 1 | kervala | !Collaboration_graph.jpg! |
| 16 | 1 | kervala | |
| 17 | 1 | kervala | _CLASS_GRAPH_ : A graph for each documented class showing the direct and indirect inheritance relations. |
| 18 | 1 | kervala | !Class_graph.jpg! |
| 19 | 1 | kervala | |
| 20 | 1 | kervala | Same with _UML_LOOK_ enabled: |
| 21 | 1 | kervala | !Class_graph_uml.jpg! |
| 22 | 1 | kervala | |
| 23 | 1 | kervala | _CLASS_DIAGRAM_ : A class diagram for classes with base or super classes. |
| 24 | 1 | kervala | !Class_diagram.jpg! |
| 25 | 1 | kervala | |
| 26 | 1 | kervala | _GRAPHICAL_HIERARCHY_ : A graphical hierarchy of all classes instead of a textual one. |
| 27 | 1 | kervala | !Graphical_hierarchy.jpg! |
| 28 | 1 | kervala | |
| 29 | 1 | kervala | h2. Methodes |
| 30 | 1 | kervala | |
| 31 | 1 | kervala | _CALL_GRAPH_ : A call dependency graph for every global function or class method. |
| 32 | 1 | kervala | !Call_graph.jpg! |
| 33 | 1 | kervala | |
| 34 | 1 | kervala | _CALLER_GRAPH_ : A caller dependency graph for every global function or class method. |
| 35 | 1 | kervala | !Caller_graph.jpg! |
| 36 | 1 | kervala | |
| 37 | 1 | kervala | h2. Files |
| 38 | 1 | kervala | |
| 39 | 1 | kervala | _INCLUDE_GRAPH_ : A graph for each documented file showing the direct and indirect include dependencies of the file with other documented files. |
| 40 | 1 | kervala | !Include_graph.jpg! |
| 41 | 1 | kervala | |
| 42 | 1 | kervala | _INCLUDED_BY_GRAPH_ : A graph for each documented header file showing the documented files that directly or indirectly include this file. |
| 43 | 1 | kervala | !Included_by_graph.jpg! |