Manual: Graphs and diagrams

Loading...
Searching...
No Matches
Graphs and diagrams

Doxygen has built-in support to generate inheritance diagrams for C++ classes.

Doxygen can use the "dot" tool from graphviz to generate more advanced diagrams and graphs. Graphviz is an open-source, cross-platform graph drawing toolkit and can be found at https://www.graphviz.org/

If you have the "dot" tool in the PATH (environment variable), you can set HAVE_DOT to `YES` in the configuration file to let Doxygen use it.

Doxygen uses the "dot" tool to generate the following graphs:

- 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.
- An inheritance 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.
- 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.
- An inverse include dependency graph is also generated showing for a (header) file, which other files include it.
- 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 `A` has a member variable `m_a` of type class `B`, then `A` has an arrow to `B` with `m_a` as 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 (see also section \callgraph and section \hidecallgraph).
- 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 (see also section \callergraph and section \hidecallergraph).
- If DIRECTORY_GRAPH is set to YES, Doxygen will generate graphs that show the directory dependencies for every directory. The graph will show directories as boxes. Subdirectories are shown nested into the box of its parent directory. The depth of the graph is configured through DIR_GRAPH_MAX_DEPTH. Include dependencies between the directories are shown as arrows.

Using a layout file you can determine which of the graphs are actually shown.

The options DOT_GRAPH_MAX_NODES and MAX_DOT_GRAPH_DEPTH can be used to limit the size of the various graphs.

The elements in the class diagrams in HTML and RTF have the following meaning:

- A yellow box indicates a class. A box can have a little marker in the lower right corner to indicate that the class contains base classes that are hidden. For the class diagrams, the maximum tree width is currently 8 elements. If a tree is wider some nodes will be hidden. If the box is filled with a dashed pattern the inheritance relation is virtual.
- A white box indicates that the documentation of the class is currently shown.
- A gray box indicates an undocumented class.
- A solid dark blue arrow indicates public inheritance.
- A dashed dark green arrow indicates protected inheritance.
- A dotted dark green arrow indicates private inheritance.

The elements in the class diagram in have the following meaning:

- A white box indicates a class. A marker in the lower right corner of the box indicates that the class has base classes that are hidden. If the box has a dashed border this indicates virtual inheritance.
- A solid arrow indicates public inheritance.
- A dashed arrow indicates protected inheritance.
- A dotted arrow indicates private inheritance.

The elements in the graphs generated by the dot tool have the following meaning:

- A white box indicates a class or struct or file.
- A box with a red border indicates a node that has more arrows than are shown! In other words: the graph is truncated with respect to this node. The reason why a graph is sometimes truncated is to prevent images from becoming too large. For the graphs generated with dot Doxygen tries to limit the width of the resulting image to 1024 pixels.
- A black box indicates that the class' documentation is currently shown.
- A dark blue arrow indicates an include relation (for the include dependency graph) or public inheritance (for the other graphs).
- A dark green arrow indicates protected inheritance.
- A dark red arrow indicates private inheritance.
- A purple dashed arrow indicates a "usage" relation, the edge of the arrow is labeled with the variable(s) responsible for the relation. Class `A` uses class `B`, if class `A` has a member variable `m` of type C, where B is a subtype of C (e.g. C could be B, B*, T<B>*).

The elements in the directory dependency graphs have the following meaning:

- A box with a bold border indicates the directory that the directory dependency graph has been generated for.
- A box with a red solid border indicates a directory whose subdirectories are not shown in the graph ("truncated"). To configure the depth of subdirectories that are shown in the graph see DIR_GRAPH_MAX_DEPTH.
- A box with a red dashed border indicates a truncated directory whose parent directories are not shown in the graph either.
- A box with a dashed border other than red indicates that not all but at least one subdirectory are shown.
- A box with a light gray border indicates a directory with both of the following two attributes:
  - Its parent directory is not shown.
  - At least one subdirectory is shown.
- A box with no background color indicates a directory which is not a subdirectory of the origin's parent directories which are shown. The origin is the directory for which the directory dependency graph is shown.
- An arrow between two boxes indicates an include dependency between two directories. The include dependency exists if a file in a directory includes a file of another directory. If a directory that is involved in an include dependency is not shown in the graph, the arrow is attached to the first parent directory that is shown. This parent directory is shown as truncated (see above).

Here are a couple of header files that together show the various diagrams that Doxygen can generate:

`diagrams_a.h`

#ifndef DIAGRAMS_A_H
#define DIAGRAMS_A_H
class A { public: A *m_self; };
#endif

`diagrams_b.h`

#ifndef DIAGRAMS_B_H
#define DIAGRAMS_B_H
class A;
class B { public: A *m_a; };
#endif

`diagrams_c.h`

#ifndef DIAGRAMS_C_H
#define DIAGRAMS_C_H
#include "diagrams_c.h"
class D;
class C : public A { public: D *m_d; };
#endif

`diagrams_d.h`

#ifndef DIAGRAM_D_H
#define DIAGRAM_D_H
#include "diagrams_a.h"
#include "diagrams_b.h"
class C;
class D : virtual protected A, private B { public: C m_c; };
#endif

`diagrams_e.h`

#ifndef DIAGRAM_E_H
#define DIAGRAM_E_H
#include "diagrams_d.h"
class E : public D {};
#endif

Click here for the corresponding HTML documentation that is generated by Doxygen. Note EXTRACT_ALL `=` `YES` is used to generate the diagrams.

Go to the next section or return to the index.