Skip to content
Snippets Groups Projects
Doxyfile-library 96.5 KiB
Newer Older
  • Learn to ignore specific revisions
  • # The default value is: YES.
    
    CLASS_DIAGRAMS         = YES
    
    # You can define message sequence charts within doxygen comments using the \msc
    # command. Doxygen will then run the mscgen tool (see:
    # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
    # documentation. The MSCGEN_PATH tag allows you to specify the directory where
    # the mscgen tool resides. If left empty the tool is assumed to be found in the
    # default search path.
    
    MSCGEN_PATH            =
    
    # If set to YES, the inheritance and collaboration graphs will hide inheritance
    # and usage relations if the target is undocumented or is not a class.
    # The default value is: YES.
    
    HIDE_UNDOC_RELATIONS   = YES
    
    # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
    # available from the path. This tool is part of Graphviz (see:
    # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
    # Bell Labs. The other options in this section have no effect if this option is
    # set to NO
    # The default value is: NO.
    
    HAVE_DOT               = YES
    
    # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
    # to run in parallel. When set to 0 doxygen will base this on the number of
    # processors available in the system. You can set it explicitly to a value
    # larger than 0 to get control over the balance between CPU load and processing
    # speed.
    # Minimum value: 0, maximum value: 32, default value: 0.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_NUM_THREADS        = 0
    
    # When you want a differently looking font n the dot files that doxygen
    # generates you can specify the font name using DOT_FONTNAME. You need to make
    # sure dot is able to find the font, which can be done by putting it in a
    # standard location or by setting the DOTFONTPATH environment variable or by
    # setting DOT_FONTPATH to the directory containing the font.
    # The default value is: Helvetica.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_FONTNAME           = Helvetica
    
    # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
    # dot graphs.
    # Minimum value: 4, maximum value: 24, default value: 10.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_FONTSIZE           = 10
    
    # By default doxygen will tell dot to use the default font as specified with
    # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
    # the path where dot can find it using this tag.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_FONTPATH           =
    
    # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
    # each documented class showing the direct and indirect inheritance relations.
    # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    CLASS_GRAPH            = YES
    
    # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate 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.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    COLLABORATION_GRAPH    = YES
    
    # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
    # groups, showing the direct groups dependencies.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    GROUP_GRAPHS           = YES
    
    # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
    # collaboration diagrams in a style similar to the OMG's Unified Modeling
    # Language.
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    UML_LOOK               = NO
    
    # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
    # class node. If there are many fields or methods and many nodes the graph may
    # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
    # number of items for each type to make the size more manageable. Set this to 0
    # for no limit. Note that the threshold may be exceeded by 50% before the limit
    # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
    # but if the number exceeds 15, the total amount of fields shown is limited to
    # 10.
    # Minimum value: 0, maximum value: 100, default value: 10.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    UML_LIMIT_NUM_FIELDS   = 10
    
    # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
    # collaboration graphs will show the relations between templates and their
    # instances.
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    TEMPLATE_RELATIONS     = YES
    
    # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
    # YES then doxygen will generate a graph for each documented file showing the
    # direct and indirect include dependencies of the file with other documented
    # files.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    INCLUDE_GRAPH          = YES
    
    # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
    # set to YES then doxygen will generate a graph for each documented file showing
    # the direct and indirect include dependencies of the file with other documented
    # files.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    INCLUDED_BY_GRAPH      = YES
    
    # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
    # dependency graph for every global function or class method.
    #
    # Note that enabling this option will significantly increase the time of a run.
    # So in most cases it will be better to enable call graphs for selected
    # functions only using the \callgraph command.
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    CALL_GRAPH             = YES
    
    # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
    # dependency graph for every global function or class method.
    #
    # Note that enabling this option will significantly increase the time of a run.
    # So in most cases it will be better to enable caller graphs for selected
    # functions only using the \callergraph command.
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    CALLER_GRAPH           = YES
    
    # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
    # hierarchy of all classes instead of a textual one.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    GRAPHICAL_HIERARCHY    = YES
    
    # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
    # dependencies a directory has on other directories in a graphical way. The
    # dependency relations are determined by the #include relations between the
    # files in the directories.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DIRECTORY_GRAPH        = YES
    
    # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    # generated by dot.
    # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
    # to make the SVG files visible in IE 9+ (other browsers do not have this
    # requirement).
    # Possible values are: png, jpg, gif and svg.
    # The default value is: png.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_IMAGE_FORMAT       = png
    
    # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
    # enable generation of interactive SVG images that allow zooming and panning.
    #
    # Note that this requires a modern browser other than Internet Explorer. Tested
    # and working are Firefox, Chrome, Safari, and Opera.
    # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
    # the SVG files visible. Older versions of IE do not have SVG support.
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    INTERACTIVE_SVG        = NO
    
    # The DOT_PATH tag can be used to specify the path where the dot tool can be
    # found. If left blank, it is assumed the dot tool can be found in the path.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_PATH               =
    
    # The DOTFILE_DIRS tag can be used to specify one or more directories that
    # contain dot files that are included in the documentation (see the \dotfile
    # command).
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOTFILE_DIRS           =
    
    # The MSCFILE_DIRS tag can be used to specify one or more directories that
    # contain msc files that are included in the documentation (see the \mscfile
    # command).
    
    MSCFILE_DIRS           =
    
    # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
    # that will be shown in the graph. If the number of nodes in a graph becomes
    # larger than this value, doxygen will truncate the graph, which is visualized
    # by representing a node as a red box. Note that doxygen if the number of direct
    # children of the root node in a graph is already larger than
    # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
    # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
    # Minimum value: 0, maximum value: 10000, default value: 50.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_GRAPH_MAX_NODES    = 50
    
    # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
    # generated by dot. A depth value of 3 means that only nodes reachable from the
    # root by following a path via at most 3 edges will be shown. Nodes that lay
    # further from the root node will be omitted. Note that setting this option to 1
    # or 2 may greatly reduce the computation time needed for large code bases. Also
    # note that the size of a graph can be further restricted by
    # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    # Minimum value: 0, maximum value: 1000, default value: 0.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    MAX_DOT_GRAPH_DEPTH    = 0
    
    # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    # background. This is disabled by default, because dot on Windows does not seem
    # to support this out of the box.
    #
    # Warning: Depending on the platform used, enabling this option may lead to
    # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
    # read).
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_TRANSPARENT        = NO
    
    # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
    # files in one run (i.e. multiple -o and -T options on the command line). This
    # makes dot run faster, but since only newer versions of dot (>1.8.10) support
    # this, this feature is disabled by default.
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_MULTI_TARGETS      = NO
    
    # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
    # explaining the meaning of the various boxes and arrows in the dot generated
    # graphs.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    GENERATE_LEGEND        = YES
    
    # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
    # files that are used to generate the various graphs.
    # The default value is: YES.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    DOT_CLEANUP            = YES