Lothario
/
axmol
mirror of https://github.com/axmolengine/axmol.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3347 from timothyqiu/docfix 

More documentation fixes
This commit is contained in:
minggo 2013-08-01 18:22:43 -07:00
parent 077acb7814 5ad5cfed7a
commit 5e03b9b29d
52 changed files with 289 additions and 310 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CocosDenshion/include/SimpleAudioEngine.h
View File

@ -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();

2
cocos2dx/CCDirector.h
View File

@ -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 */

4
cocos2dx/CCScheduler.h
View File

@ -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().
*/

8
cocos2dx/actions/CCAction.h
View File

@ -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

4
cocos2dx/actions/CCActionGrid.h
View File

@ -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 */

2
cocos2dx/actions/CCActionInterval.h
View File

@ -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

14
cocos2dx/actions/CCActionTween.h
View File

@ -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:
@code
// scaleA and scaleB are equivalents
id scaleA = [ScaleTo actionWithDuration:2 scale:3];
id scaleB = [ActionTween actionWithDuration:2 key:@"scale" from:1 to:3];
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
*/

15
cocos2dx/base_nodes/CCNode.h
View File

@ -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);

32
cocos2dx/cocoa/CCGeometry.h
View File

@ -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);

2
cocos2dx/include/CCDeprecated.h
View File

@ -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)

8
cocos2dx/include/CCProtocols.h
View File

@ -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)

6
cocos2dx/layers_scenes_transitions_nodes/CCLayer.h
View File

@ -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);

4
cocos2dx/misc_nodes/CCClippingNode.h
View File

@ -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);

10
cocos2dx/misc_nodes/CCRenderTexture.h
View File

@ -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; };

2
cocos2dx/particle_nodes/CCParticleSystemQuad.h
View File

@ -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);

8
cocos2dx/platform/CCApplicationProtocol.h
View File

@ -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;

4
cocos2dx/platform/CCFileUtils.h
View File

@ -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.

35
cocos2dx/platform/CCImage.h
View File

@ -103,11 +103,10 @@ 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.
@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.
@ -122,20 +121,20 @@ public:
/**
@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.
@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);

2
cocos2dx/platform/android/CCApplication.h
View File

@ -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);

2
cocos2dx/platform/emscripten/CCApplication.h
View File

@ -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);

2
cocos2dx/platform/ios/CCApplication.h
View File

@ -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);

2
cocos2dx/platform/linux/CCApplication.h
View File

@ -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);

2
cocos2dx/platform/mac/CCApplication.h
View File

@ -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);

2
cocos2dx/platform/nacl/CCApplication.h
View File

@ -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);

2
cocos2dx/platform/qt5/CCApplication.h
View File

@ -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);

2
cocos2dx/platform/tizen/CCApplication.h
View File

@ -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();

10
cocos2dx/platform/win32/CCFileUtilsWin32.h
View File

@ -54,8 +54,8 @@ 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] 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

4
cocos2dx/sprite_nodes/CCAnimation.h
View File

@ -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

2
cocos2dx/sprite_nodes/CCAnimationCache.h
View File

@ -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);

16
cocos2dx/sprite_nodes/CCSprite.h
View File

@ -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;

12
cocos2dx/sprite_nodes/CCSpriteFrameCache.h
View File

@ -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

2
cocos2dx/support/CCProfiling.cpp
View File

@ -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;

2
cocos2dx/support/CCVertex.h
View File

@ -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);

74
cocos2dx/support/ccUTF8.h
View File

@ -17,74 +17,66 @@ CC_DLL int cc_wcslen(const unsigned short* str);
CC_DLL void cc_utf8_trim_ws(std::vector<unsigned short>* 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<unsigned short> str, unsigned short c);
CC_DLL std::vector<unsigned short> 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.
* Convert a string from UTF-16 to UTF-8. The result will be null terminated.
*
* @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 @str contains a trailing partial
* returned in case \p 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.
* @param items_written location to store number of bytes written, or %NULL.
* The value stored here does not include the trailing null.
*
* Convert a string from UTF-16 to UTF-8. The result will be
* terminated with a 0 byte.
*
* 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,

4
cocos2dx/textures/CCTextureAtlas.h
View File

@ -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);

4
cocos2dx/touch_dispatcher/CCTouchDelegateProtocol.h
View File

@ -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;};

2
extensions/AssetsManager/AssetsManager.h
View File

@ -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.
*/

10
extensions/CCArmature/CCBone.h
View File

@ -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);

2
extensions/CCArmature/animation/CCArmatureAnimation.h
View File

@ -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);

2
extensions/CCArmature/animation/CCProcessBase.h
View File

@ -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);

11
extensions/CCArmature/datas/CCDatas.h
View File

@ -72,15 +72,15 @@ 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
@ -360,9 +360,8 @@ 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;
};

56
extensions/CCArmature/utils/CCArmatureDataManager.h
View File

@ -51,54 +51,53 @@ public:
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
* @param id The id of the armature data you want to get.
*
* @return ArmatureData *
* @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
* @param id The id of the animation data you want to get.
*
* @return AnimationData *
* @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
* @param id The id of the texture data you want to get.
*
* @return TextureData *
* @return The TextureData whose id is @p id.
*/
TextureData *getTextureData(const char *id);
@ -106,6 +105,7 @@ public:
* @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.
*/
@ -116,7 +116,6 @@ public:
*/
void addSpriteFrameFromFile(const char *plistPath, const char *imagePath);
/**
* @brief Clear the data in the _armarureDatas and _animationDatas, and set _armarureDatas and _animationDatas to NULL
*/
@ -125,23 +124,20 @@ public:
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);
/**
* @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);
/**
* @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);

6
extensions/CCArmature/utils/CCDataReaderHelper.h
View File

@ -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);

16
extensions/CCBReader/CCBMemberVariableAssigner.h
View File

@ -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

2
extensions/GUI/CCControlExtension/CCControlButton.h
View File

@ -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".
*/

2
extensions/GUI/CCControlExtension/CCControlPotentiometer.h
View File

@ -54,7 +54,7 @@ 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 progressTimer ProgressTimer, that is used as a progress bar.
*/
bool initWithTrackSprite_ProgressTimer_ThumbSprite(Sprite* trackSprite, ProgressTimer* progressTimer, Sprite* thumbSprite);

2
extensions/GUI/CCControlExtension/CCControlSlider.h
View File

@ -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);

22
extensions/GUI/CCScrollView/CCScrollView.h
View File

@ -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);
/**

14
extensions/GUI/CCScrollView/CCSorting.h
View File

@ -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);

6
extensions/network/HttpClient.h
View File

@ -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;};

2
scripting/lua/cocos2dx_support/CCLuaEngine.h
View File

@ -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

4
scripting/lua/cocos2dx_support/CCLuaStack.h
View File

@ -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