From ca4c71bf0ef86239031c4910ec969be1061c5a76 Mon Sep 17 00:00:00 2001 From: Vincent Yang Date: Thu, 19 Mar 2015 20:21:40 +0800 Subject: [PATCH 1/2] Add MainPageWhiteBook.h, and move doxygen_modules.h to docs. --- cocos/2d/doxygen_modules.h | 5 ----- cocos/doxygen_modules.h | 39 --------------------------------- docs/MainPage.h | 5 ++++- docs/MainPageWhiteBook.h | 16 ++++++++++++++ docs/doxygen.config | 4 ++-- docs/doxygen_modules.h | 0 docs/doxygen_white_book.config | 6 ++--- docs/img-cocos.jpg | Bin 0 -> 17982 bytes 8 files changed, 25 insertions(+), 50 deletions(-) delete mode 100644 cocos/2d/doxygen_modules.h delete mode 100644 cocos/doxygen_modules.h create mode 100644 docs/MainPageWhiteBook.h create mode 100644 docs/doxygen_modules.h create mode 100644 docs/img-cocos.jpg diff --git a/cocos/2d/doxygen_modules.h b/cocos/2d/doxygen_modules.h deleted file mode 100644 index f1e55ec591..0000000000 --- a/cocos/2d/doxygen_modules.h +++ /dev/null @@ -1,5 +0,0 @@ - -/**@defgroup sprite_nodes - * @ingroup two_d - **/ - diff --git a/cocos/doxygen_modules.h b/cocos/doxygen_modules.h deleted file mode 100644 index a3d0a50977..0000000000 --- a/cocos/doxygen_modules.h +++ /dev/null @@ -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 - **/ - diff --git a/docs/MainPage.h b/docs/MainPage.h index 42ebd6e4d7..50e1799c2a 100644 --- a/docs/MainPage.h +++ b/docs/MainPage.h @@ -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 */ diff --git a/docs/MainPageWhiteBook.h b/docs/MainPageWhiteBook.h new file mode 100644 index 0000000000..48e78ac16b --- /dev/null +++ b/docs/MainPageWhiteBook.h @@ -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 +*/ diff --git a/docs/doxygen.config b/docs/doxygen.config index bb7b723725..8b6d8d0080 100644 --- a/docs/doxygen.config +++ b/docs/doxygen.config @@ -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 ... \endif and \cond # ... \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 diff --git a/docs/doxygen_modules.h b/docs/doxygen_modules.h new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/doxygen_white_book.config b/docs/doxygen_white_book.config index dd4a54bb17..4a920c0ede 100644 --- a/docs/doxygen_white_book.config +++ b/docs/doxygen_white_book.config @@ -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 ... \endif and \cond # ... \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 diff --git a/docs/img-cocos.jpg b/docs/img-cocos.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1895b9d30d3e1e467c82b56e9992cefae85eec9a GIT binary patch literal 17982 zcmeI(c|25Y-vIC#!zdw3WX(E+#y(?=J!2V5mYFCd%nS|2Fh;i0+}#x_*^Q;B>|0uh zEO(Nm(883mRf3@jL*+Gzw38hzwbG7{yR&LmY#xy z?5wfYATSsVvR(cGEj`oE+e4>^qP4U_!Zm$~R6mj?flASe@(tC}(bU!g8Jk6g`VxXj zba_8g06D}&ajNO6qCA;sqUerr)OHNDB<&&F#?VN(m~D7MOc244sAy)&XB>r&qJ&aN zbYJ->N^nRxI?6=xdvWw~ymDAeQT}@hJ;+4SVr5nN9gfcOmQ)%^9-*lRCur;F$Rm-O zI{FACQfG_2uC|V@miF>560W05=t zGg42JN(<1^F*Gz>DWj_kU(SGsM~BdTqu?RoN!5Xz9>2{0k@T18j#MJq zKl(pR|0QX4y0O*@$}dRYufR%we>u(uo}=S`%}1eV{T+Ka-IWAf;lG6s$47^fv|LHy z)Cd}Zw44rHS#` zNa1h+7HmWuE;f*W6b=_)!A8X4Vgm_C;cx*KY(yL`Hjsc64i{j-M#SM_0|`jsZ~+!< zL>w+Qkbo2p7hu6g#NlEC2}t2^0TygT94`Na1h+7HmWuE;f*W z6b=_)!A8X4Vgm_C;cx*KY(yL`Hjsc64i{j-M#SM_0|`jsZ~+!w+Qkbo2p7hu6g z#NlEC2}t2^0TygT94`Na1h+7HmWuE;f*W6b=_)!AA7|&&3D4 zXhaHGe!D1g`8A@YL69W~%FWHq!wu!(fv$xvf7Y#mLf5S0=i^()$Hy@eLE(>iS#i8YMkTKia`F7cSmch9Sf0>Eas=2-n)K_f1RaBdqY-BYr=W(cb%P zxv132n_H0O4=})7+&mEI@;N2pmF<8b+>oCqmlqV~<`L0>iYkOz_+D5V0P!zxmrEET z3^D`FEx-Tu-x>n@&|{`}CIQxcQ8J8DUKf!omN7Zl3T^$@Dm*^dL?1m7?OShUmC>FR zM=Yy8H?{;q2!fbxm3Hy|rMn)YM2GMNrv}UodK%(|>?xQc4SZRHgrNCfYN3m6`RiG~ zDJ3#%@1AEw&y?=WtuCL*PKIOVto61>Z`9qISWNPlT2niG(dMqH#;&OnhStVMThp(b zOU)Og+ePXTLohDG9kE7zBV1Ne_98p&yDNx@JmpOQ9hK(l)G#M6)4IB00!yVHDxG%HF5}2#c4|eP(H`&f zGJdS5_N66f#6GmF-D4m!BludMDMzZ47w$Z#iD$wLZ(MI_T36PBf#fT;XABuwrn;9& zzLU^UDEcrQwhNl#otFF_oO7r$!0QaAB2T6uQ$bU7=Os^FtQUO}+;}@vx%X_NQ=){R zHKe%h9(Ry<<8yuWV@axd%{jefSo^~wDQE9GNl@kV$i`EL)U_RLqB4=GoBZs5rzIL+ zH#-&l2NJBKhaF-#Xdh~s)1U?1IbLXU-vl@R2s*vm6ZDcu=BqUOD`xu`xY`AzLMcI2 zrB7XhAjt9veWRZwPw;YX5^OP5!7~kZkRa2g$q3`mlOkY30 zRMq%cxwk-3ulGHXV8}M6U0aG;T3;4Mx%}|gvlM?@mq@8CKFYViYv4t-<9%M&dTP^2 zC8D{Gb7ROmm%A!+2h!s1iSlMZoJ>d=t=1KZl=+O_1y#bd{;AGIYjZ@$5(vee%wyN( zvj5nt+31!%X4lMB7^@v19x-ZcQ$NIg2K^3GyBjKv>Rpq-8<|Po(9t<|+h0n&aMwuK z=I&zI?#~_WEa(8!z0`>s4aMoEc;UMeLyz55JH?<#hn{Fv4>n}vmv^{ns9rINSSXxB z1-WDTnq6S)E?>c)pfc9!Vop%*TAIQ-T9q<$drYOAvg`tNB*Psa6mOjFCPK_3Y;i&% zn3SPI8^!c%Yu+{pgeUJbH)z5U81&)ntH!Fn-~OvMY@!`V})*;rKN~KD`6Q|%r>hNvZ?uaHx~@N%&^5qSU6y+JS?YW2qgJ`^HV6R4n*zwtLd(V$t%{S_Tx2qR=r3=*M1Q^e5*cCrbiGqnYsN6H@Nf4zb8Gm)Z zuY#_pNf~##95})Ikgr)g$wHSrxs94TbUE#klix8*EtjF+a8(AL#eIP;Di2@=d=NpA zk+kjgZjb2 zt8zwe$tBmf?snf^f6%q8K|QPZRq4k{n{ER!YOOVyqjd^v!h`tco4K=I7IUeKThG@j)8S=)fiU^kDf!g&%#SLg zdev0}`IapWZ^|VGZg#a0oS)93dF4`>L(NW+FL5s?(=SfQMn`u7Le&s&s5YxCe$F7S7)Hu&I&`f){4@I}H>Zod}J6wpwZ$}SBsojFAi*8ah z%L}fu8Qq8R&kpWecO@YxfztjhBrzaBqpYik`Z_086LO!3vGTij?6*}?5a{VFy!rOy z2*bQEmCT}r&JWrfybX#v3-L^`!MuRGN2f}jjC%2NyEz=SvXjJBrg)ZHV25iBd%_AQ z$!#x{q2()mg&c*{(0&n=N*-KosTC>V&Y{RoRu;Q+lf_&Hh##N zKiDW+CW5=^eOgYo!UAvLi$7cMTxvFbZ-jMxQMn-Z?4-Of^ZbcUZ0tK5ywh%FhqU2O z{-zNvKDqldJraiGU@m76c15YnLMVkU{gGgofI zN`pJJ#^gbt?TGSEcwl%Uw#ASJCxrEl)(D=}Y?c1=TL%J3?ZX|B_fz+HW;ed&%KaCr zMFU^#Yn$w=cyq&&L@pgs4-hQ7UmrUY4V!jSt>gP*p9s2NQau7m&f4&J5XnHDyO2E< zDslHgk4Fxpjdr>?g3)uG71JSKVc=MF6JH+kx%^eJNsvba3^w3ng1xjq4>!Hvbo^}Q zj+C^qba-jVWaWgd(p-V)gyP!lpBDrK;+MK1lJ3E15Zh7RedHy!)NU-U_l=TfA>7<0 zs%xm%KVVzNhfBF`Ib@eq-Z2tRD4<)>T^wbX`+E#ay~ za(k)2+aw#c@_ameK5kPR>zk!jLUzxoq<-`^)Y;jSJ0}X4K->@-uxW_oLM9shk$Rg{ zihALhi2cIf8WvK64I@*oRKWv{U}_Oi|NV#D!GnrKRJ#pq{xOUmc~tpH+dTOGScT3j z-1Bd9atZu{nKcgvAZy;}`b_7yWuN}&1nu8g;%hpArd+O5ZBGx~6xJFg_BB?$ zTxFM|gK1ly=ecs}F;wX#uR9Yqr}^?-=J|Ti)qH2hij6v-P!^x4DvuABWd=9v>|E&cdl`4yzpM{QG|$`a=<@_cnKDq7(+ra1 zAH3oD2qKJ_xcXkPO%gZ8+Erem zo_l~!Y8=T;R@=e~M3naO(4P-+&qLyJ)M1WJ%?l@SA+VO)c{oFdm5keI%!86@d_N6uc5SY` z_Na#PdEd$AKC0d{~ZsiJQid5s_hMr;YujRS+Zn%jV?!MUBt@WD1SDBFHk#qVt2u4{bSm@FSHlEi;avU zm}^a8zsm|MoV-jx6gt)$W}H5{Xw{+tV)`7{sx{<)c$&alv_Wn9fo%HTt;#!t?y=JB z`h$el95X@>EDH3G-p9YjAfCjEdj_AmQ}q}>Di*spMG*V=1nWKbryf65S&Vh}5=bo_ zc160jz+O>g^v+8kk?PaV$o$4G*kPHpTzeM}vRWW6I2FE8sS#f*J4p%V(yr30zagC3 zq~H0$><<4DXdhR^MUw)Sb~Bb%5vW*Tq##4j*_>+`IePYr)bR%_uC^c8|Kq>lrN{pO D{*EdW literal 0 HcmV?d00001 From 85a26a32c3c801fe7e177a8e9afe6bb8e6ef9a7c Mon Sep 17 00:00:00 2001 From: Vincent Yang Date: Thu, 19 Mar 2015 20:29:31 +0800 Subject: [PATCH 2/2] Modify doxygen_white_book.h for ignore some macros like this: CC_DLL... --- docs/doxygen_white_book.config | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/doxygen_white_book.config b/docs/doxygen_white_book.config index 4a920c0ede..4d78ab8693 100644 --- a/docs/doxygen_white_book.config +++ b/docs/doxygen_white_book.config @@ -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