📄 user.cfg.in
字号:
GENERATE_AUTOGEN_DEF = NO#---------------------------------------------------------------------------# configuration options related to the Perl module output#---------------------------------------------------------------------------# If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment.GENERATE_PERLMOD = NO# If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output.PERLMOD_LATEX = NO# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. This is useful # if you want to understand what is going on. On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same.PERLMOD_PRETTY = YES# The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables.PERLMOD_MAKEVAR_PREFIX = #---------------------------------------------------------------------------# Configuration options related to the preprocessor #---------------------------------------------------------------------------# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files.ENABLE_PREPROCESSING = YES# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES.MACRO_EXPANSION = YES# 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_PREDEFINED tags.EXPAND_ONLY_PREDEF = YES# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found.SEARCH_INCLUDES = YES# The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor.INCLUDE_PATH = # 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 # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used.INCLUDE_FILE_PATTERNS = # 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 # 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.PREDEFINED = __GTHREADS \ _GLIBCXX_STD=std \ _GLIBCXX_DEPRECATED \ _GLIBCXX_USE_WCHAR_T \ _GLIBCXX_USE_LONG_LONG \ __glibcxx_class_requires=// \ __glibcxx_class_requires2=// \ __glibcxx_class_requires3=// \ __glibcxx_class_requires4=//# 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.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#---------------------------------------------------------------------------# Configuration::additions related to external references #---------------------------------------------------------------------------# 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.TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads.GENERATE_TAGFILE = @generate_tagfile@# 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.ALLEXTERNALS = YES# 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# The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl').PERL_PATH = /usr/bin/perl#---------------------------------------------------------------------------# 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 = YES# 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 = NO# 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.CLASS_GRAPH = YES# 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.COLLABORATION_GRAPH = NO# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependenciesGROUP_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# 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.INCLUDE_GRAPH = NO# 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.INCLUDED_BY_GRAPH = NO# 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# 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.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# 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.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).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.MAX_DOT_GRAPH_WIDTH = 1024# 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.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# 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.GENERATE_LEGEND = NO# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs.DOT_CLEANUP = YES#---------------------------------------------------------------------------# Configuration::additions related to the search engine #---------------------------------------------------------------------------# 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.SEARCHENGINE = NO
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -