issue cocos2d#170

Author: Ming

cocos2dx/CCConfiguration.h

@@ -47,13 +47,13 @@ class CCConfiguration : public NSObject
 public:
 	CCConfiguration(void);
 
-	// OpenGL Max texture size.
+	/** OpenGL Max texture size. */
 	inline int getMaxTextureSize(void)
 	{
 		return m_nMaxTextureSize;
 	}
 
-	// OpenGL Max Modelview Stack Depth
+	/** OpenGL Max Modelview Stack Depth */
 	inline int getMaxModelviewStackDepth(void)
 	{
 		return m_nMaxModelviewStackDepth;
@@ -71,7 +71,7 @@ class CCConfiguration : public NSObject
 		return m_bSupportsNPOT;
 	}
 
-	// Whether or not PVR Texture Compressed is supported
+	/** Whether or not PVR Texture Compressed is supported */
 	inline bool isSupportsPVRTC(void)
 	{
 		return m_bSupportsPVRTC;
@@ -93,13 +93,13 @@ class CCConfiguration : public NSObject
 		return m_bSupportsDiscardFramebuffer;
 	}
 
-	// returns whether or not an OpenGL is supported
+	/** returns whether or not an OpenGL is supported */
 	bool checkForGLExtension(const std::string &searchName);
 
 	bool init(void);
 
 public:
-	// returns a shared instance of the CCConfiguration
+	/** returns a shared instance of the CCConfiguration */
 	static CCConfiguration* sharedConfiguration(void);
 };
 }//namespace   cocos2d 

cocos2dx/effects/CCGrid.h

@@ -58,15 +58,6 @@ namespace cocos2d
 		inline CGPoint getStep(void) { return m_obStep; }
 		inline void setStep(CGPoint step) { m_obStep = step; }
 
-		/** texture used, retain */
-// 		inline CCTexture2D* getTexture(void) { return m_pTexture; }
-// 		inline void setTexture(CCTexture2D *pTexture)
-// 		{
-// 			CCX_SAFE_RETAIN(pTexture);
-// 			CCX_SAFE_RELEASE(m_pTexture);
-// 			m_pTexture = pTexture;
-// 		}
-
 		/** is texture flipped */
 		inline bool isTextureFlipped(void) { return m_bIsTextureFlipped; }
 		void setIsTextureFlipped(bool bFlipped);

cocos2dx/include/CCAction.h

@@ -67,26 +67,30 @@ class CCX_DLL CCAction : public NSObject
 	//! * 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'.
-	 */
-	CCNode* getTarget(void) { return m_pTarget; }
-
+	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'.
+	*/
+	inline void setTarget(CCNode *pTarget) { m_pTarget = pTarget; }
+	
+	inline CCNode* getOriginalTarget(void) { return m_pOriginalTarget; } 
 	/** 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.
-	 @since v0.8.2
+	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
 	*/
-	CCNode* getOriginalTarget(void) { return m_pOriginalTarget; } 
+	inline void setOriginalTarget(CCNode *pOriginalTarget) { m_pOriginalTarget = pOriginalTarget; }
 
-	 // The action tag. An identifier of the action
-	int getTag(void) { return m_nTag; }
-	void setTag(int nTag) { m_nTag = nTag; }
+	 /** 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:
-	// Allocates and initializes the action
+	/** Allocates and initializes the action */
 	static CCAction* action();
 
 protected:
@@ -107,10 +111,10 @@ class CCX_DLL CCFiniteTimeAction : public CCAction
 	CCFiniteTimeAction(){}
 	virtual ~CCFiniteTimeAction(){}
     //! duration in seconds of the action
-	ccTime getDuration(void) { return m_fDuration; }
-	void setDuration(ccTime duration) { m_fDuration = duration; }
+	inline ccTime getDuration(void) { return m_fDuration; }
+	inline void setDuration(ccTime duration) { m_fDuration = duration; }
 
-	// returns a reversed action
+	/** returns a reversed action */
 	virtual CCFiniteTimeAction* reverse(void);
 protected:
 	//! duration in seconds
@@ -131,13 +135,12 @@ class CCX_DLL CCSpeed : public CCAction
 	CCSpeed(){}
 	virtual ~CCSpeed(void);
 
-	// alter the speed of the inner function in runtime
-	float getSpeed(void) { return m_fSpeed; }
-	void setSpeed(float fSpeed) { m_fSpeed = fSpeed; }
+	inline float getSpeed(void) { return m_fSpeed; }
+	/** alter the speed of the inner function in runtime */
+	inline void setSpeed(float fSpeed) { m_fSpeed = fSpeed; }
 
