Skip to content

Commit 742baf4

Browse files
author
Ming
committed
issue #170 
1 parent de0b838 commit 742baf4

19 files changed

+168
-127
lines changed

‎cocos2dx/CCConfiguration.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ THE SOFTWARE.
3131
namespace cocos2d {
3232

3333
/**
34-
CCConfiguration contains some openGL variables
34+
@brief CCConfiguration contains some openGL variables
3535
@since v0.99.0
3636
*/
3737
class CCConfiguration : public NSObject

‎cocos2dx/include/CCAction.h

+19-13
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ enum {
3636
kCCActionTagInvalid = -1,
3737
};
3838

39-
/** Base class for CCAction objects.
39+
/**
40+
@brief Base class for CCAction objects.
4041
*/
4142
class CCX_DLL CCAction : public NSObject
4243
{
@@ -99,11 +100,14 @@ class CCX_DLL CCAction : public NSObject
99100
int m_nTag;
100101
};
101102

102-
/** Base class actions that do have a finite time duration.
103+
/**
104+
@brief
105+
Base class actions that do have a finite time duration.
103106
Possible actions:
104107
- An action with a duration of 0 seconds
105108
- An action with a duration of 35.5 seconds
106-
Infitite time actions are valid
109+
110+
Infinite time actions are valid
107111
*/
108112
class CCX_DLL CCFiniteTimeAction : public CCAction
109113
{
@@ -124,7 +128,8 @@ class CCX_DLL CCFiniteTimeAction : public CCAction
124128
class CCIntervalAction;
125129
class CCRepeatForever;
126130

127-
/** Changes the speed of an action, making it take longer (speed>1)
131+
/**
132+
@brief Changes the speed of an action, making it take longer (speed>1)
128133
or less (speed<1) time.
129134
Useful to simulate 'slow motion' or 'fast forward' effect.
130135
@warning This action can't be Sequenceable because it is not an IntervalAction
@@ -158,18 +163,19 @@ class CCX_DLL CCSpeed : public CCAction
158163
CCIntervalAction *m_pOther;
159164
};
160165

161-
/** CCFollow is an action that "follows" a node.
162-
163-
Eg:
164-
layer->runAction(CCFollow::actionWithTarget(hero));
165-
166-
Instead of using CCCamera as a "follower", use this action instead.
167-
@since v0.99.2
168-
*/
166+
169167
class CCNode;
170168
class CGPoint;
171169
class CGRect;
172-
170+
/**
171+
@brief CCFollow is an action that "follows" a node.
172+
173+
Eg:
174+
layer->runAction(CCFollow::actionWithTarget(hero));
175+
176+
Instead of using CCCamera as a "follower", use this action instead.
177+
@since v0.99.2
178+
*/
173179
class CCX_DLL CCFollow : public CCAction
174180
{
175181
public:

‎cocos2dx/include/CCActionManager.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ THE SOFTWARE.
3333

3434
namespace cocos2d {
3535

36-
/** CCActionManager is a singleton that manages all the actions.
36+
/**
37+
@brief CCActionManager is a singleton that manages all the actions.
3738
Normally you won't need to use this singleton directly. 99% of the cases you will use the CCNode interface,
3839
which uses this singleton.
3940
But there are some cases where you might need to use this singleton.

‎cocos2dx/include/CCCameraAction.h

+4-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ THE SOFTWARE.
2929
namespace cocos2d {
3030
class CCCamera;
3131

32-
/** Base class for CCCamera actions
32+
/**
33+
@brief Base class for CCCamera actions
3334
*/
3435
class CCX_DLL CCCameraAction : public CCIntervalAction //<NSCopying>
3536
{
@@ -63,7 +64,8 @@ namespace cocos2d {
6364
float m_fUpZOrig;
6465
};
6566

66-
/** CCOrbitCamera action
67+
/**
68+
@brief CCOrbitCamera action
6769
Orbits the camera around the center of the screen using spherical coordinates
6870
*/
6971
class CCX_DLL CCOrbitCamera : public CCCameraAction //<NSCopying>

‎cocos2dx/include/CCDirector.h

+13-11
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,8 @@ class CCLabel;
173173
class CCScene;
174174
class cocos2d::CCXEGLView;
175175

176-
/**Class that creates and handle the main Window and manages how
176+
/**
177+
@brief Class that creates and handle the main Window and manages how
177178
and when to execute the Scenes.
178179
179180
The CCDirector is also responsible for:
@@ -502,16 +503,17 @@ class CCX_DLL CCDirector : public NSObject
502503
#endif
503504
};
504505

505-
/** DisplayLinkDirector is a Director that synchronizes timers with the refresh rate of the display.
506-
*
507-
* Features and Limitations:
508-
* - Only available on 3.1+
509-
* - Scheduled timers & drawing are synchronizes with the refresh rate of the display
510-
* - Only supports animation intervals of 1/60 1/30 & 1/15
511-
*
512-
* It is the recommended Director if the SDK is 3.1 or newer
513-
*
514-
* @since v0.8.2
506+
/**
507+
@brief DisplayLinkDirector is a Director that synchronizes timers with the refresh rate of the display.
508+
509+
Features and Limitations:
510+
- Only available on 3.1+
511+
- Scheduled timers & drawing are synchronizes with the refresh rate of the display
512+
- Only supports animation intervals of 1/60 1/30 & 1/15
513+
514+
It is the recommended Director if the SDK is 3.1 or newer
515+
516+
@since v0.8.2
515517
*/
516518
class CCDisplayLinkDirector : public CCDirector
517519
{

‎cocos2dx/include/CCEaseAction.h

+45-23
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ namespace cocos2d {
3333
class NSObject;
3434
class NSZone;
3535

36-
/** Base class for Easing actions
36+
/**
37+
@brief Base class for Easing actions
3738
*/
3839
class CCX_DLL CCEaseAction : public CCIntervalAction
3940
{
@@ -57,7 +58,8 @@ class CCX_DLL CCEaseAction : public CCIntervalAction
5758
CCIntervalAction *m_pOther;
5859
};
5960

60-
/** Base class for Easing actions with rate parameters
61+
/**
62+
@brief Base class for Easing actions with rate parameters
6163
*/
6264
class CCX_DLL CCEaseRateAction : public CCEaseAction
6365
{
@@ -83,7 +85,8 @@ class CCX_DLL CCEaseRateAction : public CCEaseAction
8385
float m_fRate;
8486
};
8587

86-
/** CCEaseIn action with a rate
88+
/**
89+
@brief CCEaseIn action with a rate
8790
*/
8891
class CCX_DLL CCEaseIn : public CCEaseRateAction
8992
{
@@ -95,7 +98,8 @@ class CCX_DLL CCEaseIn : public CCEaseRateAction
9598
static CCEaseIn* actionWithAction(CCIntervalAction* pAction, float fRate);
9699
};
97100

98-
/** CCEaseOut action with a rate
101+
/**
102+
@brief CCEaseOut action with a rate
99103
*/
100104
class CCX_DLL CCEaseOut : public CCEaseRateAction
101105
{
@@ -108,7 +112,8 @@ class CCX_DLL CCEaseOut : public CCEaseRateAction
108112
static CCEaseOut* actionWithAction(CCIntervalAction* pAction, float fRate);
109113
};
110114

111-
/** CCEaseInOut action with a rate
115+
/**
116+
@brief CCEaseInOut action with a rate
112117
*/
113118
class CCX_DLL CCEaseInOut : public CCEaseRateAction
114119
{
@@ -122,7 +127,8 @@ class CCX_DLL CCEaseInOut : public CCEaseRateAction
122127
static CCEaseInOut* actionWithAction(CCIntervalAction* pAction, float fRate);
123128
};
124129

125-
/** CCEase Exponential In
130+
/**
131+
@brief CCEase Exponential In
126132
*/
127133
class CCX_DLL CCEaseExponentialIn : public CCEaseAction
128134
{
@@ -136,7 +142,8 @@ class CCX_DLL CCEaseExponentialIn : public CCEaseAction
136142
static CCEaseExponentialIn* actionWithAction(CCIntervalAction* pAction);
137143
};
138144

139-
/** Ease Exponential Out
145+
/**
146+
@brief Ease Exponential Out
140147
*/
141148
class CCX_DLL CCEaseExponentialOut : public CCEaseAction
142149
{
@@ -151,7 +158,8 @@ class CCX_DLL CCEaseExponentialOut : public CCEaseAction
151158

152159
};
153160

154-
/** Ease Exponential InOut
161+
/**
162+
@brief Ease Exponential InOut
155163
*/
156164
class CCX_DLL CCEaseExponentialInOut : public CCEaseAction
157165
{
@@ -165,7 +173,8 @@ class CCX_DLL CCEaseExponentialInOut : public CCEaseAction
165173

166174
};
167175

168-
/** Ease Sine In
176+
/**
177+
@brief Ease Sine In
169178
*/
170179
class CCX_DLL CCEaseSineIn : public CCEaseAction
171180
{
@@ -179,7 +188,8 @@ class CCX_DLL CCEaseSineIn : public CCEaseAction
179188
static CCEaseSineIn* actionWithAction(CCIntervalAction* pAction);
180189
};
181190

182-
/** Ease Sine Out
191+
/**
192+
@brief Ease Sine Out
183193
*/
184194
class CCX_DLL CCEaseSineOut : public CCEaseAction
185195
{
@@ -193,7 +203,8 @@ class CCX_DLL CCEaseSineOut : public CCEaseAction
193203
static CCEaseSineOut* actionWithAction(CCIntervalAction* pAction);
194204
};
195205

196-
/** Ease Sine InOut
206+
/**
207+
@brief Ease Sine InOut
197208
*/
198209
class CCX_DLL CCEaseSineInOut : public CCEaseAction
199210
{
@@ -206,7 +217,8 @@ class CCX_DLL CCEaseSineInOut : public CCEaseAction
206217
static CCEaseSineInOut* actionWithAction(CCIntervalAction* pAction);
207218
};
208219

209-
/** Ease Elastic abstract class
220+
/**
221+
@brief Ease Elastic abstract class
210222
@since v0.8.2
211223
*/
212224
class CCX_DLL CCEaseElastic : public CCEaseAction
@@ -235,7 +247,8 @@ class CCX_DLL CCEaseElastic : public CCEaseAction
235247
float m_fPeriod;
236248
};
237249

238-
/** Ease Elastic In action.
250+
/**
251+
@brief Ease Elastic In action.
239252
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
240253
@since v0.8.2
241254
*/
@@ -253,7 +266,8 @@ class CCX_DLL CCEaseElasticIn : public CCEaseElastic
253266
static CCEaseElasticIn* actionWithAction(CCIntervalAction *pAction, float fPeriod);
254267
};
255268

256-
/** Ease Elastic Out action.
269+
/**
270+
@brief Ease Elastic Out action.
257271
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
258272
@since v0.8.2
259273
*/
@@ -271,7 +285,8 @@ class CCX_DLL CCEaseElasticOut : public CCEaseElastic
271285
static CCEaseElasticOut* actionWithAction(CCIntervalAction *pAction, float fPeriod);
272286
};
273287

274-
/** Ease Elastic InOut action.
288+
/**
289+
@brief Ease Elastic InOut action.
275290
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
276291
@since v0.8.2
277292
*/
@@ -289,7 +304,8 @@ class CCX_DLL CCEaseElasticInOut : public CCEaseElastic
289304
static CCEaseElasticInOut* actionWithAction(CCIntervalAction *pAction, float fPeriod);
290305
};
291306

292-
/** CCEaseBounce abstract class.
307+
/**
308+
@brief CCEaseBounce abstract class.
293309
@since v0.8.2
294310
*/
295311
class CCX_DLL CCEaseBounce : public CCEaseAction
@@ -303,8 +319,9 @@ class CCX_DLL CCEaseBounce : public CCEaseAction
303319
static CCEaseBounce* actionWithAction(CCIntervalAction* pAction);
304320
};
305321

306-
/** CCEaseBounceIn action.
307-
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
322+
/**
323+
@brief CCEaseBounceIn action.
324+
@warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
308325
@since v0.8.2
309326
*/
310327
class CCX_DLL CCEaseBounceIn : public CCEaseBounce
@@ -319,7 +336,8 @@ class CCX_DLL CCEaseBounceIn : public CCEaseBounce
319336
static CCEaseBounceIn* actionWithAction(CCIntervalAction* pAction);
320337
};
321338

322-
/** EaseBounceOut action.
339+
/**
340+
@brief EaseBounceOut action.
323341
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
324342
@since v0.8.2
325343
*/
@@ -335,7 +353,8 @@ class CCX_DLL CCEaseBounceOut : public CCEaseBounce
335353
static CCEaseBounceOut* actionWithAction(CCIntervalAction* pAction);
336354
};
337355

