The options DOT_GRAPH_MAX_NODES and MAX_DOT_GRAPH_DEPTH can be used to limit the size of the various graphs. Using a layout file you can determine which of the graphs are actually shown. Include dependencies between the directories are shown as arrows. The depth of the graph is configured through DIR_GRAPH_MAX_DEPTH. Subdirectories are shown nested into the box of its parent directory. The graph will show directories as boxes. If DIRECTORY_GRAPH is set to YES, doxygen will generate graphs that show the directory dependencies for every directory. 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 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). class A has a member variable m_a of type class B, then A has an arrow to B with m_a as label). The usage relations with other structs and classes (e.g. The inheritance relations with base classes. This feature is currently supported for HTML and RTF only.Īn inverse include dependency graph is also generated showing for a (header) file, which other files include it.Ī graph is drawn for each documented class and struct that shows: This disables the generation of the built-in class inheritance diagrams.Īn include dependency graph is generated for each documented file that includes at least one other file. 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.Īn inheritance graph will be generated for each documented class showing the direct and indirect inheritance relations. Currently this feature is supported for HTML only. If you have the "dot" tool in the path, you can set HAVE_DOT to YES in the configuration file to let doxygen use it.ĭoxygen uses the "dot" tool to generate the following graphs:Ī graphical representation of the class hierarchy will be drawn, along with the textual one. Graphviz is an open-source, cross-platform graph drawing toolkit and can be found at If false - inserts the file generated by GraphViz directly into the document (may be handy for svg images).Doxygen has built-in support to generate inheritance diagrams for C++ classes.ĭoxygen can use the "dot" tool from graphviz to generate more advanced diagrams and graphs. Default: png as_image If true - inserts scheme into document as md-image. Default: dot format Output format of the diagram image. Available engines: ( circo, dot, fdp, neato, osage, patchwork, sfdp twopi). engine Layout engine used to process the diagram source. By default, it is assumed that you have the dot command in your PATH, but if Graphviz uses another command to launch, or if the dot launcher is installed in a custom place, you can define it here. The generated images are cached and reused in future builds. To save time during build, only new and modified diagrams are rendered. It can be a path relative to the project root or a global one you can use ~/ shortcut. cache_dir Path to the directory with the generated diagrams.
diagramscache graphviz_path : dot engine : dot format : png as_image : true params. Preprocessors : - graphviz : cache_dir : !path.
Graphviz Diagrams Preprocessor for Foliant
0 kommentar(er)
