diff --git a/docs/doxygen.config b/docs/doxygen.config index 8b6d8d0080..581b2e93a0 100644 --- a/docs/doxygen.config +++ b/docs/doxygen.config @@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = cocos2d-x +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.5 +PROJECT_NUMBER = v3.6 # 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 @@ -125,7 +125,7 @@ ABBREVIATE_BRIEF = "The $name class" \ # description. # The default value is: NO. -ALWAYS_DETAILED_SEC = YES +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 @@ -140,7 +140,7 @@ INLINE_INHERITED_MEMB = NO # shortest path that makes the file name unique will be used # The default value is: YES. -FULL_PATH_NAMES = YES +FULL_PATH_NAMES = NO # 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 @@ -406,7 +406,7 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = YES +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will # be included in the documentation. @@ -508,7 +508,7 @@ HIDE_SCOPE_NAMES = YES # the files that are included by a file in the documentation of that file. # The default value is: YES. -SHOW_INCLUDE_FILES = YES +SHOW_INCLUDE_FILES = NO # 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. @@ -527,7 +527,7 @@ INLINE_INFO = YES # name. If set to NO the members will appear in declaration order. # The default value is: YES. -SORT_MEMBER_DOCS = YES +SORT_MEMBER_DOCS = NO # 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 @@ -546,7 +546,7 @@ SORT_BRIEF_DOCS = NO # detailed member documentation. # The default value is: NO. -SORT_MEMBERS_CTORS_1ST = YES +SORT_MEMBERS_CTORS_1ST = NO # 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 @@ -580,7 +580,7 @@ STRICT_PROTO_MATCHING = NO # documentation. # The default value is: YES. -GENERATE_TODOLIST = YES +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 @@ -600,7 +600,7 @@ GENERATE_BUGLIST = YES # the documentation. # The default value is: YES. -GENERATE_DEPRECATEDLIST= YES +GENERATE_DEPRECATEDLIST= NO # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond @@ -631,14 +631,14 @@ SHOW_USED_FILES = YES # (if specified). # The default value is: YES. -SHOW_FILES = YES +SHOW_FILES = NO # 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 +SHOW_NAMESPACES = 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 @@ -744,10 +744,9 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = ../cocos \ - ../cocos/2d/platform \ - ../docs \ - ../extensions \ - ../cocos/scripting/lua/bindings + ../docs \ + ../extensions/GUI/CCScrollView \ + ../external/lua/luajit/include # 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 @@ -782,7 +781,39 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = ../cocos2dx/platform/third_party +EXCLUDE = ../cocos/audio/android \ + ../cocos/audio/apple \ + ../cocos/audio/ios \ + ../cocos/audio/linux \ + ../cocos/audio/mac \ + ../cocos/audio/openal \ + ../cocos/audio/win32 \ + ../cocos/audio/winrt \ + ../cocos/audio/wp8 \ + ../cocos/deprecated \ + ../cocos/editor-support \ + ../cocos/platform/android \ + ../cocos/platform/apple \ + ../cocos/platform/desktop \ + ../cocos/platform/ios \ + ../cocos/platform/linux \ + ../cocos/platform/mac \ + ../cocos/platform/win32 \ + ../cocos/platform/win8.1-universal \ + ../cocos/platform/winrt \ + ../cocos/platform/wp8 \ + ../cocos/platform/wp8-xaml \ + ../cocos/scripting/lua-bindings/auto \ + ../cocos/scripting/lua-bindings/manual/cocosbuilder \ + ../cocos/scripting/lua-bindings/manual/cocostudio \ + ../cocos/scripting/lua-bindings/manual/spine \ + ../cocos/scripting/lua-bindings/manual/extension \ + ../cocos/scripting/lua-bindings/manual/cocosdenshion \ + ../cocos/scripting/lua-bindings/manual/audioengine \ + ../cocos/scripting/lua-bindings/manual/3d \ + ../cocos/scripting/lua-bindings/manual/ui \ + ../cocos/scripting/lua-bindings/manual/network \ + # 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 @@ -804,7 +835,15 @@ EXCLUDE_PATTERNS = .svn \ proj.ios \ data_support \ image_support \ - zip_support + zip_support \ + */UIEditBox/UIEditBoxImpl* \ + */ui/UIWebViewImpl* \ + UIVideoPlayer-android.cpp \ + UIVideoPlayer-ios.mm \ + LuaBasicConversions.h \ + tolua_fix.h \ + + # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -816,7 +855,16 @@ EXCLUDE_PATTERNS = .svn \ # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = ccArray \ - ccCArray + ccCArray \ + __CCCallFuncND \ + __CCCallFuncO \ + __LayerRGBA \ + __NodeRGBA \ + __RGBAProtocol \ + RelativeLayoutManager \ + LinearHorizontalLayoutManager \ + LinearVerticalLayoutManager \ + LayoutProtocol \ # 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 @@ -1365,7 +1413,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = NO +DISABLE_INDEX = YES # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag @@ -1437,7 +1485,7 @@ FORMULA_TRANSPARENT = YES # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -USE_MATHJAX = NO +USE_MATHJAX = YES # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: @@ -1460,7 +1508,7 @@ MATHJAX_FORMAT = HTML-CSS # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_RELPATH = http://www.mathjax.org/mathjax +# MATHJAX_RELPATH = ../ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example @@ -1933,7 +1981,9 @@ MACRO_EXPANSION = YES # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_ONLY_PREDEF = YES +E /* + * \internal + *_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES the includes files in the # INCLUDE_PATH will be searched if a #include is found. @@ -1976,12 +2026,28 @@ PREDEFINED = "CC_PROPERTY_READONLY(varType, varName, funName)=protec "CC_SYNTHESIZE_READONLY_PASS_BY_REF(varType, varName, funName)=protected: varType varName;\n /** get##funName */ \n public: virtual const varType& get##funName(void);" \ "NS_CC_BEGIN=namespace cocos2d {" \ "NS_CC_END=}" \ + "NS_CC_MATH_BEGIN=namespace cocos2d {" \ + "NS_CC_MATH_END=}" \ "USING_NS_CC=using namsspace cocos2d" \ + "USING_NS_CC_MATH=using namsspace cocos2d" \ "NS_CC_EXT_BEGIN=namespace cocos2d { namespace extension {" \ "NS_CC_EXT_END=}}" \ "USING_NS_CC_EXT=using namespace cocos2d::extension" \ "CC_USE_PHYSICS" \ - "CC_DEPRECATED_ATTRIBUTE" + "CC_DEPRECATED_ATTRIBUTE" \ + "CC_CONSTRUCTOR_ACCESS=protected" \ + "protected=private" \ + "CC_DLL=" \ + "CC_GUI_DLL=" \ + "_USRDLL=" \ + "_EXPORT_DLL_=" \ + "EXPORT_DLL_=" \ + "_USEGUIDLL=" \ + "_USREXDLL=" \ + "_USRSTUDIODLL=" \ + "TOLUA_API=extern" \ + "CC_ENABLE_SCRIPT_BINDING=1" \ + "CC_USE_PHYSICS=1" # 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 @@ -2064,7 +2130,7 @@ PERL_PATH = /usr/bin/perl # powerful graphs. # The default value is: YES. -CLASS_DIAGRAMS = YES +CLASS_DIAGRAMS = NO # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see: