Merge pull request #1411 from walzer/gles20

update doxygen config for v2.0.3
This commit is contained in:
Walzer 2012-09-27 19:28:51 -07:00
commit b4230648cd
1 changed files with 52 additions and 31 deletions

View File

@ -1,4 +1,4 @@
# Doxyfile 1.8.1.1 # Doxyfile 1.8.2
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project # doxygen (www.doxygen.org) for a project
@ -32,7 +32,7 @@ PROJECT_NAME = cocos2d-x
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
# if some version control system is used. # if some version control system is used.
PROJECT_NUMBER = 2.1 PROJECT_NUMBER = 2.0.3
# Using the PROJECT_BRIEF tag one can provide an optional one line description # 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 # for a project that appears at the top of each page and should give viewer
@ -136,7 +136,9 @@ FULL_PATH_NAMES = YES
# only done if one of the specified strings matches the left-hand part of # 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. # 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 # If left blank the directory from which doxygen is run is used as the
# path to strip. # path to strip. Note that you specify absolute paths here, but also
# relative paths, which will be relative from the directory where doxygen is
# started.
STRIP_FROM_PATH = STRIP_FROM_PATH =
@ -239,14 +241,15 @@ OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it # 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. # parses. With this tag you can assign which parser to use for a given
# Doxygen has a built-in mapping, but you can override or extend it using this # extension. Doxygen has a built-in mapping, but you can override or extend it
# tag. The format is ext=language, where ext is a file extension, and language # using this tag. The format is ext=language, where ext is a file extension,
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, # and language is one of the parsers supported by doxygen: IDL, Java,
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C # C++. For instance to make doxygen treat .inc files as Fortran files (default
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. # that for custom extensions you also need to set FILE_PATTERNS otherwise the
# files are not read by doxygen.
EXTENSION_MAPPING = EXTENSION_MAPPING =
@ -259,6 +262,13 @@ EXTENSION_MAPPING =
MARKDOWN_SUPPORT = 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.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # 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 # 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 # set this tag to YES in order to let doxygen match functions declarations and
@ -279,10 +289,10 @@ CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter # For Microsoft's IDL there are propget and propput attributes to indicate
# and setter methods for a property. Setting this option to YES (the default) # getter and setter methods for a property. Setting this option to YES (the
# will make doxygen replace the get and set methods by a property in the # default) will make doxygen replace the get and set methods by a property in
# documentation. This will only work if the methods are indeed getting or # 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 # 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. # methods anyway, you should set this option to NO.
@ -665,11 +675,13 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = ../CocosDenshion/include \ INPUT = ../cocos2dx \
../cocos2dx \ ../cocos2dx/platform \
../doxygen \ ../CocosDenshion/include \
../lua/cocos2dx_support \ ../document \
../cocos2dx/platform ../extensions \
../scripting/lua/cocos2dx_support \
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -701,8 +713,7 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is # Note that relative paths are relative to the directory from which doxygen is
# run. # run.
EXCLUDE = ../cocos2dx/platform/third_party \ EXCLUDE = ../cocos2dx/platform/third_party
../cocos2dx/include/CCTMXXMLParser.h
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # 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 # directories that are symbolic links (a Unix file system feature) are excluded
@ -912,13 +923,23 @@ HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading # 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 # style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen # fine-tune the look of the HTML output. If left blank doxygen will
# will generate a default style sheet. Note that doxygen will try to copy # generate a default style sheet. Note that it is recommended to use
# the style sheet file to the HTML output directory, so don't put your own # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
# style sheet in the HTML output directory as well, or it will be erased! # tag will in the future become obsolete.
HTML_STYLESHEET = 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.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # 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 # 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 # that these files will be copied to the base HTML output directory. Use the
@ -1003,9 +1024,9 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project DOCSET_BUNDLE_ID = org.doxygen.Project
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
# the documentation publisher. This should be a reverse domain-name style # identify the documentation publisher. This should be a reverse domain-name
# string, e.g. com.mycompany.MyDocSet.documentation. # style string, e.g. com.mycompany.MyDocSet.documentation.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher DOCSET_PUBLISHER_ID = org.doxygen.Publisher