?? cimg_documentation.doxygen
字號:
# 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 = NO# 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 = NO# 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 = NO# 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 = NO# 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= NO# 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 = 100# 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 = NO# 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 YES.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.WARN_IF_UNDOCUMENTED = NO# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for# potential errors in the documentation, such as not documenting some# parameters in a documented function, or documenting parameters that# don't exist or using markup commands wrongly.WARN_IF_DOC_ERROR = YES# This WARN_NO_PARAMDOC option can be abled to get warnings for# functions that are documented, but have no documentation for their parameters# or return value. If set to NO (the default) doxygen will only warn about# wrong or incomplete parameter documentation, but not about the absence of# documentation.WARN_NO_PARAMDOC = NO# The WARN_FORMAT tag determines the format of the warning messages that# doxygen can produce. The string should contain the $file, $line, and $text# tags, which will be replaced by the file and line number from which the# warning originated and the warning text. Optionally the format may contain# $version, which will be replaced by the version of the file (if it could# be obtained via FILE_VERSION_FILTER)WARN_FORMAT = "$file:$line: $text"# The WARN_LOGFILE tag can be used to specify a file to which warning# and error messages should be written. If left blank the output is written# to stderr.WARN_LOGFILE =#---------------------------------------------------------------------------# configuration options related to the input files#---------------------------------------------------------------------------# The INPUT tag can be used to specify the files and/or directories that contain# documented source files. You may enter file names like "myfile.cpp" or# directories like "/usr/src/myproject". Separate the files or directories# with spaces.INPUT = CImg_documentation.h# If the value of the INPUT tag contains directories, you can use the# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp# and *.h) to filter out the source-files in the directories. If left# blank the following patterns are tested:# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.pyFILE_PATTERNS =# The RECURSIVE tag can be used to turn specify whether or not subdirectories# should be searched for input files as well. Possible values are YES and NO.# If left blank NO is used.RECURSIVE = NO# The EXCLUDE tag can be used to specify files and/or directories that should# excluded from the INPUT source files. This way you can easily exclude a# subdirectory from a directory tree whose root is specified with the INPUT tag.EXCLUDE =# The EXCLUDE_SYMLINKS tag can be used select whether or not files or# directories that are symbolic links (a Unix filesystem feature) are excluded# from the input.EXCLUDE_SYMLINKS = NO# If the value of the INPUT tag contains directories, you can use the# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude# certain files from those directories. Note that the wildcards are matched# against the file with absolute path, so to exclude all test directories# for example use the pattern */test/*EXCLUDE_PATTERNS =# The EXAMPLE_PATH tag can be used to specify one or more files or# directories that contain example code fragments that are included (see# the \include command).EXAMPLE_PATH =# If the value of the EXAMPLE_PATH tag contains directories, you can use the# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp# and *.h) to filter out the source-files in the directories. If left# blank all files are included.EXAMPLE_PATTERNS =# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be# searched for input files to be used with the \include or \dontinclude# commands irrespective of the value of the RECURSIVE tag.# Possible values are YES and NO. If left blank NO is used.EXAMPLE_RECURSIVE = NO# The IMAGE_PATH tag can be used to specify one or more files or# directories that contain image that are included in the documentation (see# the \image command).IMAGE_PATH =# The INPUT_FILTER tag can be used to specify a program that doxygen should# invoke to filter for each input file. Doxygen will invoke the filter program# by executing (via popen()) the command <filter> <input-file>, where <filter># is the value of the INPUT_FILTER tag, and <input-file> is the name of an# input file. Doxygen will then use the output that the filter program writes# to standard output. If FILTER_PATTERNS is specified, this tag will be# ignored.INPUT_FILTER =# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern# basis. Doxygen will compare the file name with each pattern and apply the# filter if there is a match. The filters are a list of the form:# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER# is applied to all files.FILTER_PATTERNS =# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using# INPUT_FILTER) will be used to filter the input files when producing source# files to browse (i.e. when SOURCE_BROWSER is set to YES).FILTER_SOURCE_FILES = NO#---------------------------------------------------------------------------# configuration options related to source browsing#---------------------------------------------------------------------------# If the SOURCE_BROWSER tag is set to YES then a list of source files will# be generated. Documented entities will be cross-referenced with these sources.# Note: To get rid of all source code in the generated output, make sure also# VERBATIM_HEADERS is set to NO.SOURCE_BROWSER = NO# Setting the INLINE_SOURCES tag to YES will include the body# of functions and classes directly in the documentation.INLINE_SOURCES = NO# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct# doxygen to hide any special comment blocks from generated source code# fragments. Normal C and C++ comments will always remain visible.STRIP_CODE_COMMENTS = YES# If the REFERENCED_BY_RELATION tag is set to YES (the default)# then for each documented function all documented# functions referencing it will be listed.REFERENCED_BY_RELATION = YES# If the REFERENCES_RELATION tag is set to YES (the default)# then for each documented function all documented entities# called/used by that function will be listed.REFERENCES_RELATION = YES# If the USE_HTAGS tag is set to YES then the references to source code# will point to the HTML generated by the htags(1) tool instead of doxygen# built-in source browser. The htags tool is part of GNU's global source# tagging system (see http://www.gnu.org/software/global/global.html). You# will need version 4.8.6 or higher.USE_HTAGS = NO# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen# will generate a verbatim copy of the header file for each class for# which an include is specified. Set to NO to disable this.VERBATIM_HEADERS = NO#---------------------------------------------------------------------------# configuration options related to the alphabetical class index#---------------------------------------------------------------------------# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index# of all compounds will be generated. Enable this if the project# contains a lot of classes, structs, unions or interfaces.ALPHABETICAL_INDEX = NO# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns# in which this list will be split (can be a number in the range [1..20])COLS_IN_ALPHA_INDEX = 5# In case all classes in a project start with a common prefix, all# classes will be put under the same header in the alphabetical index.# The IGNORE_PREFIX tag can be used to specify one or more prefixes that# should be ignored while generating the index headers.IGNORE_PREFIX =
?? 快捷鍵說明
復(fù)制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -