From 6816fb94fc9ef051012991a8d7da370044449b20 Mon Sep 17 00:00:00 2001 From: Donald Alan Morrison Date: Sat, 15 Sep 2012 15:12:28 -0700 Subject: [PATCH] A few more minor documentation changes. OK, enough for today! :-) --- cocos2dx/CCScheduler.h | 2 +- cocos2dx/actions/CCAction.h | 2 +- cocos2dx/actions/CCActionCatmullRom.cpp | 32 ++++++++++++------------- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/cocos2dx/CCScheduler.h b/cocos2dx/CCScheduler.h index d342ca65e3..af3ed28958 100644 --- a/cocos2dx/CCScheduler.h +++ b/cocos2dx/CCScheduler.h @@ -142,7 +142,7 @@ public: /** The scheduled method will be called every 'interval' seconds. If paused is YES, then it won't be called until it is resumed. - If 'interval' is 0, it will be called every frame, but if so, it recommended to use 'scheduleUpdateForTarget:' instead. + 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 kCCRepeatForever to let the action run continuously delay is the amount of time the action will wait before it'll start diff --git a/cocos2dx/actions/CCAction.h b/cocos2dx/actions/CCAction.h index 1e897146f3..3f9375a1c6 100644 --- a/cocos2dx/actions/CCAction.h +++ b/cocos2dx/actions/CCAction.h @@ -234,7 +234,7 @@ public: public: /** creates the action with a set boundary, It will work with no boundary if @param rect is equal to CCRectZero. - @deprecated: Please use create(CCNode*, const CCRect&) intead. This interface will be deprecated sooner or later. + @deprecated: Please use create(CCNode*, const CCRect&) instead. This interface will be deprecated sooner or later. */ CC_DEPRECATED_ATTRIBUTE static CCFollow* actionWithTarget(CCNode *pFollowedNode, const CCRect& rect = CCRectZero); /** creates the action with a set boundary, diff --git a/cocos2dx/actions/CCActionCatmullRom.cpp b/cocos2dx/actions/CCActionCatmullRom.cpp index 632cd160a6..6c06f8be59 100644 --- a/cocos2dx/actions/CCActionCatmullRom.cpp +++ b/cocos2dx/actions/CCActionCatmullRom.cpp @@ -26,7 +26,7 @@ * THE SOFTWARE. * * - * Orignal code by Radu Gruian: http://www.codeproject.com/Articles/30838/Overhauser-Catmull-Rom-Splines-for-Camera-Animatio.So + * Original code by Radu Gruian: http://www.codeproject.com/Articles/30838/Overhauser-Catmull-Rom-Splines-for-Camera-Animatio.So * * Adapted to cocos2d-x by Vit Valentin * @@ -96,12 +96,12 @@ CCPointArray::CCPointArray() :m_pControlPoints(NULL){} void CCPointArray::addControlPoint(CCPoint controlPoint) { - // should create a new object of CCPoint - // because developer always use this function like this + // should create a new object: CCPoint + // because developers are accustomed to using // addControlPoint(ccp(x, y)) - // passing controlPoint is a temple object - // and CCArray::addObject() will retain the passing object, so it - // should be an object created in heap + // which assumes controlPoint is a temporary struct + // but CCArray::addObject() will retain the passed object, so temp + // should be an object created in the heap. CCPoint *temp = new CCPoint(controlPoint.x, controlPoint.y); m_pControlPoints->addObject(temp); temp->release(); @@ -109,12 +109,12 @@ void CCPointArray::addControlPoint(CCPoint controlPoint) void CCPointArray::insertControlPoint(CCPoint &controlPoint, unsigned int index) { - // should create a new object of CCPoint - // because developer always use this function like this + // should create a new object: CCPoint + // because developers are accustomed to using // insertControlPoint(ccp(x, y)) - // passing controlPoint is a temple object - // and CCArray::insertObject() will retain the passing object, so it - // should be an object created in heap + // which assumes controlPoint is a temporary struct + // but CCArray::insertObject() will retain the passed object, so temp + // should be an object created in the heap. CCPoint *temp = new CCPoint(controlPoint.x, controlPoint.y); m_pControlPoints->insertObject(temp, index); temp->release(); @@ -130,12 +130,12 @@ CCPoint CCPointArray::getControlPointAtIndex(unsigned int index) void CCPointArray::replaceControlPoint(cocos2d::CCPoint &controlPoint, unsigned int index) { - // should create a new object of CCPoint - // because developer always use this function like this + // should create a new object: CCPoint + // because developers are accustomed to using // replaceControlPoint(ccp(x, y)) - // passing controlPoint is a temple object - // and CCArray::insertObject() will retain the passing object, so it - // should be an object created in heap + // which assumes controlPoint is a temporary struct + // but CCArray::insertObject() will retain the passed object, so temp + // should be an object created in the heap. CCPoint *temp = new CCPoint(controlPoint.x, controlPoint.y); m_pControlPoints->replaceObjectAtIndex(index, temp); temp->release();