-	// initializes the action
+	/** initializes the action */
 	bool initWithAction(CCIntervalAction *pAction, float fRate);
-/*	CCSpeed* initWithAction(CCRepeatForever *pAction, float fRate);*/
 
 	virtual NSObject* copyWithZone(NSZone *pZone);
 	virtual void startWithTarget(CCNode* pTarget);
@@ -147,20 +150,18 @@ class CCX_DLL CCSpeed : public CCAction
 	virtual CCIntervalAction* reverse(void);
 
 public:
-	// creates the action
+	/** creates the action */
 	static CCSpeed* actionWithAction(CCIntervalAction *pAction, float fRate);
-	/*static CCSpeed* actionWithAction(CCRepeatForever *pAction, float fRate);*/
 
 protected:
 	float m_fSpeed;
 	CCIntervalAction *m_pOther;
-	/*CCRepeatForever *m_pRepeat;*/
 };
 
 /** CCFollow is an action that "follows" a node.
  
  Eg:
-	[layer runAction: [CCFollow actionWithTarget:hero]];
+	layer->runAction(CCFollow::actionWithTarget(hero));
  
  Instead of using CCCamera as a "follower", use this action instead.
  @since v0.99.2
@@ -174,15 +175,15 @@ class CCX_DLL CCFollow : public CCAction
 public:
 	CCFollow(){}
 	virtual ~CCFollow(void);
+	
+	inline bool isBoundarySet(void) { return m_bBoundarySet; }
+	/** alter behavior - turn on/off boundary */
+	inline void setBoudarySet(bool bValue) { m_bBoundarySet = bValue; }
 
-	// alter behavior - turn on/off boundary
-	bool isBoundarySet(void) { return m_bBoundarySet; }
-	void setBoudarySet(bool bValue) { m_bBoundarySet = bValue; }
-
-	// initializes the action
+	/** initializes the action */
 	bool initWithTarget(CCNode *pFollowedNode);
 
-	// initializes the action with a set boundary
+	/** initializes the action with a set boundary */
 	bool initWithTarget(CCNode *pFollowedNode, CGRect rect);
 
 	virtual NSObject* copyWithZone(NSZone *pZone);
@@ -191,10 +192,10 @@ class CCX_DLL CCFollow : public CCAction
 	virtual void stop(void);
 
 public:
-	// creates the action with no boundary set
+	/** creates the action with no boundary set */
 	static CCFollow* actionWithTarget(CCNode *pFollowedNode);
 
-	// creates the action with a set boundary
+	/** creates the action with a set boundary */
 	static CCFollow* actionWithTarget(CCNode *pFollowedNode, CGRect rect);
 
 protected:

cocos2dx/include/CCActionManager.h

@@ -117,7 +117,7 @@ class CCX_DLL CCActionManager : public NSObject, public SelectorProtocol
 	virtual void selectorProtocolRelease(void);
 
 public:
-	// returns a shared instance of the CCActionManager 
+	/** returns a shared instance of the CCActionManager */
 	static CCActionManager* getSharedManager(void);
 
 protected:

cocos2dx/include/CCCamera.h

@@ -54,30 +54,30 @@ class CCX_DLL CCCamera : public NSObject
 
 	char * description(void);
 
-	// sets the dirty value
+	/** sets the dirty value */
 	inline void setDirty(bool bValue) { m_bDirty = bValue; }
-	// get the dirty value
+	/** get the dirty value */
 	inline bool getDirty(void) { return m_bDirty; }
 
-	// sets the camera in the defaul position
+	/** sets the camera in the default position */
 	void restore(void);
-	// Sets the camera using gluLookAt using its eye, center and up_vector
+	/** Sets the camera using gluLookAt using its eye, center and up_vector */
 	void locate(void);
-    // sets the eye values
+    /** sets the eye values */
 	void setEyeXYZ(float fEyeX, float fEyeY, float fEyeZ);
-	// sets the center values
+	/** sets the center values */
 	void setCenterXYZ(float fCenterX, float fCenterY, float fCenterZ);
-	// sets the up values
+	/** sets the up values */
 	void setUpXYZ(float fUpX, float fUpY, float fUpZ);
 
-	// get the eye vector values
+	/** get the eye vector values */
 	void getEyeXYZ(float *pEyeX, float *pEyeY, float *pEyeZ);
-	// get the center vector values
+	/** get the center vector values */
 	void getCenterXYZ(float *pCenterX, float *pCenterY, float *pCenterZ);
-	// get the up vector values
+	/** get the up vector values */
 	void getUpXYZ(float *pUpX, float *pUpY, float *pUpZ);
 public:
-	// returns the Z eye
+	/** returns the Z eye */
 	static float getZEye();
 
 private: