diff --git a/CocosDenshion/include/SimpleAudioEngine.h b/CocosDenshion/include/SimpleAudioEngine.h index 3449b99cac..cc4bf324bb 100644 --- a/CocosDenshion/include/SimpleAudioEngine.h +++ b/CocosDenshion/include/SimpleAudioEngine.h @@ -190,7 +190,6 @@ public: /** @brief Pause all playing sound effect - @param nSoundId The return value of function playEffect */ void pauseAllEffects(); @@ -202,7 +201,6 @@ public: /** @brief Resume all playing sound effect - @param nSoundId The return value of function playEffect */ void resumeAllEffects(); diff --git a/cocos2dx/CCDirector.h b/cocos2dx/CCDirector.h index 2ad40f4d7e..d903d46afb 100644 --- a/cocos2dx/CCDirector.h +++ b/cocos2dx/CCDirector.h @@ -465,7 +465,7 @@ protected: nextScene is a weak reference. */ Scene *_nextScene; - /* If YES, then "old" scene will receive the cleanup message */ + /* If true, then "old" scene will receive the cleanup message */ bool _sendCleanupToScene; /* scheduled scenes */ diff --git a/cocos2dx/CCScheduler.h b/cocos2dx/CCScheduler.h index 3df5cd96ec..61c94b96e0 100644 --- a/cocos2dx/CCScheduler.h +++ b/cocos2dx/CCScheduler.h @@ -140,7 +140,7 @@ public: void update(float dt); /** The scheduled method will be called every 'interval' seconds. - If paused is YES, then it won't be called until it is resumed. + If paused is true, then it won't be called until it is resumed. If 'interval' is 0, it will be called every frame, but if so, it's recommended to use 'scheduleUpdateForTarget:' instead. If the selector is already scheduled, then only the interval parameter will be updated without re-scheduling it again. repeat let the action be repeated repeat + 1 times, use kRepeatForever to let the action run continuously @@ -195,7 +195,7 @@ public: void unscheduleAllWithMinPriority(int nMinPriority); /** The scheduled script callback will be called every 'interval' seconds. - If paused is YES, then it won't be called until it is resumed. + If paused is true, then it won't be called until it is resumed. If 'interval' is 0, it will be called every frame. return schedule script entry ID, used for unscheduleScriptFunc(). */ diff --git a/cocos2dx/actions/CCAction.h b/cocos2dx/actions/CCAction.h index 82830fcd83..222cf853b8 100644 --- a/cocos2dx/actions/CCAction.h +++ b/cocos2dx/actions/CCAction.h @@ -193,7 +193,9 @@ protected: @brief Follow is an action that "follows" a node. Eg: +@code layer->runAction(Follow::actionWithTarget(hero)); +@endcode Instead of using Camera as a "follower", use this action instead. @since v0.99.2 @@ -204,10 +206,11 @@ public: /** * Creates the action with a set boundary or with no boundary. * + * @param followedNode The node to be followed. * @param rect The boundary. If \p rect is equal to Rect::ZERO, it'll work * with no boundary. */ - static Follow* create(Node *pFollowedNode, const Rect& rect = Rect::ZERO); + static Follow* create(Node *followedNode, const Rect& rect = Rect::ZERO); Follow() : _followedNode(NULL) @@ -228,10 +231,11 @@ public: /** * Initializes the action with a set boundary or with no boundary. * + * @param followedNode The node to be followed. * @param rect The boundary. If \p rect is equal to Rect::ZERO, it'll work * with no boundary. */ - bool initWithTarget(Node *pFollowedNode, const Rect& rect = Rect::ZERO); + bool initWithTarget(Node *followedNode, const Rect& rect = Rect::ZERO); // // Override diff --git a/cocos2dx/actions/CCActionGrid.h b/cocos2dx/actions/CCActionGrid.h index 61967bd506..f5a1d94e7e 100644 --- a/cocos2dx/actions/CCActionGrid.h +++ b/cocos2dx/actions/CCActionGrid.h @@ -95,13 +95,13 @@ public: /** returns the tile that belongs to a certain position of the grid */ Quad3 getTile(const Point& position) const; - /** @deprecatd Use getTile() instead */ + /** @deprecated Use getTile() instead */ CC_DEPRECATED_ATTRIBUTE Quad3 tile(const Point& position) { return getTile(position); } /** returns the non-transformed tile that belongs to a certain position of the grid */ Quad3 getOriginalTile(const Point& position) const; - /** @deprecatd Use getOriginalTile() instead */ + /** @deprecated Use getOriginalTile() instead */ CC_DEPRECATED_ATTRIBUTE Quad3 originalTile(const Point& position) { return getOriginalTile(position); } /** sets a new tile to a certain position of the grid */ diff --git a/cocos2dx/actions/CCActionInterval.h b/cocos2dx/actions/CCActionInterval.h index 0b0d534a3c..8e7f387ed9 100644 --- a/cocos2dx/actions/CCActionInterval.h +++ b/cocos2dx/actions/CCActionInterval.h @@ -461,7 +461,7 @@ public: virtual JumpTo* reverse(void) const override; }; -/** @typedef bezier configuration structure +/** Bezier configuration structure */ typedef struct _ccBezierConfig { //! end position of the bezier diff --git a/cocos2dx/actions/CCActionTween.h b/cocos2dx/actions/CCActionTween.h index 1122da514a..8c51e39b41 100644 --- a/cocos2dx/actions/CCActionTween.h +++ b/cocos2dx/actions/CCActionTween.h @@ -46,16 +46,18 @@ public: ActionTween is an action that lets you update any property of an object. For example, if you want to modify the "width" property of a target from 200 to 300 in 2 seconds, then: - id modifyWidth = [ActionTween actionWithDuration:2 key:@"width" from:200 to:300]; - [target runAction:modifyWidth]; - + @code + auto modifyWidth = ActionTween::create(2, "width", 200, 300); + target->runAction(modifyWidth); + @endcode Another example: ScaleTo action could be rewritten using PropertyAction: - // scaleA and scaleB are equivalents - id scaleA = [ScaleTo actionWithDuration:2 scale:3]; - id scaleB = [ActionTween actionWithDuration:2 key:@"scale" from:1 to:3]; - + @code + // scaleA and scaleB are equivalents + auto scaleA = ScaleTo::create(2, 3); // (duration, to) + auto scaleB = ActionTween::create(2, "scale", 1, 3); // (duration, key, from, to) + @endcode @since v0.99.2 */ diff --git a/cocos2dx/base_nodes/CCNode.h b/cocos2dx/base_nodes/CCNode.h index 50e07ffed4..2c892ff63a 100644 --- a/cocos2dx/base_nodes/CCNode.h +++ b/cocos2dx/base_nodes/CCNode.h @@ -174,7 +174,7 @@ public: * The larger number it is, the later this node will be drawn in each message loop. * Please refer to setVertexZ(float) for the difference. * - * @param nZOrder Z order of this node. + * @param zOrder Z order of this node. */ virtual void setZOrder(int zOrder); /** @@ -206,7 +206,7 @@ public: * * @warning Use it at your own risk since it might break the cocos2d parent-children z order * - * @param fVertexZ OpenGL Z vertex of this node. + * @param vertexZ OpenGL Z vertex of this node. */ virtual void setVertexZ(float vertexZ); /** @@ -462,9 +462,9 @@ public: * 0 is the default rotation angle. * Positive values rotate node clockwise, and negative values for anti-clockwise. * - * @param fRotationX The X rotation in degrees which performs a horizontal rotational skew. + * @param rotationX The X rotation in degrees which performs a horizontal rotational skew. */ - virtual void setRotationX(float rotaionX); + virtual void setRotationX(float rotationX); /** * Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. * @@ -481,7 +481,7 @@ public: * 0 is the default rotation angle. * Positive values rotate node clockwise, and negative values for anti-clockwise. * - * @param fRotationY The Y rotation in degrees. + * @param rotationY The Y rotation in degrees. */ virtual void setRotationY(float rotationY); /** @@ -1062,6 +1062,7 @@ public: * this->schedule(schedule_selector(MyNode::TickMe), 0, 0, 0); * @endcode * + * @param selector The SEL_SCHEDULE selector to be scheduled. * @param interval Tick interval in seconds. 0 means tick every frame. If interval = 0, it's recommended to use scheduleUpdate() instead. * @param repeat The selector will be excuted (repeat + 1) times, you can use kRepeatForever for tick infinitely. * @param delay The amount of time that the first tick will wait before execution. @@ -1072,7 +1073,7 @@ public: * Schedules a custom selector with an interval time in seconds. * @see schedule(SEL_SCHEDULE, float, unsigned int, float) * - * @param selector A function wrapped as a selector + * @param selector The SEL_SCHEDULE selector to be scheduled. * @param interval Callback interval time in seconds. 0 means tick every frame, */ void schedule(SEL_SCHEDULE selector, float interval); @@ -1081,7 +1082,7 @@ public: * Schedules a selector that runs only once, with a delay of 0 or larger * @see schedule(SEL_SCHEDULE, float, unsigned int, float) * - * @param selector A function wrapped as a selector + * @param selector The SEL_SCHEDULE selector to be scheduled. * @param delay The amount of time that the first tick will wait before execution. */ void scheduleOnce(SEL_SCHEDULE selector, float delay); diff --git a/cocos2dx/cocoa/CCGeometry.h b/cocos2dx/cocoa/CCGeometry.h index ec9c285418..7b5ca63430 100644 --- a/cocos2dx/cocoa/CCGeometry.h +++ b/cocos2dx/cocoa/CCGeometry.h @@ -246,24 +246,18 @@ public: } /** A general line-line intersection test - @param p1 - is the startpoint for the first line P1 = (p1 - p2) - @param p2 - is the endpoint for the first line P1 = (p1 - p2) - @param p3 - is the startpoint for the second line P2 = (p3 - p4) - @param p4 - is the endpoint for the second line P2 = (p3 - p4) - @param s - is the range for a hitpoint in P1 (pa = p1 + s*(p2 - p1)) - @param t - is the range for a hitpoint in P3 (pa = p2 + t*(p4 - p3)) - @return bool - indicating successful intersection of a line - note that to truly test intersection for segments we have to make - sure that s & t lie within [0..1] and for rays, make sure s & t > 0 - the hit point is p3 + t * (p4 - p3); - the hit point also is p1 + s * (p2 - p1); + @param A the startpoint for the first line L1 = (A - B) + @param B the endpoint for the first line L1 = (A - B) + @param C the startpoint for the second line L2 = (C - D) + @param D the endpoint for the second line L2 = (C - D) + @param S the range for a hitpoint in L1 (p = A + S*(B - A)) + @param T the range for a hitpoint in L2 (p = C + T*(D - C)) + @returns whether these two lines interects. + + Note that to truly test intersection for segments we have to make + sure that S & T lie within [0..1] and for rays, make sure S & T > 0 + the hit point is C + T * (D - C); + the hit point also is A + S * (B - A); @since 3.0 */ static bool isLineIntersect(const Point& A, const Point& B, @@ -271,7 +265,7 @@ public: float *S, float *T); /* - returns YES if Segment A-B intersects with segment C-D + returns true if Segment A-B intersects with segment C-D @since v3.0 */ static bool isSegmentIntersect(const Point& A, const Point& B, const Point& C, const Point& D); diff --git a/cocos2dx/include/CCDeprecated.h b/cocos2dx/include/CCDeprecated.h index 71460128de..c4aea72386 100644 --- a/cocos2dx/include/CCDeprecated.h +++ b/cocos2dx/include/CCDeprecated.h @@ -357,7 +357,7 @@ CC_DEPRECATED_ATTRIBUTE static inline bool ccpLineIntersect(const Point& p1, con } /* - ccpSegmentIntersect returns YES if Segment A-B intersects with segment C-D + ccpSegmentIntersect returns true if Segment A-B intersects with segment C-D @since v1.0.0 */ CC_DEPRECATED_ATTRIBUTE static inline bool ccpSegmentIntersect(const Point& A, const Point& B, const Point& C, const Point& D) diff --git a/cocos2dx/include/CCProtocols.h b/cocos2dx/include/CCProtocols.h index f3d6c46cc3..899dde5f3e 100644 --- a/cocos2dx/include/CCProtocols.h +++ b/cocos2dx/include/CCProtocols.h @@ -78,7 +78,7 @@ public: /** * Changes the opacity. * - * @param value Goes from 0 to 255, where 255 means fully opaque and 0 means fully transparent. + * @param opacity Goes from 0 to 255, where 255 means fully opaque and 0 means fully transparent. */ virtual void setOpacity(GLubyte opacity) = 0; @@ -89,10 +89,10 @@ public: * If thie property is set to true, then the rendered color will be affected by opacity. * Normally, r = r * opacity/255, g = g * opacity/255, b = b * opacity/255. * - * @param bValue true then the opacity will be applied as: glColor(R,G,B,opacity); - * false then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity); + * @param value If true, then the opacity will be applied as: glColor(R,G,B,opacity); + * If false, then the opacity will be applied as: glColor(opacity, opacity, opacity, opacity); */ - virtual void setOpacityModifyRGB(bool bValue) = 0; + virtual void setOpacityModifyRGB(bool value) = 0; /** * Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) diff --git a/cocos2dx/layers_scenes_transitions_nodes/CCLayer.h b/cocos2dx/layers_scenes_transitions_nodes/CCLayer.h index 9a9e63bc76..24df564cba 100644 --- a/cocos2dx/layers_scenes_transitions_nodes/CCLayer.h +++ b/cocos2dx/layers_scenes_transitions_nodes/CCLayer.h @@ -302,7 +302,7 @@ public: bool initWithColor(const Color4B& start, const Color4B& end, const Point& v); /** Whether or not the interpolation will be compressed in order to display all the colors of the gradient both in canonical and non canonical vectors - Default: YES + Default: true */ void setCompressedInterpolation(bool bCompressedInterpolation); bool isCompressedInterpolation() const; @@ -385,11 +385,11 @@ public: void addLayer(Layer* layer); /** switches to a certain layer indexed by n. - The current (old) layer will be removed from it's parent with 'cleanup:YES'. + The current (old) layer will be removed from it's parent with 'cleanup=true'. */ void switchTo(unsigned int n); /** release the current layer and switches to another layer indexed by n. - The current (old) layer will be removed from it's parent with 'cleanup:YES'. + The current (old) layer will be removed from it's parent with 'cleanup=true'. */ void switchToAndReleaseMe(unsigned int n); diff --git a/cocos2dx/misc_nodes/CCClippingNode.h b/cocos2dx/misc_nodes/CCClippingNode.h index 45e612c24c..e4c14308cc 100644 --- a/cocos2dx/misc_nodes/CCClippingNode.h +++ b/cocos2dx/misc_nodes/CCClippingNode.h @@ -76,9 +76,9 @@ public: GLfloat getAlphaThreshold() const; void setAlphaThreshold(GLfloat fAlphaThreshold); - /** Inverted. If this is set to YES, + /** Inverted. If this is set to true, the stencil is inverted, so the content is drawn where the stencil is NOT drawn. - This default to NO. + This default to false. */ bool isInverted() const; void setInverted(bool bInverted); diff --git a/cocos2dx/misc_nodes/CCRenderTexture.h b/cocos2dx/misc_nodes/CCRenderTexture.h index c65143baf8..87854810cb 100644 --- a/cocos2dx/misc_nodes/CCRenderTexture.h +++ b/cocos2dx/misc_nodes/CCRenderTexture.h @@ -106,12 +106,12 @@ public: CC_DEPRECATED_ATTRIBUTE Image* newCCImage(bool flipImage = true) { return newImage(flipImage); }; /** saves the texture into a file using JPEG format. The file will be saved in the Documents folder. - Returns YES if the operation is successful. + Returns true if the operation is successful. */ bool saveToFile(const char *szFilePath); /** saves the texture into a file. The format could be JPG or PNG. The file will be saved in the Documents folder. - Returns YES if the operation is successful. + Returns true if the operation is successful. */ bool saveToFile(const char *name, Image::Format format); @@ -125,7 +125,7 @@ public: */ void listenToForeground(Object *obj); - /** Valid flags: GL_COLOR_BUFFER_BIT, GL_DEPTH_BUFFER_BIT, GL_STENCIL_BUFFER_BIT. They can be OR'ed. Valid when "autoDraw is YES. */ + /** Valid flags: GL_COLOR_BUFFER_BIT, GL_DEPTH_BUFFER_BIT, GL_STENCIL_BUFFER_BIT. They can be OR'ed. Valid when "autoDraw" is true. */ inline unsigned int getClearFlags() const { return _clearFlags; }; inline void setClearFlags(unsigned int clearFlags) { _clearFlags = clearFlags; }; @@ -133,11 +133,11 @@ public: inline const Color4F& getClearColor() const { return _clearColor; }; inline void setClearColor(const Color4F &clearColor) { _clearColor = clearColor; }; - /** Value for clearDepth. Valid only when autoDraw is true. */ + /** Value for clearDepth. Valid only when "autoDraw" is true. */ inline float getClearDepth() const { return _clearDepth; }; inline void setClearDepth(float clearDepth) { _clearDepth = clearDepth; }; - /** Value for clear Stencil. Valid only when autoDraw is true */ + /** Value for clear Stencil. Valid only when "autoDraw" is true */ inline int getClearStencil() const { return _clearStencil; }; inline void setClearStencil(int clearStencil) { _clearStencil = clearStencil; }; diff --git a/cocos2dx/particle_nodes/CCParticleSystemQuad.h b/cocos2dx/particle_nodes/CCParticleSystemQuad.h index 528e1d429d..47d7d41f30 100644 --- a/cocos2dx/particle_nodes/CCParticleSystemQuad.h +++ b/cocos2dx/particle_nodes/CCParticleSystemQuad.h @@ -73,7 +73,7 @@ public: void initTexCoordsWithRect(const Rect& rect); /** Sets a new SpriteFrame as particle. - WARNING: this method is experimental. Use setTexture:withRect instead. + WARNING: this method is experimental. Use setTextureWithRect instead. @since v0.99.4 */ void setDisplayFrame(SpriteFrame *spriteFrame); diff --git a/cocos2dx/platform/CCApplicationProtocol.h b/cocos2dx/platform/CCApplicationProtocol.h index b567072279..48f93f3b3d 100644 --- a/cocos2dx/platform/CCApplicationProtocol.h +++ b/cocos2dx/platform/CCApplicationProtocol.h @@ -39,20 +39,18 @@ public: virtual bool applicationDidFinishLaunching() = 0; /** - @brief The function be called when the application enter background - @param the pointer of the application + @brief This function will be called when the application enters background. */ virtual void applicationDidEnterBackground() = 0; /** - @brief The function be called when the application enter foreground - @param the pointer of the application + @brief This function will be called when the application enters foreground. */ virtual void applicationWillEnterForeground() = 0; /** @brief Callback by Director for limit FPS. - @interval The time, expressed in seconds, between current frame and next. + @param interval The time, expressed in seconds, between current frame and next. */ virtual void setAnimationInterval(double interval) = 0; diff --git a/cocos2dx/platform/CCFileUtils.h b/cocos2dx/platform/CCFileUtils.h index ec01aba5ab..c0b0baca41 100644 --- a/cocos2dx/platform/CCFileUtils.h +++ b/cocos2dx/platform/CCFileUtils.h @@ -102,11 +102,11 @@ public: * Gets resource file data from a zip file. * * @param[in] filename The resource file name which contains the relative path of the zip file. - * @param[out] pSize If the file read operation succeeds, it will be the data size, otherwise 0. + * @param[out] size If the file read operation succeeds, it will be the data size, otherwise 0. * @return Upon success, a pointer to the data is returned, otherwise NULL. * @warning Recall: you are responsible for calling delete[] on any Non-NULL pointer returned. */ - virtual unsigned char* getFileDataFromZip(const char* pszZipFilePath, const char* filename, unsigned long * pSize); + virtual unsigned char* getFileDataFromZip(const char* pszZipFilePath, const char* filename, unsigned long *size); /** Returns the fullpath for a given filename. diff --git a/cocos2dx/platform/CCImage.h b/cocos2dx/platform/CCImage.h index 7e55f8e64f..cb9a9bee54 100644 --- a/cocos2dx/platform/CCImage.h +++ b/cocos2dx/platform/CCImage.h @@ -102,15 +102,14 @@ public: }; /** - @brief Load the image from the specified path. - @param strPath the absolute file path. - @param imageType the type of image, currently only supporting two types. - @return true if loaded correctly. + @brief Load the image from the specified path. + @param path the absolute file path. + @return true if loaded correctly. */ - bool initWithImageFile(const char * strPath); + bool initWithImageFile(const char *path); /** - @brief Load image from stream buffer. + @brief Load image from stream buffer. @param data stream buffer which holds the image data. @param dataLen data length expressed in (number of) bytes. @return true if loaded correctly. @@ -121,21 +120,21 @@ public: bool initWithRawData(void *data, int dataLen, int nWidth, int nHeight, int nBitsPerComponent = 8, bool bPreMulti = false); /** - @brief Create image with specified string. - @param pText the text the image will show (cannot be nil). - @param nWidth the image width, if 0, the width will match the text's width. - @param nHeight the image height, if 0, the height will match the text's height. - @param eAlignMask the test Alignment - @param pFontName the name of the font used to draw the text. If nil, use the default system font. - @param nSize the font size, if 0, use the system default size. + @brief Create image with specified string. + @param text the text the image will show (cannot be nil). + @param width the image width, if 0, the width will match the text's width. + @param height the image height, if 0, the height will match the text's height. + @param alignMask the test Alignment + @param fontName the name of the font used to draw the text. If nil, use the default system font. + @param size the font size, if 0, use the system default size. */ bool initWithString( - const char * pText, - int nWidth = 0, - int nHeight = 0, - TextAlign eAlignMask = TextAlign::CENTER, - const char * pFontName = 0, - int nSize = 0); + const char * text, + int width = 0, + int height = 0, + TextAlign alignMask = TextAlign::CENTER, + const char * fontName = 0, + int size = 0); #if (CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID) || (CC_TARGET_PLATFORM == CC_PLATFORM_IOS) @@ -184,10 +183,10 @@ public: /** @brief Save Image data to the specified file, with specified format. - @param pszFilePath the file's absolute path, including file suffix. - @param bIsToRGB whether the image is saved as RGB format. + @param filePath the file's absolute path, including file suffix. + @param isToRGB whether the image is saved as RGB format. */ - bool saveToFile(const char *pszFilePath, bool bIsToRGB = true); + bool saveToFile(const char *filePath, bool isToRGB = true); protected: bool initWithJpgData(void *data, int dataLen); diff --git a/cocos2dx/platform/android/CCApplication.h b/cocos2dx/platform/android/CCApplication.h index d3225516f2..244f3c4e39 100644 --- a/cocos2dx/platform/android/CCApplication.h +++ b/cocos2dx/platform/android/CCApplication.h @@ -16,7 +16,7 @@ public: /** @brief Callback by Director to limit FPS. - @interval The time, expressed in seconds, between current frame and next. + @param interval The time, expressed in seconds, between current frame and next. */ void setAnimationInterval(double interval); diff --git a/cocos2dx/platform/emscripten/CCApplication.h b/cocos2dx/platform/emscripten/CCApplication.h index 634238606f..f06100e3da 100644 --- a/cocos2dx/platform/emscripten/CCApplication.h +++ b/cocos2dx/platform/emscripten/CCApplication.h @@ -16,7 +16,7 @@ public: /** @brief Callback by Director for limit FPS. - @interval The time, which expressed in second in second, between current frame and next. + @param interval The time, which expressed in second in second, between current frame and next. */ void setAnimationInterval(double interval); diff --git a/cocos2dx/platform/ios/CCApplication.h b/cocos2dx/platform/ios/CCApplication.h index 297ddbd8c3..b4108836b1 100644 --- a/cocos2dx/platform/ios/CCApplication.h +++ b/cocos2dx/platform/ios/CCApplication.h @@ -54,7 +54,7 @@ public: /** @brief Callback by Director for limit FPS. - @interval The time, expressed in seconds, between current frame and next. + @param interval The time, expressed in seconds, between current frame and next. */ virtual void setAnimationInterval(double interval); diff --git a/cocos2dx/platform/linux/CCApplication.h b/cocos2dx/platform/linux/CCApplication.h index 1320a50ce8..81e900a1a4 100644 --- a/cocos2dx/platform/linux/CCApplication.h +++ b/cocos2dx/platform/linux/CCApplication.h @@ -23,7 +23,7 @@ public: /** @brief Callback by Director for limit FPS. - @interval The time, which expressed in second in second, between current frame and next. + @param interval The time, which expressed in second in second, between current frame and next. */ void setAnimationInterval(double interval); diff --git a/cocos2dx/platform/mac/CCApplication.h b/cocos2dx/platform/mac/CCApplication.h index ada3d28c0f..95b99cc15e 100644 --- a/cocos2dx/platform/mac/CCApplication.h +++ b/cocos2dx/platform/mac/CCApplication.h @@ -39,7 +39,7 @@ public: /** @brief Callback by Director for limit FPS. - @interval The time, which expressed in second in second, between current frame and next. + @param interval The time, which expressed in second in second, between current frame and next. */ virtual void setAnimationInterval(double interval); diff --git a/cocos2dx/platform/nacl/CCApplication.h b/cocos2dx/platform/nacl/CCApplication.h index 5b970623cb..30b9a51b4f 100644 --- a/cocos2dx/platform/nacl/CCApplication.h +++ b/cocos2dx/platform/nacl/CCApplication.h @@ -39,7 +39,7 @@ public: /** @brief Callback by Director for limit FPS. - @interval The time, which expressed in second in second, between current frame and next. + @param interval The time, which expressed in second in second, between current frame and next. */ void setAnimationInterval(double interval); diff --git a/cocos2dx/platform/qt5/CCApplication.h b/cocos2dx/platform/qt5/CCApplication.h index 7ad25e463e..2ed77bb8bf 100644 --- a/cocos2dx/platform/qt5/CCApplication.h +++ b/cocos2dx/platform/qt5/CCApplication.h @@ -45,7 +45,7 @@ class Application : public ApplicationProtocol { /** @brief Callback by Director for limit FPS. - @interval The time, which expressed in second in second, between current frame and next. + @param interval The time, which expressed in second in second, between current frame and next. */ void setAnimationInterval(double interval); diff --git a/cocos2dx/platform/tizen/CCApplication.h b/cocos2dx/platform/tizen/CCApplication.h index 53f8dc5cc9..13a0205be3 100644 --- a/cocos2dx/platform/tizen/CCApplication.h +++ b/cocos2dx/platform/tizen/CCApplication.h @@ -43,7 +43,7 @@ public: /** @brief Callback by Director to limit FPS. - @interval The time, expressed in seconds, between current frame and next. + @param interval The time, expressed in seconds, between current frame and next. */ void setAnimationInterval(double interval); long getAnimationInterval(); diff --git a/cocos2dx/platform/win32/CCFileUtilsWin32.h b/cocos2dx/platform/win32/CCFileUtilsWin32.h index 38656cf7f2..5feebddd6b 100644 --- a/cocos2dx/platform/win32/CCFileUtilsWin32.h +++ b/cocos2dx/platform/win32/CCFileUtilsWin32.h @@ -53,9 +53,9 @@ protected: /** * Gets resource file data * - * @param[in] filename The resource file name which contains the path. - * @param[in] pszMode The read mode of the file. - * @param[out] pSize If the file read operation succeeds, it will be the data size, otherwise 0. + * @param[in] filename The resource file name which contains the path. + * @param[in] mode The read mode of the file. + * @param[out] size If the file read operation succeeds, it will be the data size, otherwise 0. * @return Upon success, a pointer to the data is returned, otherwise NULL. * @warning Recall: you are responsible for calling delete[] on any Non-NULL pointer returned. */ @@ -77,11 +77,11 @@ protected: * @note Only iOS and Mac need to override this method since they are using * `[[NSBundle mainBundle] pathForResource: ofType: inDirectory:]` to make a full path. * Other platforms will use the default implementation of this method. - * @param strDirectory The directory contains the file we are looking for. - * @param strFilename The name of the file. + * @param directory The directory contains the file we are looking for. + * @param filename The name of the file. * @return The full path of the file, if the file can't be found, it will return an empty string. */ - virtual std::string getFullPathForDirectoryAndFilename(const std::string& strDirectory, const std::string& strFilename) override; + virtual std::string getFullPathForDirectoryAndFilename(const std::string& directory, const std::string& filename) override; }; // end of platform group diff --git a/cocos2dx/sprite_nodes/CCAnimation.h b/cocos2dx/sprite_nodes/CCAnimation.h index 054480734e..7973294c7d 100644 --- a/cocos2dx/sprite_nodes/CCAnimation.h +++ b/cocos2dx/sprite_nodes/CCAnimation.h @@ -111,7 +111,9 @@ protected: The Animation object contains AnimationFrame objects, and a possible delay between the frames. You can animate a Animation object by using the Animate action. Example: -[sprite runAction:[Animate actionWithAnimation:animation]]; +@code + sprite->runAction(Animate::create(animation)); +@endcode */ class CC_DLL Animation : public Object, public Clonable diff --git a/cocos2dx/sprite_nodes/CCAnimationCache.h b/cocos2dx/sprite_nodes/CCAnimationCache.h index 6ce24caf40..2951c1238b 100644 --- a/cocos2dx/sprite_nodes/CCAnimationCache.h +++ b/cocos2dx/sprite_nodes/CCAnimationCache.h @@ -62,7 +62,7 @@ public: /** @deprecated Use getInstance() instead */ CC_DEPRECATED_ATTRIBUTE static AnimationCache* sharedAnimationCache() { return AnimationCache::getInstance(); } - /** @deprecatd Use destroyInstance() instead */ + /** @deprecated Use destroyInstance() instead */ CC_DEPRECATED_ATTRIBUTE static void purgeSharedAnimationCache() { return AnimationCache::destroyInstance(); } bool init(void); @@ -107,4 +107,4 @@ private: NS_CC_END -#endif // __CC_ANIMATION_CACHE_H__ \ No newline at end of file +#endif // __CC_ANIMATION_CACHE_H__ diff --git a/cocos2dx/sprite_nodes/CCSprite.h b/cocos2dx/sprite_nodes/CCSprite.h index 3a8f72700e..b13dbf3691 100644 --- a/cocos2dx/sprite_nodes/CCSprite.h +++ b/cocos2dx/sprite_nodes/CCSprite.h @@ -294,7 +294,7 @@ public: /** * Updates the texture rect of the Sprite in points. - * It will call setTextureRect:rotated:untrimmedSize with rotated = NO, and utrimmedSize = rect.size. + * It will call setTextureRect(const Rect& rect, bool rotated, const Size& untrimmedSize) with \p rotated = false, and \p utrimmedSize = rect.size. */ virtual void setTextureRect(const Rect& rect); @@ -459,20 +459,20 @@ public: virtual void setScaleX(float scaleX) override; virtual void setScaleY(float scaleY) override; virtual void setPosition(const Point& pos) override; - virtual void setRotation(float fRotation) override; - virtual void setRotationX(float fRotationX) override; - virtual void setRotationY(float fRotationY) override; + virtual void setRotation(float rotation) override; + virtual void setRotationX(float rotationX) override; + virtual void setRotationY(float rotationY) override; virtual void setSkewX(float sx) override; virtual void setSkewY(float sy) override; - virtual void removeChild(Node* child, bool bCleanup) override; - virtual void removeAllChildrenWithCleanup(bool bCleanup) override; + virtual void removeChild(Node* child, bool cleanup) override; + virtual void removeAllChildrenWithCleanup(bool cleanup) override; virtual void reorderChild(Node *child, int zOrder) override; virtual void addChild(Node *child) override; virtual void addChild(Node *child, int zOrder) override; virtual void addChild(Node *child, int zOrder, int tag) override; virtual void sortAllChildren() override; - virtual void setScale(float fScale) override; - virtual void setVertexZ(float fVertexZ) override; + virtual void setScale(float scale) override; + virtual void setVertexZ(float vertexZ) override; virtual void setAnchorPoint(const Point& anchor) override; virtual void ignoreAnchorPointForPosition(bool value) override; virtual void setVisible(bool bVisible) override; diff --git a/cocos2dx/sprite_nodes/CCSpriteFrameCache.h b/cocos2dx/sprite_nodes/CCSpriteFrameCache.h index f6c84ee17c..3dd9f56158 100644 --- a/cocos2dx/sprite_nodes/CCSpriteFrameCache.h +++ b/cocos2dx/sprite_nodes/CCSpriteFrameCache.h @@ -81,9 +81,9 @@ public: public: /** Adds multiple Sprite Frames from a plist file. * A texture will be loaded automatically. The texture name will composed by replacing the .plist suffix with .png - * If you want to use another texture, you should use the addSpriteFramesWithFile:texture method. + * If you want to use another texture, you should use the addSpriteFramesWithFile(const char *plist, const char *textureFileName) method. */ - void addSpriteFramesWithFile(const char *pszPlist); + void addSpriteFramesWithFile(const char *plist); /** Adds multiple Sprite Frames from a plist file. The texture will be associated with the created sprite frames. @since v0.99.5 @@ -91,12 +91,12 @@ public: void addSpriteFramesWithFile(const char* plist, const char* textureFileName); /** Adds multiple Sprite Frames from a plist file. The texture will be associated with the created sprite frames. */ - void addSpriteFramesWithFile(const char *pszPlist, Texture2D *pobTexture); + void addSpriteFramesWithFile(const char *plist, Texture2D *texture); /** Adds an sprite frame with a given name. If the name already exists, then the contents of the old name will be replaced with the new one. */ - void addSpriteFrame(SpriteFrame *pobFrame, const char *pszFrameName); + void addSpriteFrame(SpriteFrame *frame, const char *frameName); /** Purges the dictionary of loaded sprite frames. * Call this method if you receive the "Memory Warning". @@ -113,7 +113,7 @@ public: void removeUnusedSpriteFrames(void); /** Deletes an sprite frame from the sprite frame cache. */ - void removeSpriteFrameByName(const char *pszName); + void removeSpriteFrameByName(const char *name); /** Removes multiple Sprite Frames from a plist file. * Sprite Frames stored in this file will be removed. @@ -140,7 +140,7 @@ public: private: /*Adds multiple Sprite Frames with a dictionary. The texture will be associated with the created sprite frames. */ - void addSpriteFramesWithDictionary(Dictionary* pobDictionary, Texture2D *pobTexture); + void addSpriteFramesWithDictionary(Dictionary* dictionary, Texture2D *texture); /** Removes multiple Sprite Frames from Dictionary. * @since v0.99.5 diff --git a/cocos2dx/support/CCProfiling.cpp b/cocos2dx/support/CCProfiling.cpp index 3b50ff30a0..e238c45651 100644 --- a/cocos2dx/support/CCProfiling.cpp +++ b/cocos2dx/support/CCProfiling.cpp @@ -29,7 +29,7 @@ using namespace std; NS_CC_BEGIN //#pragma mark - Profiling Categories -/* set to NO the categories that you don't want to profile */ +/* set to false the categories that you don't want to profile */ bool kProfilerCategorySprite = false; bool kProfilerCategoryBatchSprite = false; bool kProfilerCategoryParticles = false; diff --git a/cocos2dx/support/CCVertex.h b/cocos2dx/support/CCVertex.h index 25018f80e9..b7abd7b110 100644 --- a/cocos2dx/support/CCVertex.h +++ b/cocos2dx/support/CCVertex.h @@ -34,7 +34,7 @@ NS_CC_BEGIN * @{ */ -/** @file Vertex.h */ +/** @file CCVertex.h */ /** converts a line to a polygon */ void CC_DLL ccVertexLineToPolygon(Point *points, float stroke, Vertex2F *vertices, unsigned int offset, unsigned int nuPoints); diff --git a/cocos2dx/support/ccUTF8.h b/cocos2dx/support/ccUTF8.h index 87c7a465b8..48543dcd17 100644 --- a/cocos2dx/support/ccUTF8.h +++ b/cocos2dx/support/ccUTF8.h @@ -17,74 +17,66 @@ CC_DLL int cc_wcslen(const unsigned short* str); CC_DLL void cc_utf8_trim_ws(std::vector* str); -/* - * @ch is the unicode character whitespace? +/** + * Whether the character is a whitespace character. * - * Reference: http://en.wikipedia.org/wiki/Whitespace_character#Unicode + * @param ch the unicode character + * @returns whether the character is a white space character. * - * Return value: weather the character is a whitespace character. + * @see http://en.wikipedia.org/wiki/Whitespace_character#Unicode * */ CC_DLL bool isspace_unicode(unsigned short ch); -/* - * cc_utf8_strlen: - * @p: pointer to the start of a UTF-8 encoded string. - * @max: the maximum number of bytes to examine. If @max - * is less than 0, then the string is assumed to be - * null-terminated. If @max is 0, @p will not be examined and - * may be %NULL. - * +/** * Returns the length of the string in characters. * - * Return value: the length of the string in characters + * @param p pointer to the start of a UTF-8 encoded string. + * @param max the maximum number of bytes to examine. If \p max is less than + * 0, then the string is assumed to be null-terminated. If \p max + * is 0, \p p will not be examined and my be %NULL. + * + * @returns the length of the string in characters **/ CC_DLL long cc_utf8_strlen (const char * p, int max); -/* - * @str: the string to search through. - * @c: the character to not look for. +/** + * Find the last character that is not equal to the character given. * - * Return value: the index of the last character that is not c. + * @param str the string to be searched. + * @param c the character to be searched for. + * + * @returns the index of the last character that is not \p c. * */ CC_DLL unsigned int cc_utf8_find_last_not_char(std::vector str, unsigned short c); CC_DLL std::vector cc_utf16_vec_from_utf16_str(const unsigned short* str); -/* - * cc_utf8_to_utf16: - * @str_old: pointer to the start of a C string. - * +/** * Creates a utf8 string from a cstring. * - * Return value: the newly created utf8 string. + * @param str_old pointer to the start of a C string. + * + * @returns the newly created utf8 string. * */ CC_DLL unsigned short* cc_utf8_to_utf16(const char* str_old, int length = -1, int* rUtf16Size = NULL); /** - * cc_utf16_to_utf8: - * @str: a UTF-16 encoded string - * @len: the maximum length of @str to use. If @len < 0, then - * the string is terminated with a 0 character. - * @items_read: location to store number of words read, or %NULL. - * If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be - * returned in case @str contains a trailing partial - * character. If an error occurs then the index of the - * invalid input is stored here. - * @items_written: location to store number of bytes written, or %NULL. - * The value stored here does not include the trailing - * 0 byte. - * @error: location to store the error occuring, or %NULL to ignore - * errors. Any of the errors in #GConvertError other than - * %G_CONVERT_ERROR_NO_CONVERSION may occur. + * Convert a string from UTF-16 to UTF-8. The result will be null terminated. * - * Convert a string from UTF-16 to UTF-8. The result will be - * terminated with a 0 byte. + * @param str a UTF-16 encoded string + * @param len the maximum length of \p str to use. If \p len < 0, then the + * string is null terminated. + * @param items_read location to store number of words read, or %NULL. + * If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be + * returned in case \p str contains a trailing partial + * character. If an error occurs then the index of the + * invalid input is stored here. + * @param items_written location to store number of bytes written, or %NULL. + * The value stored here does not include the trailing null. * - * Return value: a pointer to a newly allocated UTF-8 string. - * This value must be freed with free(). If an - * error occurs, %NULL will be returned and - * @error set. + * @returns a pointer to a newly allocated UTF-8 string. This value must be + * freed with free(). If an error occurs, %NULL will be returned. **/ CC_DLL char * cc_utf16_to_utf8 (const unsigned short *str, diff --git a/cocos2dx/textures/CCTextureAtlas.h b/cocos2dx/textures/CCTextureAtlas.h index ae5e13ab16..dd49f20dfa 100644 --- a/cocos2dx/textures/CCTextureAtlas.h +++ b/cocos2dx/textures/CCTextureAtlas.h @@ -129,8 +129,8 @@ public: /** resize the capacity of the TextureAtlas. * The new capacity can be lower or higher than the current one - * It returns YES if the resize was successful. - * If it fails to resize the capacity it will return NO with a new capacity of 0. + * It returns true if the resize was successful. + * If it fails to resize the capacity it will return false with a new capacity of 0. */ bool resizeCapacity(int capacity); diff --git a/cocos2dx/touch_dispatcher/CCTouchDelegateProtocol.h b/cocos2dx/touch_dispatcher/CCTouchDelegateProtocol.h index 06104df0f8..7de1235939 100644 --- a/cocos2dx/touch_dispatcher/CCTouchDelegateProtocol.h +++ b/cocos2dx/touch_dispatcher/CCTouchDelegateProtocol.h @@ -70,7 +70,7 @@ public: Using this type of delegate results in two benefits: - 1. You don't need to deal with Sets, the dispatcher does the job of splitting them. You get exactly one UITouch per call. - - 2. You can *claim* a UITouch by returning YES in ccTouchBegan. Updates of claimed + - 2. You can *claim* a UITouch by returning true in ccTouchBegan. Updates of claimed touches are sent only to the delegate(s) that claimed them. So if you get a move/ ended/canceled update you're sure it's your touch. This frees you from doing a lot of checks when doing multi-touch. @@ -82,7 +82,7 @@ public: class CC_DLL TargetedTouchDelegate : public TouchDelegate { public: - /** Return YES to claim the touch. + /** Return true to claim the touch. @since v0 */ virtual bool ccTouchBegan(Touch *pTouch, Event *pEvent) { CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent);return false;}; diff --git a/extensions/AssetsManager/AssetsManager.h b/extensions/AssetsManager/AssetsManager.h index b150e073e0..d2cadf0899 100644 --- a/extensions/AssetsManager/AssetsManager.h +++ b/extensions/AssetsManager/AssetsManager.h @@ -203,7 +203,7 @@ public: virtual void onError(AssetsManager::ErrorCode errorCode) {}; /** @brief Call back function for recording downloading percent @param percent How much percent downloaded - @warn This call back function just for recording downloading percent. + @warning This call back function just for recording downloading percent. AssetsManager will do some other thing after downloading, you should write code in onSuccess() after downloading. */ diff --git a/extensions/CCArmature/CCBone.h b/extensions/CCArmature/CCBone.h index 3c94ebc667..69aae2fc07 100644 --- a/extensions/CCArmature/CCBone.h +++ b/extensions/CCArmature/CCBone.h @@ -75,7 +75,7 @@ public: * @param displayData it include the display information, like DisplayType. * If you want to create a sprite display, then create a SpriteDisplayData param * - * @param _index the index of the display you want to replace or add to + * @param index the index of the display you want to replace or add to * -1 : append display from back */ void addDisplay(DisplayData *displayData, int index); @@ -84,9 +84,9 @@ public: /** * Add a child to this bone, and it will let this child call setParent(Bone *_parent) function to set self to it's parent - * @param _child the child you want to add + * @param child The child you want to add. */ - void addChildBone(Bone *_child); + void addChildBone(Bone *child); /** * Set parent bone. @@ -106,13 +106,13 @@ public: /** * Remove itself from its parent Bone. - * @param recursion whether or not remove Child display + * @param recursion Whether to remove Child display */ void removeFromParent(bool recursion); /** * Removes a child Bone - * @param bone the bone you want to remove + * @param bone The bone you want to remove. */ void removeChildBone(Bone *bone, bool recursion); diff --git a/extensions/CCArmature/animation/CCArmatureAnimation.h b/extensions/CCArmature/animation/CCArmatureAnimation.h index f4d1debc46..dc4bbe47e6 100644 --- a/extensions/CCArmature/animation/CCArmatureAnimation.h +++ b/extensions/CCArmature/animation/CCArmatureAnimation.h @@ -99,7 +99,7 @@ public: /** * Play animation by index, the other param is the same to play. - * @param _animationIndex the animation index you want to play + * @param animationIndex the animation index you want to play */ void playByIndex(int animationIndex, int durationTo = -1, int durationTween = -1, int loop = -1, int tweenEasing = TWEEN_EASING_MAX); diff --git a/extensions/CCArmature/animation/CCProcessBase.h b/extensions/CCArmature/animation/CCProcessBase.h index 8625c09fe8..c0fabb7e1e 100644 --- a/extensions/CCArmature/animation/CCProcessBase.h +++ b/extensions/CCArmature/animation/CCProcessBase.h @@ -103,7 +103,7 @@ public: * You should never call this function, unless you know what you do * Update the Process, include current process, current frame and son on * - * @param The duration since last update + * @param dt The duration since last update */ virtual void update(float dt); diff --git a/extensions/CCArmature/datas/CCDatas.h b/extensions/CCArmature/datas/CCDatas.h index a98159c17e..186314267f 100644 --- a/extensions/CCArmature/datas/CCDatas.h +++ b/extensions/CCArmature/datas/CCDatas.h @@ -31,28 +31,28 @@ THE SOFTWARE. #define CS_CREATE_NO_PARAM_NO_INIT(varType)\ public: \ - static inline varType *create(void){ \ - varType *var = new varType();\ - if (var)\ + static inline varType *create(void){ \ + varType *var = new varType();\ + if (var)\ {\ - var->autorelease();\ - return var;\ + var->autorelease();\ + return var;\ }\ - CC_SAFE_DELETE(var);\ - return NULL;\ + CC_SAFE_DELETE(var);\ + return NULL;\ } #define CS_CREATE_NO_PARAM(varType)\ public: \ - static inline varType *create(void){ \ - varType *var = new varType();\ - if (var && var->init())\ + static inline varType *create(void){ \ + varType *var = new varType();\ + if (var && var->init())\ {\ - var->autorelease();\ - return var;\ + var->autorelease();\ + return var;\ }\ - CC_SAFE_DELETE(var);\ - return NULL;\ + CC_SAFE_DELETE(var);\ + return NULL;\ } namespace cocos2d { namespace extension { namespace armature { @@ -72,19 +72,19 @@ public: * Copy datas from node * @param node A BaseData to copy datas */ - virtual void copy(const BaseData *_node); + virtual void copy(const BaseData *node); /* - * Calculate two BaseData's between value(_to - _from) and set to self + * Calculate two BaseData's between value(to - from) and set to self * * @param from from BaseData * @param to to BaseData */ - virtual void subtract(BaseData *_from, BaseData *_to); + virtual void subtract(BaseData *from, BaseData *to); public: - float x; //! position x attribute - float y; //! position y attribute - int zOrder; //! zorder attribute, used to order the Bone's depth order + float x; //! position x attribute + float y; //! position y attribute + int zOrder; //! zorder attribute, used to order the Bone's depth order /** * x y skewX skewY scaleX scaleY used to calculate transform matrix @@ -96,9 +96,9 @@ public: float scaleX; float scaleY; - float tweenRotate; //! SkewX, SkewY, and TweenRotate effect the rotation + float tweenRotate; //! SkewX, SkewY, and TweenRotate effect the rotation - bool isUseColorInfo; //! Whether or not this frame have the color changed Info + bool isUseColorInfo; //! Whether or not this frame have the color changed Info int a, r, g, b; }; @@ -242,9 +242,9 @@ public: void addDisplayData(DisplayData *displayData); DisplayData *getDisplayData(int index); public: - std::string name; //! the bone's name - std::string parentName; //! the bone parent's name - Array displayDataList; //! save DisplayData informations for the Bone + std::string name; //! the bone's name + std::string parentName; //! the bone parent's name + Array displayDataList; //! save DisplayData informations for the Bone }; @@ -313,10 +313,10 @@ public: void addFrameData(FrameData *frameData); FrameData *getFrameData(int index); public: - float delay; //! movement delay percent, this value can produce a delay effect - float scale; //! scale this movement - float duration; //! this Bone in this movement will last _duration frames - std::string name; //! bone name + float delay; //! movement delay percent, this value can produce a delay effect + float scale; //! scale this movement + float duration; //! this Bone in this movement will last _duration frames + std::string name; //! bone name Array frameList; }; @@ -351,7 +351,7 @@ public: */ int durationTween; - bool loop; //! whether the movement is looped + bool loop; //! whether the movement is looped /** * Which tween easing effect the movement use @@ -360,10 +360,9 @@ public: TweenType tweenEasing; /** - * @brief save movment bone datas - * @key std::string - * @value MovementBoneData * - */ + * Dictionary to save movment bone data. + * Key type is std::string, value type is MovementBoneData *. + */ Dictionary movBoneDataDic; }; @@ -442,13 +441,13 @@ public: ContourData *getContourData(int index); public: - float height; //! The texture's width, height - float width; + float height; //! The texture's width, height + float width; - float pivotX; //! The texture's anchor point + float pivotX; //! The texture's anchor point float pivotY; - std::string name; //! The texture's name + std::string name; //! The texture's name Array contourDataList; }; diff --git a/extensions/CCArmature/utils/CCArmatureDataManager.h b/extensions/CCArmature/utils/CCArmatureDataManager.h index 801f305a1f..58f089fc0d 100644 --- a/extensions/CCArmature/utils/CCArmatureDataManager.h +++ b/extensions/CCArmature/utils/CCArmatureDataManager.h @@ -33,7 +33,7 @@ THE SOFTWARE. namespace cocos2d { namespace extension { namespace armature { /** - * @brief format and manage armature configuration and armature animation + * @brief format and manage armature configuration and armature animation */ class ArmatureDataManager : public Object { @@ -45,105 +45,101 @@ private: ~ArmatureDataManager(void); public: - /** + /** * Init ArmatureDataManager */ virtual bool init(); /** - * Add armature data - * @param id The id of the armature data - * @param armatureData ArmatureData * + * @brief Add armature data. + * + * @param id The id of the armature data. + * @param armatureData The armature data to be added. */ void addArmatureData(const char *id, ArmatureData *armatureData); - /** - * @brief get armature data + /** + * @brief Get armature data. * - * @param id the id of the armature data you want to get - * - * @return ArmatureData * + * @param id The id of the armature data you want to get. + * + * @return The ArmatureData whose id is @p id. */ ArmatureData *getArmatureData(const char *id); /** - * @brief add animation data + * @brief Add animation data. * - * @param id the id of the animation data - * - * @return AnimationData * + * @param id The id of the animation data. + * @param animationData The animation data to be added. */ void addAnimationData(const char *id, AnimationData *animationData); - /** - * @brief get animation data from _animationDatas(Dictionary) + /** + * @brief Get animation data. * - * @param id the id of the animation data you want to get - * - * @return AnimationData * + * @param id The id of the animation data you want to get. + * + * @return The AnimationData whose id is @p id. */ AnimationData *getAnimationData(const char *id); /** - * @brief add texture data + * @brief Add texture data. * - * @param id the id of the texture data - * - * @return TextureData * + * @param id The id of the texture data. + * @param textureData The texture data to be added. */ void addTextureData(const char *id, TextureData *textureData); - /** - * @brief get texture data + /** + * @brief Get texture data. * - * @param _id the id of the texture data you want to get - * - * @return TextureData * + * @param id The id of the texture data you want to get. + * + * @return The TextureData whose id is @p id. */ TextureData *getTextureData(const char *id); /** - * @brief Add ArmatureFileInfo, it is managed by ArmatureDataManager. + * @brief Add ArmatureFileInfo, it is managed by ArmatureDataManager. */ - void addArmatureFileInfo(const char *armatureName, const char *useExistFileInfo, const char *imagePath, const char *plistPath, const char *configFilePath); - /** - * @brief Add ArmatureFileInfo, it is managed by ArmatureDataManager. - */ - void addArmatureFileInfo(const char *imagePath, const char *plistPath, const char *configFilePath); + void addArmatureFileInfo(const char *armatureName, const char *useExistFileInfo, const char *imagePath, const char *plistPath, const char *configFilePath); /** - * @brief Add sprite frame to SpriteFrameCache, it will save display name and it's relative image name + * @brief Add ArmatureFileInfo, it is managed by ArmatureDataManager. + */ + void addArmatureFileInfo(const char *imagePath, const char *plistPath, const char *configFilePath); + + /** + * @brief Add sprite frame to SpriteFrameCache, it will save display name and it's relative image name */ void addSpriteFrameFromFile(const char *plistPath, const char *imagePath); - - - /** - * @brief Clear the data in the _armarureDatas and _animationDatas, and set _armarureDatas and _animationDatas to NULL + + /** + * @brief Clear the data in the _armarureDatas and _animationDatas, and set _armarureDatas and _animationDatas to NULL */ void removeAll(); private: /** - * @brief save amature datas - * @key std::string - * @value ArmatureData * + * Dictionary to save amature data. + * Key type is std::string, value type is ArmatureData *. */ - CC_SYNTHESIZE_READONLY(Dictionary *, _armarureDatas, ArmarureDatas); + CC_SYNTHESIZE_READONLY(Dictionary *, _armarureDatas, ArmarureDatas); /** - * @brief save animation datas - * @key std::string - * @value AnimationData * + * Dictionary to save animation data. + * Key type is std::string, value type is AnimationData *. */ - CC_SYNTHESIZE_READONLY(Dictionary *, _animationDatas, AnimationDatas); + CC_SYNTHESIZE_READONLY(Dictionary *, _animationDatas, AnimationDatas); - /** - * @brief save texture datas - * @key std::string - * @value TextureData * + /** + * Dictionary to save texture data. + * Key type is std::string, value type is TextureData *. */ - CC_SYNTHESIZE_READONLY(Dictionary *, _textureDatas, TextureDatas); + CC_SYNTHESIZE_READONLY(Dictionary *, _textureDatas, TextureDatas); }; diff --git a/extensions/CCArmature/utils/CCDataReaderHelper.h b/extensions/CCArmature/utils/CCDataReaderHelper.h index a57b3bfe04..7e16e35ad3 100644 --- a/extensions/CCArmature/utils/CCDataReaderHelper.h +++ b/extensions/CCArmature/utils/CCDataReaderHelper.h @@ -64,7 +64,7 @@ public: * Translate XML export from Dragon Bone flash tool to datas, and save them. * When you add a new xml, the data already saved will be keeped. * - * @param xmlPath Path of pak file + * @param xmlPakPath Path of pak file */ static void addDataFromXMLPak(const char *xmlPakPath); @@ -72,9 +72,9 @@ public: * Translate XML export from Dragon Bone flash tool to datas, and save them. * When you add a new xml, the data already saved will be keeped. * - * @param xmlPath The cache of the xml + * @param fileContent The cache of the xml */ - static void addDataFromCache(const char *pFileContent); + static void addDataFromCache(const char *fileContent); diff --git a/extensions/CCBReader/CCBMemberVariableAssigner.h b/extensions/CCBReader/CCBMemberVariableAssigner.h index 72fa008e93..8afbb9dc75 100644 --- a/extensions/CCBReader/CCBMemberVariableAssigner.h +++ b/extensions/CCBReader/CCBMemberVariableAssigner.h @@ -32,22 +32,22 @@ class CCBMemberVariableAssigner { /** * The callback function of assigning member variable. * @note The member variable must be Node or its subclass. - * @param pTarget The custom class. - * @param pMemberVariableName The name of the member variable. - * @param pNode The member variable. + * @param target The custom class. + * @param memberVariableName The name of the member variable. + * @param node The member variable. * @return Whether the assignment was successful. */ - virtual bool onAssignCCBMemberVariable(Object* pTarget, const char* pMemberVariableName, Node* pNode) = 0; + virtual bool onAssignCCBMemberVariable(Object* target, const char* memberVariableName, Node* node) = 0; /** * The callback function of assigning custom properties. * @note The member variable must be Integer, Float, Boolean or String. - * @param pTarget The custom class. - * @param pMemberVariableName The name of the member variable. - * @param pValue The value of the property. + * @param target The custom class. + * @param memberVariableName The name of the member variable. + * @param value The value of the property. * @return Whether the assignment was successful. */ - virtual bool onAssignCCBCustomProperty(Object* pTarget, const char* pMemberVariableName, CCBValue* pCCBValue) { return false; }; + virtual bool onAssignCCBCustomProperty(Object* target, const char* memberVariableName, CCBValue* value) { return false; }; }; NS_CC_EXT_END diff --git a/extensions/GUI/CCControlExtension/CCControlButton.h b/extensions/GUI/CCControlExtension/CCControlButton.h index 303e2f0751..db64680113 100644 --- a/extensions/GUI/CCControlExtension/CCControlButton.h +++ b/extensions/GUI/CCControlExtension/CCControlButton.h @@ -128,7 +128,7 @@ public: * If a property is not specified for a state, the default is to use * the ButtonStateNormal value. * - * @param title The title label to use for the specified state. + * @param label The title label to use for the specified state. * @param state The state that uses the specified title. The values are described * in "CCControlState". */ @@ -243,4 +243,4 @@ protected: NS_CC_EXT_END -#endif \ No newline at end of file +#endif diff --git a/extensions/GUI/CCControlExtension/CCControlPotentiometer.h b/extensions/GUI/CCControlExtension/CCControlPotentiometer.h index 79614d193b..903f9178d0 100644 --- a/extensions/GUI/CCControlExtension/CCControlPotentiometer.h +++ b/extensions/GUI/CCControlExtension/CCControlPotentiometer.h @@ -53,8 +53,8 @@ public: /** * Initializes a potentiometer with a track sprite and a progress bar. * - * @param trackSprite Sprite, that is used as a background. - * @param progressSprite ProgressTimer, that is used as a progress bar. + * @param trackSprite Sprite, that is used as a background. + * @param progressTimer ProgressTimer, that is used as a progress bar. */ bool initWithTrackSprite_ProgressTimer_ThumbSprite(Sprite* trackSprite, ProgressTimer* progressTimer, Sprite* thumbSprite); diff --git a/extensions/GUI/CCControlExtension/CCControlSlider.h b/extensions/GUI/CCControlExtension/CCControlSlider.h index 6e03a74435..03f55a855f 100644 --- a/extensions/GUI/CCControlExtension/CCControlSlider.h +++ b/extensions/GUI/CCControlExtension/CCControlSlider.h @@ -68,7 +68,7 @@ public: * * @param backgroundSprite Sprite, that is used as a background. * @param progressSprite Sprite, that is used as a progress bar. - * @param thumbItem Sprite, that is used as a thumb. + * @param thumbSprite Sprite, that is used as a thumb. */ virtual bool initWithSprites(Sprite * backgroundSprite, Sprite* progressSprite, Sprite* thumbSprite); @@ -120,4 +120,4 @@ protected: NS_CC_EXT_END -#endif \ No newline at end of file +#endif diff --git a/extensions/GUI/CCScrollView/CCScrollView.h b/extensions/GUI/CCScrollView/CCScrollView.h index 3073453606..cf3c66a45f 100644 --- a/extensions/GUI/CCScrollView/CCScrollView.h +++ b/extensions/GUI/CCScrollView/CCScrollView.h @@ -73,8 +73,6 @@ public: /** * Returns an autoreleased scroll view object. * - * @param size view size - * @param container parent object * @return autoreleased scroll view object */ static ScrollView* create(); @@ -97,8 +95,8 @@ public: /** * Sets a new content offset. It ignores max/min offset. It just sets what's given. (just like UIKit's UIScrollView) * - * @param offset new offset - * @param If YES, the view scrolls to the new offset + * @param offset The new offset. + * @param animated If true, the view will scroll to the new offset. */ void setContentOffset(Point offset, bool animated = false); Point getContentOffset(); @@ -106,8 +104,8 @@ public: * Sets a new content offset. It ignores max/min offset. It just sets what's given. (just like UIKit's UIScrollView) * You can override the animation duration with this method. * - * @param offset new offset - * @param animation duration + * @param offset The new offset. + * @param dt The animation duration. */ void setContentOffsetInDuration(Point offset, float dt); @@ -115,8 +113,8 @@ public: /** * Sets a new scale and does that for a predefined duration. * - * @param s a new scale vale - * @param animated if YES, scaling is animated + * @param s The new scale vale + * @param animated If true, scaling is animated */ void setZoomScale(float s, bool animated); @@ -125,8 +123,8 @@ public: /** * Sets a new scale for container in a given duration. * - * @param s a new scale value - * @param animation duration + * @param s The new scale value + * @param dt The animation duration */ void setZoomScaleInDuration(float s, float dt); /** @@ -140,7 +138,7 @@ public: /** * Determines if a given node's bounding box is in visible bounds * - * @return YES if it is in visible bounds + * @returns true if it is in visible bounds */ bool isNodeVisible(Node * node); /** @@ -203,7 +201,7 @@ protected: /** * Relocates the container at the proper offset, in bounds of max/min offsets. * - * @param animated If YES, relocation is animated + * @param animated If true, relocation is animated */ void relocateContainer(bool animated); /** diff --git a/extensions/GUI/CCScrollView/CCSorting.h b/extensions/GUI/CCScrollView/CCSorting.h index 8bf3f0031c..e7c241f539 100644 --- a/extensions/GUI/CCScrollView/CCSorting.h +++ b/extensions/GUI/CCScrollView/CCSorting.h @@ -52,7 +52,7 @@ public: * If the compare message does not result NSComparisonResult, sorting behavior * is not defined. It ignores duplicate entries and inserts next to it. * - * @param object to insert + * @param object The object to be inserted. */ void insertSortedObject(SortableObject* object); @@ -62,7 +62,7 @@ public: * Removes an object with given key and value. If no object is found in array * with the key and value, no action is taken. * - * @param value to remove + * @param object The object to be removed. */ void removeSortedObject(SortableObject* object); /*! @@ -72,8 +72,8 @@ public: * keep consistency of being sorted. If it is changed externally, it must be * sorted completely again. * - * @param value to set - * @param object the object which has the value + * @param tag The value to be set to. + * @param object The object which has the value. */ void setObjectID_ofSortedObject(unsigned int tag, SortableObject* object); @@ -84,7 +84,7 @@ public: * Returns an object with given key and value. If no object is found, * it returns nil. * - * @param value to locate object + * @param tag The value to locate object * @return object found or nil. */ SortableObject* getObjectWithObjectID(unsigned int tag); @@ -97,8 +97,8 @@ public: * would have been located. If object must be located at the end of array, * it returns the length of the array, which is out of bound. * - * @param value to locate object - * @return index of an object found + * @param obj The object + * @return index of the object */ unsigned int indexOfSortedObject(SortableObject* obj); diff --git a/extensions/network/HttpClient.h b/extensions/network/HttpClient.h index 4b3c6146df..b41ba226be 100644 --- a/extensions/network/HttpClient.h +++ b/extensions/network/HttpClient.h @@ -59,22 +59,19 @@ public: * Add a get request to task queue * @param request a HttpRequest object, which includes url, response callback etc. please make sure request->_requestData is clear before calling "send" here. - * @return NULL */ void send(HttpRequest* request); /** * Change the connect timeout - * @param timeout - * @return NULL + * @param value The desired timeout. */ inline void setTimeoutForConnect(int value) {_timeoutForConnect = value;}; /** * Get connect timeout * @return int - * */ inline int getTimeoutForConnect() {return _timeoutForConnect;} @@ -82,7 +79,6 @@ public: /** * Change the download timeout * @param value - * @return NULL */ inline void setTimeoutForRead(int value) {_timeoutForRead = value;}; diff --git a/scripting/lua/cocos2dx_support/CCLuaEngine.h b/scripting/lua/cocos2dx_support/CCLuaEngine.h index b051508eaf..6a9c56d8f4 100644 --- a/scripting/lua/cocos2dx_support/CCLuaEngine.h +++ b/scripting/lua/cocos2dx_support/CCLuaEngine.h @@ -71,7 +71,7 @@ public: @brief Remove Object from lua state @param object to remove */ - virtual void removeScriptObjectByObject(Object* pObj); + virtual void removeScriptObjectByObject(Object* object); /** @brief Remove Lua function reference diff --git a/scripting/lua/cocos2dx_support/CCLuaStack.h b/scripting/lua/cocos2dx_support/CCLuaStack.h index 7fd0aa4766..bfc865175e 100644 --- a/scripting/lua/cocos2dx_support/CCLuaStack.h +++ b/scripting/lua/cocos2dx_support/CCLuaStack.h @@ -62,9 +62,9 @@ public: /** @brief Remove Object from lua state - @param object to remove + @param object The object to be removed. */ - virtual void removeScriptObjectByObject(Object* pObj); + virtual void removeScriptObjectByObject(Object* object); /** @brief Remove Lua function reference