338-
/** CCEaseBounceInOut action.
356+
/**
357+
@brief CCEaseBounceInOut action.
339358
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
340359
@since v0.8.2
341360
*/
@@ -350,7 +369,8 @@ class CCX_DLL CCEaseBounceInOut : public CCEaseBounce
350369
static CCEaseBounceInOut* actionWithAction(CCIntervalAction* pAction);
351370
};
352371

353-
/** CCEaseBackIn action.
372+
/**
373+
@brief CCEaseBackIn action.
354374
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
355375
@since v0.8.2
356376
*/
@@ -366,7 +386,8 @@ class CCX_DLL CCEaseBackIn : public CCEaseAction
366386
static CCEaseBackIn* actionWithAction(CCIntervalAction* pAction);
367387
};
368388

369-
/** CCEaseBackOut action.
389+
/**
390+
@brief CCEaseBackOut action.
370391
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
371392
@since v0.8.2
372393
*/
@@ -382,7 +403,8 @@ class CCX_DLL CCEaseBackOut : public CCEaseAction
382403
static CCEaseBackOut* actionWithAction(CCIntervalAction* pAction);
383404
};
384405

385-
/** CCEaseBackInOut action.
406+
/**
407+
@brief CCEaseBackInOut action.
386408
@warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
387409
@since v0.8.2
388410
*/

‎cocos2dx/include/CCGrid3DAction.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ THE SOFTWARE.
2828

2929
namespace cocos2d
3030
{
31-
/** CCWaves3D action */
31+
/**
32+
CCWaves3D action
33+
*/
3234
class CCX_DLL CCWaves3D : public CCGrid3DAction
3335
{
3436
public:

0 commit comments

Comments
 (0)