Skip to content
Snippets Groups Projects
asterisk-ng-doxygen 49.1 KiB
Newer Older
  • Learn to ignore specific revisions
  • # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
    
    Mark Spencer's avatar
    Mark Spencer committed
    # 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.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    EXPAND_AS_DEFINED      = 
    
    # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
    # doxygen's preprocessor will remove all 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.
    
    SKIP_FUNCTION_MACROS   = YES
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    #---------------------------------------------------------------------------
    
    # Configuration::additions related to external references   
    
    Mark Spencer's avatar
    Mark Spencer committed
    #---------------------------------------------------------------------------
    
    # The TAGFILES option can be used to specify one or more tagfiles. 
    # Optionally an initial location of the external documentation 
    # can be added for each tagfile. 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" ... 
    # where "loc1" and "loc2" can be relative or absolute paths or 
    # URLs. If a location is present for each tag, the installdox tool 
    # does not have to be run to correct the links.
    # Note that 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.
    
    Mark Spencer's avatar
    Mark Spencer committed
    TAGFILES               = 
    
    Mark Spencer's avatar
    Mark Spencer 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.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    GENERATE_TAGFILE       = 
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
    # in the class index. If set to NO only the inherited external classes 
    # will be listed.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    ALLEXTERNALS           = NO
    
    # 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.
    
    EXTERNAL_GROUPS        = YES
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    # The PERL_PATH should be the absolute path and name of the perl script 
    # interpreter (i.e. the result of `which perl').
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    PERL_PATH              = /usr/bin/perl
    
    Mark Spencer's avatar
    Mark Spencer committed
    #---------------------------------------------------------------------------
    # Configuration options related to the dot tool   
    #---------------------------------------------------------------------------
    
    # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
    # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
    # or super classes. Setting the tag to NO turns the diagrams off. Note that 
    # this option is superseded by the HAVE_DOT option below. This is only a 
    # fallback. It is recommended to install and use dot, since it yields more 
    # powerful graphs.
    
    CLASS_DIAGRAMS         = NO
    
    # 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.
    
    HIDE_UNDOC_RELATIONS   = YES
    
    
    Mark Spencer's avatar
    Mark Spencer 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, 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)
    
    HAVE_DOT               = YES
    
    # If the CLASS_GRAPH and HAVE_DOT tags are 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 
    # the CLASS_DIAGRAMS tag to NO.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    CLASS_GRAPH            = YES
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    # If the COLLABORATION_GRAPH and HAVE_DOT tags are 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.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    COLLABORATION_GRAPH    = YES
    
    # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
    # will generate a graph for groups, showing the direct groups dependencies
    
    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.
    
    UML_LOOK               = NO
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    # If set to YES, the inheritance and collaboration graphs will show the 
    # relations between templates and their instances.
    
    TEMPLATE_RELATIONS     = YES
    
    # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
    # 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.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    INCLUDE_GRAPH          = YES
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
    # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
    # documented header file showing the documented files that directly or 
    # indirectly include this file.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    INCLUDED_BY_GRAPH      = YES
    
    # If the CALL_GRAPH and HAVE_DOT tags are 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.
    
    CALL_GRAPH             = NO
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
    # will graphical hierarchy of all classes instead of a textual one.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    GRAPHICAL_HIERARCHY    = YES
    
    # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are 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.
    
    DIRECTORY_GRAPH        = YES
    
    # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
    # generated by dot. Possible values are png, jpg, or gif
    # If left blank png will be used.
    
    DOT_IMAGE_FORMAT       = png
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    # The tag DOT_PATH 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.
    
    Mark Spencer's avatar
    Mark Spencer committed
    DOT_PATH               = 
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    # 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).
    
    DOTFILE_DIRS           = 
    
    # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
    # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
    # this value, doxygen will try to truncate the graph, so that it fits within 
    # the specified constraint. Beware that most browsers cannot cope with very 
    # large images.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    MAX_DOT_GRAPH_WIDTH    = 1024
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
    # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
    # this value, doxygen will try to truncate the graph, so that it fits within 
    # the specified constraint. Beware that most browsers cannot cope with very 
    # large images.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    MAX_DOT_GRAPH_HEIGHT   = 1024
    
    # 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 a graph may be further truncated if the graph's 
    # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
    # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
    # the graph is not depth-constrained.
    
    MAX_DOT_GRAPH_DEPTH    = 0
    
    # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
    # background. This is disabled by default, which results in a white background. 
    # 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).
    
    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.
    
    DOT_MULTI_TARGETS      = NO
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
    # generate a legend page explaining the meaning of the various boxes and 
    # arrows in the dot generated graphs.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    GENERATE_LEGEND        = YES
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
    
    # remove the intermediate dot files that are used to generate 
    
    Mark Spencer's avatar
    Mark Spencer committed
    # the various graphs.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    DOT_CLEANUP            = YES
    
    Mark Spencer's avatar
    Mark Spencer committed
    #---------------------------------------------------------------------------
    
    # Configuration::additions related to the search engine   
    
    Mark Spencer's avatar
    Mark Spencer committed
    #---------------------------------------------------------------------------
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    # The SEARCHENGINE tag specifies whether or not a search engine should be 
    # used. If set to NO the values of all tags below this one will be ignored.
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    SEARCHENGINE           = NO