Merge pull request #11000 from yangws/v3

Add MainPageWhiteBook.h, and move doxygen_modules.h to docs.
This commit is contained in:
minggo 2015-03-19 20:40:29 +08:00
commit b01c515aba
8 changed files with 31 additions and 51 deletions

View File

@ -1,5 +0,0 @@
/**@defgroup sprite_nodes
* @ingroup two_d
**/

View File

@ -1,39 +0,0 @@
/**@defgroup two_d 2D
**/
/**@defgroup three_d 3D
**/
/**@defgroup audio Audio
**/
/**@defgroup base Base
**/
/**@defgroup deprecated Deprecated
**/
/**@defgroup math Math
**/
/**@defgroup network Network
**/
/**@defgroup physics Physics
**/
/**@defgroup platform Platform
**/
/**@defgroup renderer Renderer
**/
/**@defgroup scripting Script Binding
**/
/**@defgroup storage Storage
**/
/**@defgroup ui UI
**/

View File

@ -1,4 +1,6 @@
/*!
/*!
@cond GEN_REFERENCE_BOOK
@mainpage cocos2d-x
@image html cocos2dx_portrait.png
@ -53,4 +55,5 @@ THE SOFTWARE. \n
- Fork our repository on github, commit your changes, and send a "pull request" to us. We will merge your contribution to master
- Suggestion, bug fixes, and improvements are highly appreciated.
@endcond
*/

16
docs/MainPageWhiteBook.h Normal file
View File

@ -0,0 +1,16 @@
/*!
@cond GEN_WRITE_BOOK
@mainpage cocos2d-x
@image html img-cocos.jpg
@section sec1 About cocos2d-x
Cocos is a free and professional game development toolkit, that enables game developers to quickly create game content, and takes that tedious work and simplifies it with straightforward GUI editors.
Cocos includes: Cocos Studio, Cocos IDE, and Cocos Shop. Developers can focus on their specific roles and enjoy better streamlined workflow.
This enables game studios to collaborate with ease, and focus on what each does best in order to achieve better quality and faster turnaround time. This saves time and money.
@endcond
*/

View File

@ -38,7 +38,7 @@ PROJECT_NAME = cocos2d-x
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 3.0
PROJECT_NUMBER = 3.5
# 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
@ -606,7 +606,7 @@ GENERATE_DEPRECATEDLIST= YES
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
ENABLED_SECTIONS =
ENABLED_SECTIONS = GEN_REFERENCE_BOOK
# 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

0
docs/doxygen_modules.h Normal file
View File

View File

@ -465,7 +465,7 @@ HIDE_UNDOC_MEMBERS = YES
# no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = 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
@ -606,7 +606,7 @@ GENERATE_DEPRECATEDLIST= YES
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
ENABLED_SECTIONS =
ENABLED_SECTIONS = GEN_WRITE_BOOK
# 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
@ -1494,7 +1494,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
@ -2023,7 +2023,12 @@ PREDEFINED = "CC_PROPERTY_READONLY(varType, varName, funName)=protec
"CC_DEPRECATED_ATTRIBUTE" \
"CC_CONSTRUCTOR_ACCESS=protected" \
"protected=private" \
"CC_DLL=" \
"_USRDLL=" \
"_EXPORT_DLL_=" \
"_USEGUIDLL=" \
"_USREXDLL=" \
"_USRSTUDIODLL=" \
# 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

BIN
docs/img-cocos.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB