/docs/doxygen.config
ASP.NET | 2334 lines | 1808 code | 526 blank | 0 comment | 159 complexity | 29e05a1ff9c243352c829fc531908fca MD5 | raw file
Possible License(s): BSD-2-Clause, CC-BY-SA-3.0, LGPL-3.0, LGPL-2.1, JSON, BSD-3-Clause, MPL-2.0-no-copyleft-exception, MIT
Large files files are truncated, but you can click here to view the full file
- # Doxyfile 1.8.5
- # This file describes the settings to be used by the documentation system
- # doxygen (www.doxygen.org) for a project.
- #
- # All text after a double hash (##) is considered a comment and is placed in
- # front of the TAG it is preceding.
- #
- # All text after a single hash (#) is considered a comment and will be ignored.
- # The format is:
- # TAG = value [value, ...]
- # For lists, items can also be appended using:
- # TAG += value [value, ...]
- # Values that contain spaces should be placed between quotes (\" \").
- #---------------------------------------------------------------------------
- # Project related configuration options
- #---------------------------------------------------------------------------
- # This tag specifies the encoding used for all characters in the config file
- # that follow. The default is UTF-8 which is also the encoding used for all text
- # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
- # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
- # for the list of possible encodings.
- # The default value is: UTF-8.
- DOXYFILE_ENCODING = UTF-8
- # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
- # double-quotes, unless you are using Doxywizard) that should identify the
- # project for which the documentation is generated. This name is used in the
- # title of most generated pages and in a few other places.
- # The default value is: My Project.
- PROJECT_NAME = cocos2d-x
- # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
- # could be handy for archiving the generated documentation or if some version
- # control system is used.
- PROJECT_NUMBER = 3.0
- # Using the PROJECT_BRIEF tag one can provide an optional one line description
- # for a project that appears at the top of each page and should give viewer a
- # quick idea about the purpose of the project. Keep the description short.
- PROJECT_BRIEF =
- # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
- # the documentation. The maximum height of the logo should not exceed 55 pixels
- # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
- # to the output directory.
- PROJECT_LOGO =
- # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
- # into which the generated documentation will be written. If a relative path is
- # entered, it will be relative to the location where doxygen was started. If
- # left blank the current directory will be used.
- OUTPUT_DIRECTORY = ./
- # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
- # directories (in 2 levels) under the output directory of each output format and
- # will distribute the generated files over these directories. Enabling this
- # option can be useful when feeding doxygen a huge amount of source files, where
- # putting all generated files in the same directory would otherwise causes
- # performance problems for the file system.
- # The default value is: NO.
- CREATE_SUBDIRS = YES
- # The OUTPUT_LANGUAGE tag is used to specify the language in which all
- # documentation generated by doxygen is written. Doxygen will use this
- # information to generate all constant output in the proper language.
- # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
- # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
- # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
- # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
- # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
- # Turkish, Ukrainian and Vietnamese.
- # The default value is: English.
- OUTPUT_LANGUAGE = English
- # If the BRIEF_MEMBER_DESC tag is set to YES 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.
- # The default value is: YES.
- BRIEF_MEMBER_DESC = YES
- # If the REPEAT_BRIEF tag is set to YES 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.
- # The default value is: YES.
- 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 and the.
- ABBREVIATE_BRIEF = "The $name class" \
- "The $name widget" \
- "The $name file" \
- is \
- provides \
- specifies \
- contains \
- represents \
- a \
- an \
- the
- # 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.
- # The default value is: NO.
- ALWAYS_DETAILED_SEC = YES
- # 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.
- # The default value is: NO.
- INLINE_INHERITED_MEMB = NO
- # If the FULL_PATH_NAMES tag is set to YES 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
- # The default value is: YES.
- FULL_PATH_NAMES = YES
- # 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.
- #
- # Note that you can specify absolute paths here, but also relative paths, which
- # will be relative from the directory where doxygen is started.
- # This tag requires that the tag FULL_PATH_NAMES is set to YES.
- STRIP_FROM_PATH =
- # 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 list of 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.
- # The default value is: NO.
- 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-style will behave just like regular Qt-
- # style comments (thus requiring an explicit @brief command for a brief
- # description.)
- # The default value is: NO.
- JAVADOC_AUTOBRIEF = YES
- # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
- # line (until the first dot) of a Qt-style comment as the brief description. If
- # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
- # requiring an explicit \brief command for a brief description.)
- # The default value is: NO.
- QT_AUTOBRIEF = YES
- # 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 behavior. 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 behavior instead.
- #
- # Note that setting this tag to YES also means that rational rose comments are
- # not recognized any more.
- # The default value is: NO.
- MULTILINE_CPP_IS_BRIEF = NO
- # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
- # documentation from any documented member that it re-implements.
- # The default value is: YES.
- 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.
- # The default value is: NO.
- 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.
- # Minimum value: 1, maximum value: 16, default value: 4.
- TAB_SIZE = 4
- # This tag can be used to specify a number of aliases that act 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 =
- # This tag can be used to specify a number of word-keyword mappings (TCL only).
- # A mapping has the form "name=value". For example adding "class=itcl::class"
- # will allow you to use the command class in the itcl::class meaning.
- TCL_SUBST =
- # 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.
- # The default value is: NO.
- OPTIMIZE_OUTPUT_FOR_C = NO
- # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
- # Python sources only. Doxygen will then generate output that is more tailored
- # for that language. For instance, namespaces will be presented as packages,
- # qualified scopes will look different, etc.
- # The default value is: NO.
- OPTIMIZE_OUTPUT_JAVA = NO
- # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
- # sources. Doxygen will then generate output that is tailored for Fortran.
- # The default value is: NO.
- OPTIMIZE_FOR_FORTRAN = NO
- # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
- # sources. Doxygen will then generate output that is tailored for VHDL.
- # The default value is: NO.
- OPTIMIZE_OUTPUT_VHDL = NO
- # Doxygen selects the parser to use depending on the extension of the files it
- # parses. With this tag you can assign which parser to use for a given
- # extension. Doxygen has a built-in mapping, but you can override or extend it
- # using this tag. The format is ext=language, where ext is a file extension, and
- # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
- # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
- # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
- # (default is Fortran), use: inc=Fortran f=C.
- #
- # Note For files without extension you can use no_extension as a placeholder.
- #
- # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
- # the files are not read by doxygen.
- EXTENSION_MAPPING =
- # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
- # according to the Markdown format, which allows for more readable
- # documentation. See http://daringfireball.net/projects/markdown/ for details.
- # The output of markdown processing is further processed by doxygen, so you can
- # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
- # case of backward compatibilities issues.
- # The default value is: YES.
- MARKDOWN_SUPPORT = YES
- # When enabled doxygen tries to link words that correspond to documented
- # classes, or namespaces to their corresponding documentation. Such a link can
- # be prevented in individual cases by by putting a % sign in front of the word
- # or globally by setting AUTOLINK_SUPPORT to NO.
- # The default value is: YES.
- AUTOLINK_SUPPORT = YES
- # 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);
- # versus func(std::string) {}). This also make the inheritance and collaboration
- # diagrams that involve STL classes more complete and accurate.
- # The default value is: NO.
- BUILTIN_STL_SUPPORT = YES
- # If you use Microsoft's C++/CLI language, you should set this option to YES to
- # enable parsing support.
- # The default value is: NO.
- CPP_CLI_SUPPORT = NO
- # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
- # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
- # will parse them like normal C++ but will assume all classes use public instead
- # of private inheritance when no explicit protection keyword is present.
- # The default value is: NO.
- SIP_SUPPORT = NO
- # For Microsoft's IDL there are propget and propput attributes to indicate
- # getter and setter methods for a property. Setting this option to YES will make
- # doxygen to replace the get and set methods by a property in the documentation.
- # This will only work if the methods are indeed getting or setting a simple
- # type. If this is not the case, or you want to show the methods anyway, you
- # should set this option to NO.
- # The default value is: YES.
- IDL_PROPERTY_SUPPORT = YES
- # 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.
- # The default value is: NO.
- DISTRIBUTE_GROUP_DOC = NO
- # Set the SUBGROUPING tag to YES 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.
- # The default value is: YES.
- SUBGROUPING = YES
- # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
- # are shown inside the group in which they are included (e.g. using \ingroup)
- # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
- # and RTF).
- #
- # Note that this feature does not work in combination with
- # SEPARATE_MEMBER_PAGES.
- # The default value is: NO.
- INLINE_GROUPED_CLASSES = NO
- # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
- # with only public data fields or simple typedef fields will be shown inline in
- # the documentation of the scope in which they are defined (i.e. file,
- # namespace, or group documentation), provided this scope is documented. If set
- # to NO, structs, classes, and unions are shown on a separate page (for HTML and
- # Man pages) or section (for LaTeX and RTF).
- # The default value is: NO.
- INLINE_SIMPLE_STRUCTS = NO
- # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
- # enum is documented as struct, union, or enum with the name of the typedef. So
- # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
- # with name TypeT. When disabled the typedef will appear as a member of a file,
- # namespace, or class. And the struct will be named TypeS. This can typically be
- # useful for C code in case the coding convention dictates that all compound
- # types are typedef'ed and only the typedef is referenced, never the tag name.
- # The default value is: NO.
- TYPEDEF_HIDES_STRUCT = YES
- # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
- # cache is used to resolve symbols given their name and scope. Since this can be
- # an expensive process and often the same symbol appears multiple times in the
- # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
- # doxygen will become slower. If the cache is too large, memory is wasted. The
- # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
- # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
- # symbols. At the end of a run doxygen will report the cache usage and suggest
- # the optimal cache size from a speed point of view.
- # Minimum value: 0, maximum value: 9, default value: 0.
- LOOKUP_CACHE_SIZE = 0
- #---------------------------------------------------------------------------
- # 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 respectively EXTRACT_STATIC tags are set to YES.
- # Note: This will also disable the warnings about undocumented members that are
- # normally produced when WARNINGS is set to YES.
- # The default value is: NO.
- EXTRACT_ALL = YES
- # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
- # be included in the documentation.
- # The default value is: NO.
- EXTRACT_PRIVATE = NO
- # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
- # scope will be included in the documentation.
- # The default value is: NO.
- EXTRACT_PACKAGE = NO
- # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
- # included in the documentation.
- # The default value is: NO.
- EXTRACT_STATIC = NO
- # 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. Does not have any effect
- # for Java sources.
- # The default value is: YES.
- EXTRACT_LOCAL_CLASSES = NO
- # 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 only methods in the interface are
- # included.
- # The default value is: NO.
- EXTRACT_LOCAL_METHODS = NO
- # If this flag is set to YES, the members of anonymous namespaces will be
- # extracted and appear in the documentation as a namespace called
- # 'anonymous_namespace{file}', where file will be replaced with the base name of
- # the file that contains the anonymous namespace. By default anonymous namespace
- # are hidden.
- # The default value is: NO.
- EXTRACT_ANON_NSPACES = NO
- # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
- # undocumented members inside documented classes or files. If set to NO 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.
- # The default value is: NO.
- HIDE_UNDOC_MEMBERS = YES
- # 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 these classes will be included in the various overviews. This option has
- # no effect if EXTRACT_ALL is enabled.
- # The default value is: NO.
- HIDE_UNDOC_CLASSES = YES
- # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
- # (class|struct|union) declarations. If set to NO these declarations will be
- # included in the documentation.
- # The default value is: NO.
- 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 these
- # blocks will be appended to the function's detailed documentation block.
- # The default value is: NO.
- 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 then the documentation
- # will be excluded. Set it to YES to include the internal documentation.
- # The default value is: NO.
- 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.
- # The default value is: system dependent.
- CASE_SENSE_NAMES = NO
- # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
- # their full class and namespace scopes in the documentation. If set to YES the
- # scope will be hidden.
- # The default value is: NO.
- HIDE_SCOPE_NAMES = YES
- # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
- # the files that are included by a file in the documentation of that file.
- # The default value is: YES.
- SHOW_INCLUDE_FILES = YES
- # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
- # files with double quotes in the documentation rather than with sharp brackets.
- # The default value is: NO.
- FORCE_LOCAL_INCLUDES = NO
- # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
- # documentation for inline members.
- # The default value is: YES.
- INLINE_INFO = YES
- # If the SORT_MEMBER_DOCS tag is set to YES 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.
- # The default value is: YES.
- SORT_MEMBER_DOCS = YES
- # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
- # descriptions of file, namespace and class members alphabetically by member
- # name. If set to NO the members will appear in declaration order.
- # The default value is: NO.
- SORT_BRIEF_DOCS = NO
- # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
- # (brief and detailed) documentation of class members so that constructors and
- # destructors are listed first. If set to NO the constructors will appear in the
- # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
- # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
- # member documentation.
- # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
- # detailed member documentation.
- # The default value is: NO.
- SORT_MEMBERS_CTORS_1ST = YES
- # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
- # of group names into alphabetical order. If set to NO the group names will
- # appear in their defined order.
- # The default value is: NO.
- SORT_GROUP_NAMES = 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 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.
- # The default value is: NO.
- SORT_BY_SCOPE_NAME = NO
- # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
- # type resolution of all parameters of a function it will reject a match between
- # the prototype and the implementation of a member function even if there is
- # only one candidate or it is obvious which candidate to choose by doing a
- # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
- # accept a match between prototype and implementation in such cases.
- # The default value is: NO.
- STRICT_PROTO_MATCHING = 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.
- # The default value is: YES.
- 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.
- # The default value is: YES.
- 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.
- # The default value is: YES.
- 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.
- # The default value is: YES.
- GENERATE_DEPRECATEDLIST= YES
- # The ENABLED_SECTIONS tag can be used to enable conditional documentation
- # sections, marked by \if <section_label> ... \endif and \cond <section_label>
- # ... \endcond blocks.
- ENABLED_SECTIONS =
- # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
- # initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be
- # controlled using \showinitializer or \hideinitializer command in the
- # documentation regardless of this setting.
- # Minimum value: 0, maximum value: 10000, default value: 30.
- 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.
- # The default value is: YES.
- SHOW_USED_FILES = YES
- # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
- # will remove the Files entry from the Quick Index and from the Folder Tree View
- # (if specified).
- # The default value is: YES.
- SHOW_FILES = YES
- # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
- # page. This will remove the Namespaces entry from the Quick Index and from the
- # Folder Tree View (if specified).
- # The default value is: YES.
- SHOW_NAMESPACES = YES
- # 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. For an example see the documentation.
- FILE_VERSION_FILTER =
- # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
- # by doxygen. The layout file controls the global structure of the generated
- # output files in an output format independent way. To create the layout file
- # that represents doxygen's defaults, run doxygen with the -l option. You can
- # optionally specify a file name after the option, if omitted DoxygenLayout.xml
- # will be used as the name of the layout file.
- #
- # Note that if you run doxygen from a directory containing a file called
- # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
- # tag is left empty.
- LAYOUT_FILE =
- # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
- # the reference definitions. This must be a list of .bib files. The .bib
- # extension is automatically appended if omitted. This requires the bibtex tool
- # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
- # For LaTeX the style of the bibliography can be controlled using
- # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
- # search path. Do not use file names with spaces, bibtex cannot handle them. See
- # also \cite for info how to create references.
- CITE_BIB_FILES =
- #---------------------------------------------------------------------------
- # Configuration options related to warning and progress messages
- #---------------------------------------------------------------------------
- # The QUIET tag can be used to turn on/off the messages that are generated to
- # standard output by doxygen. If QUIET is set to YES this implies that the
- # messages are off.
- # The default value is: NO.
- QUIET = NO
- # The WARNINGS tag can be used to turn on/off the warning messages that are
- # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
- # this implies that the warnings are on.
- #
- # Tip: Turn warnings on while writing the documentation.
- # The default value is: YES.
- WARNINGS = YES
- # If the WARN_IF_UNDOCUMENTED tag 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.
- # The default value is: YES.
- WARN_IF_UNDOCUMENTED = YES
- # If the WARN_IF_DOC_ERROR tag 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.
- # The default value is: YES.
- WARN_IF_DOC_ERROR = YES
- # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
- # are documented, but have no documentation for their parameters or return
- # value. If set to NO doxygen will only warn about wrong or incomplete parameter
- # documentation, but not about the absence of documentation.
- # The default value is: NO.
- 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)
- # The default value is: $file:$line: $text.
- 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 standard
- # error (stderr).
- WARN_LOGFILE =
- #---------------------------------------------------------------------------
- # Configuration options related to the input files
- #---------------------------------------------------------------------------
- # The INPUT tag is 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.
- # Note: If this tag is empty the current directory is searched.
- INPUT = ../cocos \
- ../cocos/2d/platform \
- ../docs \
- ../extensions \
- ../cocos/scripting/lua/bindings
- # This tag can be used to specify the character encoding of the source files
- # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
- # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
- # documentation (see: http://www.gnu.org/software/libiconv) for the list of
- # possible encodings.
- # The default value is: UTF-8.
- INPUT_ENCODING = UTF-8
- # If the value of the INPUT tag contains directories, you can use the
- # FILE_PATTERNS tag to specify one or more wildcard patterns (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, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
- # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
- # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
- # *.qsf, *.as and *.js.
- FILE_PATTERNS = *.h
- # The RECURSIVE tag can be used to specify whether or not subdirectories should
- # be searched for input files as well.
- # The default value is: NO.
- RECURSIVE = YES
- # The EXCLUDE tag can be used to specify files and/or directories that should be
- # 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.
- #
- # Note that relative paths are relative to the directory from which doxygen is
- # run.
- EXCLUDE = ../cocos2dx/platform/third_party
- # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
- # directories that are symbolic links (a Unix file system feature) are excluded
- # from the input.
- # The default value is: NO.
- 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 = .svn \
- kazmath \
- FontLabel \
- proj.ios \
- data_support \
- image_support \
- zip_support
- # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
- # (namespaces, classes, functions, etc.) that should be excluded from the
- # output. The symbol name can be a fully qualified name, a word, or if the
- # wildcard * is used, a substring. Examples: ANamespace, AClass,
- # AClass::ANamespace, ANamespace::*Test
- #
- # Note that the wildcards are matched against the file with absolute path, so to
- # exclude all test directories use the pattern */test/*
- EXCLUDE_SYMBOLS = ccArray \
- ccCArray
- # 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.
- # The default value is: NO.
- EXAMPLE_RECURSIVE = NO
- # The IMAGE_PATH tag can be used to specify one or more files or directories
- # that contain images that are to be 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.
- #
- # Note that the filter must not add or remove lines; it is applied before the
- # code is scanned, but not when the output code is generated. If lines are added
- # or removed, the anchors will not be placed correctly.
- 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 information on how
- # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
- # patterns match the file name, INPUT_FILTER is applied.
- FILTER_PATTERNS =
- # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
- # INPUT_FILTER ) will also be used to filter the input files that are used for
- # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
- # The default value is: NO.
- FILTER_SOURCE_FILES = NO
- # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
- # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
- # it is also possible to disable source filtering for a specific pattern using
- # *.ext= (so without naming a filter).
- # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
- FILTER_SOURCE_PATTERNS =
- # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
- # is part of the input, its contents will be placed on the main page
- # (index.html). This can be useful if you have a project on for instance GitHub
- # and want to reuse the introduction page also for the doxygen output.
- USE_MDFILE_AS_MAINPAGE =
- #---------------------------------------------------------------------------
- # 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 that
- # also VERBATIM_HEADERS is set to NO.
- # The default value is: NO.
- SOURCE_BROWSER = NO
- # Setting the INLINE_SOURCES tag to YES will include the body of functions,
- # classes and enums directly into the documentation.
- # The default value is: NO.
- INLINE_SOURCES = NO
- # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
- # special comment blocks from generated source code fragments. Normal C, C++ and
- # Fortran comments will always remain visible.
- # The default value is: YES.
- STRIP_CODE_COMMENTS = YES
- # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
- # function all documented functions referencing it will be listed.
- # The default value is: NO.
- REFERENCED_BY_RELATION = NO
- # If the REFERENCES_RELATION tag is set to YES then for each documented function
- # all documented entities called/used by that function will be listed.
- # The default value is: NO.
- REFERENCES_RELATION = NO
- # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
- # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
- # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
- # link to the documentation.
- # The default value is: YES.
- REFERENCES_LINK_SOURCE = YES
- # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
- # source code will show a tooltip with additional information such as prototype,
- # brief description and links to the definition and documentation. Since this
- # will make the HTML file larger and loading of large files a bit slower, you
- # can opt to disable this feature.
- # The default value is: YES.
- # This tag requires that the tag SOURCE_BROWSER is set to YES.
- SOURCE_TOOLTIPS = 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.
- #
- # To use it do the following:
- # - Install the latest version of global
- # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
- # - Make sure the INPUT points to the root of the source tree
- # - Run doxygen as normal
- #
- # Doxygen will invoke htags (and that will in turn invoke gtags), so these
- # tools must be available from the command line (i.e. in the search path).
- #
- # The result: instead of the source browser generated by doxygen, the links to
- # source code will now point to the output of htags.
- # The default value is: NO.
- # This tag requires that the tag SOURCE_BROWSER is set to YES.
- USE_HTAGS = NO
- # If the VERBATIM_HEADERS tag is set the YES 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.
- # See also: Section \class.
- # The default value is: YES.
- VERBATIM_HEADERS = NO
- # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
- # clang parser (see: http://clang.llvm.org/) for more acurate parsing at the
- # cost of reduced performance. This can be particularly helpful with template
- # rich C++ code for which doxygen's built-in parser lacks the necessary type
- # information.
- # Note: The availability of this option depends on whether or not doxygen was
- # compiled with the --with-libclang option.
- # The default value is: NO.
- CLANG_ASSISTED_PARSING = NO
- # If clang assisted parsing is enabled you can provide the compiler with command
- # line options that you would normally use when invoking the compiler. Note that
- # the include paths will already be set by doxygen for the files and directories
- # specified with INPUT and INCLUDE_PATH.
- # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
- CLANG_OPTIONS =
- #---------------------------------------------------------------------------
- # 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.
- # The default value is: YES.
- ALPHABETICAL_INDEX = YES
- # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
- # which the alphabetical index list will be split.
- # Minimum value: 1, maximum value: 20, default value: 5.
- # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
- 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 a prefix (or a list of prefixes) that should be ignored
- # while generating the index headers.
- # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
- IGNORE_PREFIX =
- #---------------------------------------------------------------------------
- # Configuration options related to the HTML output
- #---------------------------------------------------------------------------
- # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
- # The default value is: YES.
- GENERATE_HTML = YES
- # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
- # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
- # it.
- # The default directory is: html.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_OUTPUT = html
- # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
- # generated HTML page (for example: .htm, .php, .asp).
- # The default value is: .html.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_FILE_EXTENSION = .html
- # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
- # each generated HTML page. If the tag is left blank doxygen will generate a
- # standard header.
- #
- # To get valid HTML the header file that includes any scripts and style sheets
- # that doxygen needs, which is dependent on the configuration options used (e.g.
- # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
- # default header using
- # doxygen -w html new_header.html new_footer.html new_stylesheet.css
- # YourConfigFile
- # and then modify the file new_header.html. See also section "Doxygen usage"
- # for information on how to generate the default header that doxygen normally
- # uses.
- # Note: The header is subject to change so you typically have to regenerate the
- # default header when upgrading to a newer version of doxygen. For a description
- # of the possible markers and block names see the documentation.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_HEADER =
- # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
- # generated HTML page. If the tag is left blank doxygen will generate a standard
- # footer. See HTML_HEADER for more information on how to generate a default
- # footer and what special commands can be used inside the footer. See also
- # section "Doxygen usage" for information on how to generate the default footer
- # that doxygen normally uses.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_FOOTER =
- # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
- # sheet that is used by each HTML page. It can be used to fine-tune the look of
- # the HTML output. If left blank doxygen will generate a default style sheet.
- # See also section "Doxygen usage" for information on how to generate the style
- # sheet that doxygen normally uses.
- # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
- # it is more robust and this tag (HTML_STYLESHEET) will in the future become
- # obsolete.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_STYLESHEET =
- # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
- # defined cascading style sheet that is included after the standard style sheets
- # created by doxygen. Using this option one can overrule certain style aspects.
- # This is preferred over using HTML_STYLESHEET since it does not replace the
- # standard style sheet and is therefor more robust against future updates.
- # Doxygen will copy the style sheet file to the output directory. For an example
- # see the documentation.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_EXTRA_STYLESHEET =
- # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
- # other source files which should be copied to the HTML output directory. Note
- # that these files will be copied to the base HTML output directory. Use the
- # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
- # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
- # files will be copied as-is; there are no commands or markers available.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_EXTRA_FILES =
- # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
- # will adjust the colors in the stylesheet and background images according to
- # this color. Hue is specified as an angle on a colorwheel, see
- # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
- # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
- # purple, and 360 is red again.
- # Minimum value: 0, maximum value: 359, default value: 220.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_COLORSTYLE_HUE = 220
- # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
- # in the HTML output. For a value of 0 the output will use grayscales only. A
- # value of 255 will produce the most vivid colors.
- # Minimum value: 0, maximum value: 255, default value: 100.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_COLORSTYLE_SAT = 100
- # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
- # luminance component of the colors in the HTML output. Values below 100
- # gradually make the output lighter, whereas values above 100 make the output
- # darker. The value divided by 100 is the actual gamma applied, so 80 represents
- # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
- # change the gamma.
- # Minimum value: 40, maximum value: 240, default value: 80.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_COLORSTYLE_GAMMA = 80
- # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
- # page will contain the date and time when the page was generated. Setting this
- # to NO can help when comparing the output of multiple runs.
- # The default value is: YES.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_TIMESTAMP = YES
- # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
- # documentation will contain sections that can be hidden and shown after the
- # page has loaded.
- # The default value is: NO.
- # This tag requires that the tag GENERATE_HTML is set to YES.
- HTML_DYNAMIC_SECTIONS = NO
- # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
- # shown in theā¦
Large files files are truncated, but you can click here to view the full file