issue cocos2d#170

Author: Ming

cocos2dx/include/CCAction.h

@@ -29,6 +29,7 @@ THE SOFTWARE.
 #include "NSObject.h"
 #include "NSZone.h"
 #include "CCNode.h"
+
 namespace   cocos2d {
 
 enum {
@@ -55,39 +56,38 @@ class CCX_DLL CCAction : public NSObject
 	//! called before the action start. It will also set the target.
 	virtual void startWithTarget(CCNode *pTarget);
 
-	//! called after the action has finished. It will set the 'target' to nil.
-    //! IMPORTANT: You should never call "[action stop]" manually. Instead, use: "[target stopAction:action];"
+	/** 
+	called after the action has finished. It will set the 'target' to nil.
+    IMPORTANT: You should never call "[action stop]" manually. Instead, use: "target->stopAction(action);"
+	*/
     virtual void stop(void);
 
 	//! called every frame with it's delta time. DON'T override unless you know what you are doing.
 	virtual void step(ccTime dt);
 
-	//! called once per frame. time a value between 0 and 1
-	//! For example: 
-	//! * 0 means that the action just started
-	//! * 0.5 means that the action is in the middle
-	//! * 1 means that the action is over
+	/** 
+	called once per frame. time a value between 0 and 1
+
+	For example: 
+	- 0 means that the action just started
+	- 0.5 means that the action is in the middle
+	- 1 means that the action is over
+	*/
 	virtual void update(ccTime time);
 
 	inline CCNode* getTarget(void) { return m_pTarget; }
-	/** The "target". The action will modify the target properties.
-	The target will be set with the 'startWithTarget' method.
-	When the 'stop' method is called, target will be set to nil.
-	The target is 'assigned', it is not 'retained'.
-	*/
+	/** The action will modify the target properties. */
 	inline void setTarget(CCNode *pTarget) { m_pTarget = pTarget; }
 
 	inline CCNode* getOriginalTarget(void) { return m_pOriginalTarget; } 
-	/** The original target, since target can be nil.
+	/** Set the original target, since target can be nil.
 	Is the target that were used to run the action. Unless you are doing something complex, like ActionManager, you should NOT call this method.
 	The target is 'assigned', it is not 'retained'.
 	@since v0.8.2
 	*/
 	inline void setOriginalTarget(CCNode *pOriginalTarget) { m_pOriginalTarget = pOriginalTarget; }
 
-	 /** The action tag. An identifier of the action */
 	inline int getTag(void) { return m_nTag; }
-	//! The tag is 'assigned', it is not 'retained'.
 	inline void setTag(int nTag) { m_nTag = nTag; }
 
 public:
@@ -96,7 +96,13 @@ class CCX_DLL CCAction : public NSObject
 
 protected:
 	CCNode	*m_pOriginalTarget;
+	/** The "target".
+	The target will be set with the 'startWithTarget' method.
+	When the 'stop' method is called, target will be set to nil.
+	The target is 'assigned', it is not 'retained'.
+	*/
 	CCNode	*m_pTarget;
+	/** The action tag. An identifier of the action */
 	int 		m_nTag;
 };
 
@@ -114,8 +120,9 @@ class CCX_DLL CCFiniteTimeAction : public CCAction
 public:
 	CCFiniteTimeAction(){}
 	virtual ~CCFiniteTimeAction(){}
-    //! duration in seconds of the action
+    //! get duration in seconds of the action
 	inline ccTime getDuration(void) { return m_fDuration; }
+	//! set duration in seconds of the action
 	inline void setDuration(ccTime duration) { m_fDuration = duration; }
 
 	/** returns a reversed action */
@@ -211,7 +218,7 @@ class CCX_DLL CCFollow : public CCAction
 	// whether camera should be limited to certain area
 	bool m_bBoundarySet;
 
-	// if screensize is bigger than the boundary - update not needed
+	// if screen size is bigger than the boundary - update not needed
 	bool m_bBoundaryFullyCovered;
 
 	// fast access to the screen dimensions

cocos2dx/include/CCActionManager.h

@@ -54,14 +54,14 @@ class CCX_DLL CCActionManager : public NSObject, public SelectorProtocol
 
     // actions
 
-	/** Adds an action with a target.
+	/** Adds an action with a target. 
 	 If the target is already present, then the action will be added to the existing target.
-	 If the target is not present, a new instance of this target will be created either paused or paused, and the action will be added to the newly created target.
+	 If the target is not present, a new instance of this target will be created either paused or not, and the action will be added to the newly created target.
 	 When the target is paused, the queued actions won't be 'ticked'.
 	 */
 	void addAction(CCAction *pAction, CCNode *pTarget, bool paused);
 
-    /** Removes all actions from all the targers.
+    /** Removes all actions from all the targets.
     */
 	void removeAllActions(void);
 
@@ -82,10 +82,10 @@ class CCX_DLL CCActionManager : public NSObject, public SelectorProtocol
 	 */
 	CCAction* getActionByTag(int tag, NSObject *pTarget);
 
-    /** Returns the numbers of actions that are running in a certain target
+    /** Returns the numbers of actions that are running in a certain target. 
 	 * Composable actions are counted as 1 action. Example:
-	 *    If you are running 1 Sequence of 7 actions, it will return 1.
-	 *    If you are running 7 Sequences of 2 actions, it will return 7.
+	 * - If you are running 1 Sequence of 7 actions, it will return 1.
+	 * - If you are running 7 Sequences of 2 actions, it will return 7.
 	 */
 	int numberOfRunningActionsInTarget(NSObject *pTarget);
 

cocos2dx/include/CCDirector.h

@@ -105,15 +105,15 @@ typedef enum {
 	 * Features and Limitations:
 	 * - Integrates OK with UIKit objects
 	 * - It the slowest director
-	 * - The invertal update is customizable from 1 to 60
+	 * - The interval update is customizable from 1 to 60
 	 */
 	kCCDirectorTypeNSTimer,
 
 	/** will use a Director that triggers the main loop from a custom main loop.
 	 *
 	 * Features and Limitations:
 	 * - Faster than NSTimer Director
-	 * - It doesn't integrate well with UIKit objecgts
+	 * - It doesn't integrate well with UIKit objects
 	 * - The interval update can't be customizable
 	 */
 	kCCDirectorTypeMainLoop,
@@ -122,7 +122,7 @@ typedef enum {
 	 *
 	 * Features and Limitations:
 	 * - Faster than NSTimer Director
-	 * - It doesn't integrate well with UIKit objecgts
+	 * - It doesn't integrate well with UIKit objects
 	 * - The interval update can't be customizable
 	 */
 	kCCDirectorTypeThreadMainLoop,
@@ -202,26 +202,26 @@ class CCX_DLL CCDirector : public NSObject
 
 	// attribute
 
-	/** The current running Scene. Director can only run one Scene at the time */
+	/** Get current running Scene. Director can only run one Scene at the time */
 	inline CCScene* getRunningScene(void) { return m_pRunningScene; }
 
-	/** The FPS value */
+	/** Get the FPS value */
 	inline double getAnimationInterval(void) { return m_dAnimationInterval; }
+	/** Set the FPS value. Now it has not effect. */
 	virtual void setAnimationInterval(double dValue);
 
 	/** Whether or not to display the FPS on the bottom-left corner */
 	inline bool isDisplayFPS(void) { return m_bDisplayFPS; }
+	/** Display the FPS on the bottom-left corner */
 	inline void setDisplayFPS(bool bDisplayFPS) { m_bDisplayFPS = bDisplayFPS; }
 
-	/** The CCXEGLView, where everything is rendered */
+	/** Get the CCXEGLView, where everything is rendered */
 	inline cocos2d::CCXEGLView* getOpenGLView(void) { return m_pobOpenGLView; }
 	void setOpenGLView(cocos2d::CCXEGLView *pobOpenGLView);
 
-	/** whether or not the next delta time will be zero */
 	inline bool isNextDeltaTimeZero(void) { return m_bNextDeltaTimeZero; }
 	void setNextDeltaTimeZero(bool bNextDeltaTimeZero);
 
-	/** The device orientation */
 	inline ccDeviceOrientation getDeviceOrientation(void) { return m_eDeviceOrientation; }
 	void setDeviceOrientation(ccDeviceOrientation kDeviceOrientation);
 
@@ -435,6 +435,7 @@ class CCX_DLL CCDirector : public NSObject
 	void recalculateProjectionAndEAGLViewSize();
 
 protected:
+	/* The CCXEGLView, where everything is rendered */
     cocos2d::CCXEGLView	*m_pobOpenGLView;
 
 	double m_dAnimationInterval;
@@ -446,11 +447,10 @@ class CCX_DLL CCDirector : public NSObject
 	/* landscape mode ? */
 	bool m_bLandscape;
 
-	/* orientation */
+	/* The device orientation */
 	ccDeviceOrientation	m_eDeviceOrientation;
 
-	/* display FPS ? */
-	bool   m_bDisplayFPS;
+	bool m_bDisplayFPS;
 	int  m_nFrames;
 	ccTime m_fAccumDt;
 	ccTime m_fFrameRate;

cocos2dx/include/CCGrid3DAction.h

@@ -34,21 +34,20 @@ namespace cocos2d
 	class CCX_DLL CCWaves3D : public CCGrid3DAction
 	{
 	public:
-		/** get amplitude of the wave */
 		inline float getAmplitude(void) { return m_fAmplitude; }
-		/** set amplitude of the wave */
 		inline void setAmplitude(float fAmplitude) { m_fAmplitude = fAmplitude; }
-		/** get amplitude rate of the wave */
+
 		inline float getAmplitudeRate(void) { return m_fAmplitudeRate; }
-		/** set amplitude rate of the wave */
 		inline void setAmplitudeRate(float fAmplitudeRate) { m_fAmplitudeRate = fAmplitudeRate; }
 
+		/** init the action */
 		bool initWithWaves(int wav, float amp, ccGridSize gridSize, ccTime duration);
 
 		virtual NSObject* copyWithZone(NSZone* pZone);
 		virtual void update(ccTime time);
 
 	public:
+		/** create the action */
 		static CCWaves3D* actionWithWaves(int wav, float amp, ccGridSize gridSize, ccTime duration);
 
 	protected:
@@ -88,10 +87,11 @@ namespace cocos2d
 	class CCX_DLL CCLens3D : public CCGrid3DAction
 	{
 	public:
-		/** lens effect. Defaults to 0.7 - 0 means no effect, 1 is very strong effect */
+		/** Get lens center position */
 		inline float getLensEffect(void) { return m_fLensEffect; }
+		/** Set lens center position */
 		inline void setLensEffect(float fLensEffect) { m_fLensEffect = fLensEffect; }
-		/** lens center position */
+		
 		inline CGPoint getPosition(void) { return m_position; }
 		inline void setPosition(CGPoint position) { m_position = position; }
 
@@ -104,8 +104,10 @@ namespace cocos2d
 		/** creates the action with center position, radius, a grid size and duration */
         static CCLens3D* actionWithPosition(CGPoint pos, float r, ccGridSize gridSize, ccTime duration);
 	protected:
+		/* lens center position */
 		CGPoint m_position;
 		float m_fRadius;
+		/** lens effect. Defaults to 0.7 - 0 means no effect, 1 is very strong effect */
 		float m_fLensEffect;
 		CGPoint m_lastPosition;
 	};
@@ -114,13 +116,14 @@ namespace cocos2d
 	class CCX_DLL CCRipple3D : public CCGrid3DAction
 	{
 	public:
-		/** center position */
+		/** get center position */
 		inline CGPoint getPosition(void) { return m_position; }
+		/** set center position */
 		inline void setPosition(CGPoint position) { m_position = position; }
-		/** amplitude */
+
 		inline float getAmplitude(void) { return m_fAmplitude; }
 		inline void setAmplitude(float fAmplitude) { m_fAmplitude = fAmplitude; }
-		/** amplitude rate */
+
 		inline float getAmplitudeRate(void) { return m_fAmplitudeRate; }
 		inline void setAmplitudeRate(float fAmplitudeRate) { m_fAmplitudeRate = fAmplitudeRate; }
 
@@ -135,6 +138,7 @@ namespace cocos2d
 		static CCRipple3D* actionWithPosition(CGPoint pos, float r, int wav, float amp, 
 			ccGridSize gridSize, ccTime duration);
 	protected:
+		/* center position */
 		CGPoint m_position;
 		float m_fRadius;
 		int m_nWaves;
@@ -164,10 +168,9 @@ namespace cocos2d
 	class CCX_DLL CCLiquid : public CCGrid3DAction
 	{
 	public:
-		/** amplitude */
 		inline float getAmplitude(void) { return m_fAmplitude; }
 		inline void setAmplitude(float fAmplitude) { m_fAmplitude = fAmplitude; }
-		/** amplitude rate */
+
 		inline float getAmplitudeRate(void) { return m_fAmplitudeRate; }
 		inline void setAmplitudeRate(float fAmplitudeRate) { m_fAmplitudeRate = fAmplitudeRate; }
 
@@ -190,10 +193,9 @@ namespace cocos2d
 	class CCX_DLL CCWaves : public CCGrid3DAction
 	{
 	public:
-		/** amplitude */
 		inline float getAmplitude(void) { return m_fAmplitude; }
 		inline void setAmplitude(float fAmplitude) { m_fAmplitude = fAmplitude; }
-		/** amplitude rate */
+
 		inline float getAmplitudeRate(void) { return m_fAmplitudeRate; }
 		inline void setAmplitudeRate(float fAmplitudeRate) { m_fAmplitudeRate = fAmplitudeRate; }
 
@@ -219,13 +221,14 @@ namespace cocos2d
 	class CCX_DLL CCTwirl : public CCGrid3DAction
 	{
 	public:
-		/** twirl center */
+		/** get twirl center */
 		inline CGPoint getPosition(void) { return m_position; }
+		/** set twirl center */
 		inline void setPosition(CGPoint position) { m_position = position; }
-		/** amplitude */
+
 		inline float getAmplitude(void) { return m_fAmplitude; }
 		inline void setAmplitude(float fAmplitude) { m_fAmplitude = fAmplitude; }
-		/** amplitude rate */
+
 		inline float getAmplitudeRate(void) { return m_fAmplitudeRate; }
 		inline void setAmplitudeRate(float fAmplitudeRate) { m_fAmplitudeRate = fAmplitudeRate; }
 
@@ -240,6 +243,7 @@ namespace cocos2d
 		static CCTwirl* actionWithPosition(CGPoint pos, int t, float amp, ccGridSize gridSize,
 			ccTime duration);
 	protected:
+		/* twirl center */
 		CGPoint m_position;
 		int m_nTwirls;
 		float m_fAmplitude;

cocos2dx/include/CCGridAction.h

@@ -104,8 +104,9 @@ namespace cocos2d
 		virtual void update(ccTime time);
         virtual CCIntervalAction* reverse(void);
 
-		/** amplitude rate */
+		/** get amplitude rate */
 		inline float getRate(void) { return m_fRate; }
+		/** set amplitude rate */
 		inline void setRate(float fRate) { m_fRate = fRate; }
 
 	public:
@@ -125,8 +126,9 @@ namespace cocos2d
 		/** initializes the action with an inner action that has the amplitude property, and a duration time */
 		bool initWithAction(CCAction *pAction, ccTime duration);
 
-		/** amplitude rate */
+		/** get amplitude rate */
 		inline float getRate(void) { return m_fRate; }
+		/** set amplitude rate */
 		inline void setRate(float fRate) { m_fRate = fRate; }
 
 		virtual void startWithTarget(CCNode *pTarget);
@@ -150,8 +152,9 @@ namespace cocos2d
 		/** initializes the action with an inner action that has the amplitude property, and a duration time */
 		bool initWithAction(CCAction *pAction, ccTime duration);
 
-		/** amplitude rate */
+		/** get amplitude rate */
 		inline float getRate(void) { return m_fRate; }
+		/** set amplitude rate */
 		inline void setRate(float fRate) { m_fRate = fRate; }
 
 		virtual void startWithTarget(CCNode *pTarget);