📄 doxyfile
字号:
# Doxyfile 1.5.1PROJECT_NAME = "MP View"PROJECT_NUMBER =OUTPUT_DIRECTORY =CREATE_SUBDIRS = NOOUTPUT_LANGUAGE = EnglishUSE_WINDOWS_ENCODING = NO# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will# include brief member descriptions after the members that are listed in# the file and class documentation (similar to JavaDoc).# Set to NO to disable this.BRIEF_MEMBER_DESC = YES# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend# the brief description of a member or function before the detailed description.# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the# brief descriptions will be completely suppressed.REPEAT_BRIEF = YES# This tag implements a quasi-intelligent brief description abbreviator# that is used to form the text in various listings. Each string# in this list, if found as the leading text of the brief description, will be# stripped from the text and the result after processing the whole list, is# used as the annotated text. Otherwise, the brief description is used as-is.# If left blank, the following values are used ("$name" is automatically# replaced with the name of the entity): "The $name class" "The $name widget"# "The $name file" "is" "provides" "specifies" "contains"# "represents" "a" "an" "the"ABBREVIATE_BRIEF =# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then# Doxygen will generate a detailed section even if there is only a brief# description.ALWAYS_DETAILED_SEC = NO# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all# inherited members of a class in the documentation of that class as if those# members were ordinary class members. Constructors, destructors and assignment# operators of the base classes will not be shown.INLINE_INHERITED_MEMB = NO# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full# path before files name in the file list and in the header files. If set# to NO the shortest path that makes the file name unique will be used.FULL_PATH_NAMES = YES# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag# can be used to strip a user-defined part of the path. Stripping is# only done if one of the specified strings matches the left-hand part of# the path. The tag can be used to show relative paths in the file list.# If left blank the directory from which doxygen is run is used as the# path to strip.STRIP_FROM_PATH = ../src# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of# the path mentioned in the documentation of a class, which tells# the reader which header file to include in order to use a class.# If left blank only the name of the header file containing the class# definition is used. Otherwise one should specify the include paths that# are normally passed to the compiler using the -I flag.STRIP_FROM_INC_PATH =# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter# (but less readable) file names. This can be useful is your file systems# doesn't support long names like on DOS, Mac, or CD-ROM.SHORT_NAMES = NO# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen# will interpret the first line (until the first dot) of a JavaDoc-style# comment as the brief description. If set to NO, the JavaDoc# comments will behave just like the Qt-style comments (thus requiring an# explicit @brief command for a brief description.JAVADOC_AUTOBRIEF = NO# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen# treat a multi-line C++ special comment block (i.e. a block of //! or ///# comments) as a brief description. This used to be the default behaviour.# The new default is to treat a multi-line C++ comment block as a detailed# description. Set this tag to YES if you prefer the old behaviour instead.MULTILINE_CPP_IS_BRIEF = NO# If the DETAILS_AT_TOP tag is set to YES then Doxygen# will output the detailed description near the top, like JavaDoc.# If set to NO, the detailed description appears after the member# documentation.DETAILS_AT_TOP = NO# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented# member inherits the documentation from any documented member that it# re-implements.INHERIT_DOCS = YES# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce# a new page for each member. If set to NO, the documentation of a member will# be part of the file/class/namespace that contains it.SEPARATE_MEMBER_PAGES = NO# The TAB_SIZE tag can be used to set the number of spaces in a tab.# Doxygen uses this value to replace tabs by spaces in code fragments.TAB_SIZE = 8# This tag can be used to specify a number of aliases that acts# as commands in the documentation. An alias has the form "name=value".# For example adding "sideeffect=\par Side Effects:\n" will allow you to# put the command \sideeffect (or @sideeffect) in the documentation, which# will result in a user-defined paragraph with heading "Side Effects:".# You can put \n's in the value part of an alias to insert newlines.ALIASES =# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C# sources only. Doxygen will then generate output that is more tailored for C.# For instance, some of the names that are used will be different. The list# of all members will be omitted, etc.OPTIMIZE_OUTPUT_FOR_C = NO# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java# sources only. Doxygen will then generate output that is more tailored for Java.# For instance, namespaces will be presented as packages, qualified scopes# will look different, etc.OPTIMIZE_OUTPUT_JAVA = NO# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to# include (a tag file for) the STL sources as input, then you should# set this tag to YES in order to let doxygen match functions declarations and# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.# func(std::string) {}). This also make the inheritance and collaboration# diagrams that involve STL classes more complete and accurate.BUILTIN_STL_SUPPORT = NO# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC# tag is set to YES, then doxygen will reuse the documentation of the first# member in the group (if any) for the other members of the group. By default# all members of a group must be documented explicitly.DISTRIBUTE_GROUP_DOC = NO# Set the SUBGROUPING tag to YES (the default) to allow class member groups of# the same type (for instance a group of public functions) to be put as a# subgroup of that type (e.g. under the Public Functions section). Set it to# NO to prevent subgrouping. Alternatively, this can be done per class using# the \nosubgrouping command.SUBGROUPING = YES#---------------------------------------------------------------------------# Build related configuration options#---------------------------------------------------------------------------# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in# documentation are documented, even if no documentation was available.# Private class members and static file members will be hidden unless# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YESEXTRACT_ALL = NO# If the EXTRACT_PRIVATE tag is set to YES all private members of a class# will be included in the documentation.EXTRACT_PRIVATE = YES# If the EXTRACT_STATIC tag is set to YES all static members of a file# will be included in the documentation.EXTRACT_STATIC = YES# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)# defined locally in source files will be included in the documentation.# If set to NO only classes defined in header files are included.EXTRACT_LOCAL_CLASSES = YES# This flag is only useful for Objective-C code. When set to YES local# methods, which are defined in the implementation section but not in# the interface are included in the documentation.# If set to NO (the default) only methods in the interface are included.EXTRACT_LOCAL_METHODS = YES# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all# undocumented members of documented classes, files or namespaces.# If set to NO (the default) these members will be included in the# various overviews, but no documentation section is generated.# This option has no effect if EXTRACT_ALL is enabled.HIDE_UNDOC_MEMBERS = NO# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all# undocumented classes that are normally visible in the class hierarchy.# If set to NO (the default) these classes will be included in the various# overviews. This option has no effect if EXTRACT_ALL is enabled.HIDE_UNDOC_CLASSES = NO# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all# friend (class|struct|union) declarations.# If set to NO (the default) these declarations will be included in the# documentation.HIDE_FRIEND_COMPOUNDS = NO# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any# documentation blocks found inside the body of a function.# If set to NO (the default) these blocks will be appended to the# function's detailed documentation block.HIDE_IN_BODY_DOCS = NO# The INTERNAL_DOCS tag determines if documentation# that is typed after a \internal command is included. If the tag is set# to NO (the default) then the documentation will be excluded.# Set it to YES to include the internal documentation.INTERNAL_DOCS = NO# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate# file names in lower-case letters. If set to YES upper-case letters are also# allowed. This is useful if you have classes or files whose names only differ# in case and if your file system supports case sensitive file names. Windows# and Mac users are advised to set this option to NO.CASE_SENSE_NAMES = YES# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen# will show members with their full class and namespace scopes in the# documentation. If set to YES the scope will be hidden.HIDE_SCOPE_NAMES = NO# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen# will put a list of the files that are included by a file in the documentation# of that file.SHOW_INCLUDE_FILES = YES# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]# is inserted in the documentation for inline members.INLINE_INFO = YES# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen# will sort the (detailed) documentation of file and class members# alphabetically by member name. If set to NO the members will appear in# declaration order.SORT_MEMBER_DOCS = YES# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the# brief documentation of file, namespace and class members alphabetically# by member name. If set to NO (the default) the members will appear in# declaration order.SORT_BRIEF_DOCS = NO# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be# sorted by fully-qualified names, including namespaces. If set to# NO (the default), the class list will be sorted only by class name,# not including the namespace part.# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.# Note: This option applies only to the class list, not to the# alphabetical list.SORT_BY_SCOPE_NAME = NO# The GENERATE_TODOLIST tag can be used to enable (YES) or# disable (NO) the todo list. This list is created by putting \todo# commands in the documentation.GENERATE_TODOLIST = YES# The GENERATE_TESTLIST tag can be used to enable (YES) or# disable (NO) the test list. This list is created by putting \test# commands in the documentation.GENERATE_TESTLIST = YES# The GENERATE_BUGLIST tag can be used to enable (YES) or# disable (NO) the bug list. This list is created by putting \bug# commands in the documentation.GENERATE_BUGLIST = YES# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or# disable (NO) the deprecated list. This list is created by putting# \deprecated commands in the documentation.GENERATE_DEPRECATEDLIST= YES# The ENABLED_SECTIONS tag can be used to enable conditional# documentation sections, marked by \if sectionname ... \endif.ENABLED_SECTIONS =# The MAX_INITIALIZER_LINES tag determines the maximum number of lines# the initial value of a variable or define consists of for it to appear in# the documentation. If the initializer consists of more lines than specified# here it will be hidden. Use a value of 0 to hide initializers completely.# The appearance of the initializer of individual variables and defines in the# documentation can be controlled using \showinitializer or \hideinitializer# command in the documentation regardless of this setting.MAX_INITIALIZER_LINES = 30# Set the SHOW_USED_FILES tag to NO to disable the list of files generated# at the bottom of the documentation of classes and structs. If set to YES the# list will mention the files that were used to generate the documentation.SHOW_USED_FILES = YES# If the sources in your project are distributed over multiple directories# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy# in the documentation. The default is NO.SHOW_DIRECTORIES = NO# The FILE_VERSION_FILTER tag can be used to specify a program or script that# doxygen should invoke to get the current version for each file (typically from the# version control system). Doxygen will invoke the program by executing (via# popen()) the command <command> <input-file>, where <command> is the value of# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file# provided by doxygen. Whatever the program writes to standard output# is used as the file version. See the manual for examples.FILE_VERSION_FILTER =#---------------------------------------------------------------------------# configuration options related to warning and progress messages#---------------------------------------------------------------------------# The QUIET tag can be used to turn on/off the messages that are generated# by doxygen. Possible values are YES and NO. If left blank NO is used.QUIET = NO# The WARNINGS tag can be used to turn on/off the warning messages that are# generated by doxygen. Possible values are YES and NO. If left blank# NO is used.WARNINGS = YES# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings# for undocumented members. If EXTRACT_ALL is set to YES then this flag will# automatically be disabled.
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -