Skip to content
Snippets Groups Projects
Doxyfile 104 KiB
Newer Older
  • Learn to ignore specific revisions
  • Campbell Barton's avatar
    Campbell Barton committed
    # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
    # the macro expansion is limited to the macros specified with the PREDEFINED and
    # EXPAND_AS_DEFINED tags.
    # The default value is: NO.
    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # If the SEARCH_INCLUDES tag is set to YES, the include files in the
    # INCLUDE_PATH will be searched if a #include is found.
    # The default value is: YES.
    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    
    # The INCLUDE_PATH tag can be used to specify one or more directories that
    
    Campbell Barton's avatar
    Campbell Barton committed
    # contain include files that are not input files but should be processed by the
    # preprocessor.
    # This tag requires that the tag SEARCH_INCLUDES is set to YES.
    
    INCLUDE_PATH           = ../../source/blender/nodes \
                             ../../source/blender/editors/include
    
    # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    # patterns (like *.h and *.hpp) to filter out the header-files in the
    
    Campbell Barton's avatar
    Campbell Barton committed
    # directories. If left blank, the patterns specified with FILE_PATTERNS will be
    # used.
    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # The PREDEFINED tag can be used to specify one or more macro names that are
    # defined before the preprocessor is started (similar to the -D option of e.g.
    # gcc). The argument of the tag is a list of macros of the form: name or
    # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
    # is assumed. To prevent a macro definition from being undefined via #undef or
    # recursively expanded use the := operator instead of the = operator.
    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    
    PREDEFINED             = BUILD_DATE
    
    Campbell Barton's avatar
    Campbell Barton committed
    # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
    # tag can be used to specify a list of macro names that should be expanded. The
    # macro definition that is found in the sources will be used. Use the PREDEFINED
    # tag if you want to use a different macro definition that overrules the
    # definition found in the source code.
    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
    # remove all references to function-like macros that are alone on a line, have
    # an all uppercase name, and do not end with a semicolon. Such function macros
    # are typically used for boiler-plate code, and will confuse the parser if not
    # removed.
    # The default value is: YES.
    # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    
    
    SKIP_FUNCTION_MACROS   = YES
    
    #---------------------------------------------------------------------------
    
    Campbell Barton's avatar
    Campbell Barton committed
    # Configuration options related to external references
    
    #---------------------------------------------------------------------------
    
    
    Campbell Barton's avatar
    Campbell Barton committed
    # The TAGFILES tag can be used to specify one or more tag files. For each tag
    # file the location of the external documentation should be added. The format of
    # a tag file without this location is as follows:
    
    # TAGFILES = file1 file2 ...
    # Adding location for the tag files is done as follows:
    # TAGFILES = file1=loc1 "file2 = loc2" ...
    
    Campbell Barton's avatar
    Campbell Barton committed
    # where loc1 and loc2 can be relative or absolute paths or URLs. See the
    # section "Linking to external documentation" for more information about the use
    # of tag files.
    # Note: Each tag file must have a unique name (where the name does NOT include
    # the path). If a tag file is not located in the directory in which doxygen is
    # run, you must also specify the path to the tagfile here.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
    # tag file that is based on the input files it reads. See section "Linking to
    # external documentation" for more information about the usage of tag files.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
    # the class index. If set to NO, only the inherited external classes will be
    # listed.
    # The default value is: NO.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
    # in the modules index. If set to NO, only the current project's groups will be
    # listed.
    # The default value is: YES.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
    # the related pages index. If set to NO, only the current project's pages will
    # be listed.
    # The default value is: YES.
    
    
    EXTERNAL_PAGES         = YES
    
    # The PERL_PATH should be the absolute path and name of the perl script
    
    Campbell Barton's avatar
    Campbell Barton committed
    # interpreter (i.e. the result of 'which perl').
    # The default file (with absolute path) is: /usr/bin/perl.
    
    
    PERL_PATH              = /usr/bin/perl
    
    #---------------------------------------------------------------------------
    
    # Configuration options related to the dot tool
    
    #---------------------------------------------------------------------------
    
    
    Campbell Barton's avatar
    Campbell Barton committed
    # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
    # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
    # NO turns the diagrams off. Note that this option also works with HAVE_DOT
    # disabled, but it is recommended to install and use dot, since it yields more
    # powerful graphs.
    # The default value is: YES.
    
    # You can define message sequence charts within doxygen comments using the \msc
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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
    
    Campbell Barton's avatar
    Campbell Barton committed
    # You can include diagrams made with dia in doxygen documentation. Doxygen will
    # then run dia to produce the diagram and insert it in the documentation. The
    # DIA_PATH tag allows you to specify the directory where the dia binary resides.
    # If left empty dia is assumed to be found in the default search path.
    
    Campbell Barton's avatar
    Campbell Barton committed
    DIA_PATH               =
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    HIDE_UNDOC_RELATIONS   = YES
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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               = NO
    
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # When you want a differently looking font in 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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
    
    Campbell Barton's avatar
    Campbell Barton committed
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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. Disabling a call graph can be
    # accomplished by means of the command \hidecallgraph.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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. Disabling a caller graph can be
    # accomplished by means of the command \hidecallergraph.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # The default value is: NO.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    
    # generated by dot. For an explanation of the image formats see the section
    # output formats in the documentation of the dot tool (Graphviz (see:
    # http://www.graphviz.org/)).
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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, svg, png:gd, png:gd:gd, png:cairo,
    # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
    # png:gdiplus:gdiplus.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # The default value is: png.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    #
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    # The DOTFILE_DIRS tag can be used to specify one or more directories that
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    # The MSCFILE_DIRS tag can be used to specify one or more directories that
    
    Campbell Barton's avatar
    Campbell Barton committed
    # contain msc files that are included in the documentation (see the \mscfile
    # command).
    
    Campbell Barton's avatar
    Campbell Barton committed
    # The DIAFILE_DIRS tag can be used to specify one or more directories that
    # contain dia files that are included in the documentation (see the \diafile
    # command).
    
    DIAFILE_DIRS           =
    
    # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
    # path where java can find the plantuml.jar file. If left blank, it is assumed
    # PlantUML is not used or called during a preprocessing step. Doxygen will
    # generate a warning when it encounters a \startuml command in this case and
    # will not generate output for the diagram.
    
    PLANTUML_JAR_PATH      =
    
    # When using plantuml, the specified paths are searched for files specified by
    # the !include statement in a plantuml block.
    
    PLANTUML_INCLUDE_PATH  =
    
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # Minimum value: 0, maximum value: 1000, default value: 0.
    # This tag requires that the tag HAVE_DOT is set to YES.
    
    # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
    
    # files in one run (i.e. multiple -o and -T options on the command line). This
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.
    
    Campbell Barton's avatar
    Campbell Barton committed
    # 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.