
As most of the developers know and use doxygen for the documentaion purpose. if we can add the graphviz to doxygen we can get Class collaborative diagrams as well in a neat.
Graphviz is for represent information in a graphical Notaion. Which understand 'dot' language.
http://www.graphviz.org/
The minimum requirement of Doxygen version is 1.5.x. http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
Follow the below steps
1) doxygen -g "filename" -> generates a file, which contains the list of supported tags to enable or disable.
2) Enable following basic tags from the generated file.
a. EXTRACT_ALL = YES
b. INPUT = ‘input source directory path to be document”
c. FILE_PATTERNS = *.h\ *.C
3) Doxygen uses the "dot" tool to generate the following graphs
- if GRAPHICAL_HIERARCHY is set to
YES, a graphical representation of the class hierarchy will be drawn, along with the textual one. Currently this feature is supported for HTML only.
Warning: When you have a very large class hierarchy where many classes derive from a common base class, the resulting image may become too big to handle for some browsers. - if CLASS_GRAPH is set to
YES, a graph will be generated for each documented class showing the direct and indirect inheritance relations. This disables the generation of the built-in class inheritance diagrams. - if INCLUDE_GRAPH is set to
YES, an include dependency graph is generated for each documented file that includes at least one other file. This feature is currently supported for HTML and RTF only. - if COLLABORARION_GRAPH is set to YES, a graph is drawn for each documented class and struct that shows:
- the inheritance relations with base classes.
- the usage relations with other structs and classes (e.g. class
Ahas a member variablem_aof type classB, thenAhas an arrow toBwithm_aas label). - if CALL_GRAPH is set to YES, a graphical call graph is drawn for each function showing the functions that the function directly or indirectly calls.
- if CALLER_GRAPH is set to YES, a graphical caller graph is drawn for each function showing the functions that the function is directly or indirectly called by.
No comments:
Post a Comment