Permalink
Browse files

Fixes syntax errors in docstrings

  • Loading branch information...
ricardoquesada committed Sep 8, 2012
1 parent 57855db commit 428cea338e100ad6ae762e4c80b6d54fd15743e9
Showing with 135 additions and 134 deletions.
  1. +1 −0 CHANGELOG
  2. +1 −1 RELEASE_NOTES
  3. +4 −4 cocos2d/CCAction.h
  4. +9 −9 cocos2d/CCActionEase.h
  5. +1 −1 cocos2d/CCActionGrid3D.h
  6. +1 −1 cocos2d/CCActionInstant.h
  7. +12 −12 cocos2d/CCActionInterval.h
  8. +2 −2 cocos2d/CCActionManager.h
  9. +1 −1 cocos2d/CCAnimationCache.h
  10. +2 −2 cocos2d/CCAtlasNode.h
  11. +1 −1 cocos2d/CCCamera.h
  12. +6 −6 cocos2d/CCDirector.h
  13. +2 −2 cocos2d/CCDrawingPrimitives.h
  14. +1 −1 cocos2d/CCGrid.h
  15. +2 −2 cocos2d/CCLabelBMFont.h
  16. +4 −4 cocos2d/CCLabelTTF.h
  17. +6 −6 cocos2d/CCLayer.h
  18. +5 −5 cocos2d/CCMenuItem.h
  19. +1 −1 cocos2d/CCMotionStreak.h
  20. +2 −2 cocos2d/CCNode.h
  21. +5 −5 cocos2d/CCProtocols.h
  22. +1 −1 cocos2d/CCRenderTexture.h
  23. +6 −6 cocos2d/CCScheduler.h
  24. +3 −3 cocos2d/CCSpriteBatchNode.h
  25. +3 −3 cocos2d/CCSpriteFrameCache.h
  26. +2 −2 cocos2d/CCTMXLayer.h
  27. +2 −2 cocos2d/CCTMXTiledMap.h
  28. +1 −1 cocos2d/CCTexture2D.h
  29. +1 −1 cocos2d/CCTextureAtlas.h
  30. +3 −3 cocos2d/CCTextureCache.h
  31. +1 −1 cocos2d/CCTileMapAtlas.h
  32. +2 −2 cocos2d/CCTransition.h
  33. +3 −3 cocos2d/CCTransitionProgress.h
  34. +1 −1 cocos2d/Platforms/Mac/CCDirectorMac.h
  35. +3 −3 cocos2d/Platforms/Mac/CCEventDispatcher.h
  36. +1 −1 cocos2d/Platforms/iOS/CCDirectorIOS.h
  37. +2 −2 cocos2d/Platforms/iOS/CCTouchHandler.h
  38. +1 −1 cocos2d/Support/CCArray.h
  39. +2 −2 cocos2d/Support/CCFileUtils.h
  40. +1 −1 cocos2d/Support/CCVertex.h
  41. +2 −2 cocos2d/Support/ZipUtils.h
  42. +15 −15 cocos2d/Support/ccCArray.h
  43. +6 −6 cocos2d/ccConfig.h
  44. +1 −1 cocos2d/ccMacros.h
  45. +1 −1 cocos2d/ccTypes.h
  46. +1 −1 cocos2d/cocos2d.h
  47. +1 −1 doxygen.config
View
@@ -16,6 +16,7 @@ version 2.1-beta 7-Sept-2012
. [NEW] Physics nodes: PhysicsSprite and PhysicsDebugNode are part of cocos2d
. [NEW] Tests: Tests for RotationalSkew feature
. [NEW] Texture: Supports PVR v3 file format
+. [FIX] All: fixed many English grammar/syntax errors in the docstrings
. [FIX] Actions: Fixed possible double 'fire' of instant actions inside a sequence (issue #1398)
. [FIX] Director: Fixed flicker again.
Autorotation works on iOS6.
View
@@ -1,4 +1,4 @@
===== cocos2d for iPhone 2.1.0 Release Notes =====
Please, see the online document:
-http://www.cocos2d-iphone.org/wiki/doku.php/release_notes:2_0_0
+http://www.cocos2d-iphone.org/wiki/doku.php/release_notes:2_1_0
View
@@ -91,7 +91,7 @@ enum {
Possible actions:
- An action with a duration of 0 seconds
- An action with a duration of 35.5 seconds
- Infitite time actions are valid
+ Infinite time actions are valid
*/
@interface CCFiniteTimeAction : CCAction <NSCopying>
{
@@ -109,7 +109,7 @@ enum {
@class CCActionInterval;
/** Repeats an action for ever.
To repeat the an action for a limited number of times use the Repeat action.
- @warning This action can't be Sequenceable because it is not an IntervalAction
+ @warning This action can't be Sequence-able because it is not an IntervalAction
*/
@interface CCRepeatForever : CCAction <NSCopying>
{
@@ -127,7 +127,7 @@ enum {
/** Changes the speed of an action, making it take longer (speed<1)
or less (speed>1) time.
Useful to simulate 'slow motion' or 'fast forward' effect.
- @warning This action can't be Sequenceable because it is not an CCIntervalAction
+ @warning This action can't be Sequence-able because it is not an CCIntervalAction
*/
@interface CCSpeed : CCAction <NSCopying>
{
@@ -162,7 +162,7 @@ enum {
/* whether camera should be limited to certain area */
BOOL boundarySet;
- /* if screensize is bigger than the boundary - update not needed */
+ /* if screen-size is bigger than the boundary - update not needed */
BOOL boundaryFullyCovered;
/* fast access to the screen dimensions */
View
@@ -142,7 +142,7 @@
@end
/** Ease Elastic In action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseElasticIn : CCEaseElastic <NSCopying>
@@ -152,7 +152,7 @@
@end
/** Ease Elastic Out action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseElasticOut : CCEaseElastic <NSCopying>
@@ -162,7 +162,7 @@
@end
/** Ease Elastic InOut action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseElasticInOut : CCEaseElastic <NSCopying>
@@ -181,7 +181,7 @@
@end
/** CCEaseBounceIn action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseBounceIn : CCEaseBounce <NSCopying>
@@ -191,7 +191,7 @@
@end
/** EaseBounceOut action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseBounceOut : CCEaseBounce <NSCopying>
@@ -201,7 +201,7 @@
@end
/** CCEaseBounceInOut action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseBounceInOut : CCEaseBounce <NSCopying>
@@ -211,7 +211,7 @@
@end
/** CCEaseBackIn action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseBackIn : CCActionEase <NSCopying>
@@ -221,7 +221,7 @@
@end
/** CCEaseBackOut action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseBackOut : CCActionEase <NSCopying>
@@ -231,7 +231,7 @@
@end
/** CCEaseBackInOut action.
- @warning This action doesn't use a bijective fucntion. Actions like Sequence might have an unexpected result when used with this action.
+ @warning This action doesn't use a bijective function. Actions like Sequence might have an unexpected result when used with this action.
@since v0.8.2
*/
@interface CCEaseBackInOut : CCActionEase <NSCopying>
View
@@ -53,7 +53,7 @@
/** creates the action with duration */
+(id) actionWithDuration:(ccTime)d;
-/** initizlies the action with duration */
+/** initializes the action with duration */
-(id) initWithDuration:(ccTime)d;
@end
@@ -111,7 +111,7 @@
+(id) actionWithTarget: (id) t selector:(SEL) s;
/** initializes the action with the callback */
-(id) initWithTarget: (id) t selector:(SEL) s;
-/** exeuctes the callback */
+/** executes the callback */
-(void) execute;
@end
View
@@ -74,11 +74,11 @@ then running it again in Reverse mode.
ccTime split_;
int last_;
}
-/** helper contructor to create an array of sequenceable actions */
+/** helper constructor to create an array of sequence-able actions */
+(id) actions: (CCFiniteTimeAction*) action1, ... NS_REQUIRES_NIL_TERMINATION;
-/** helper contructor to create an array of sequenceable actions */
+/** helper constructor to create an array of sequence-able actions */
+(id) actions: (CCFiniteTimeAction*) action1 vaList:(va_list) args;
-/** helper contructor to create an array of sequenceable actions given an array */
+/** helper constructor to create an array of sequence-able actions given an array */
+(id) actionWithArray: (NSArray*) arrayOfActions;
/** creates the action */
+(id) actionOne:(CCFiniteTimeAction*)actionOne two:(CCFiniteTimeAction*)actionTwo;
@@ -120,7 +120,7 @@ then running it again in Reverse mode.
+(id) actions: (CCFiniteTimeAction*) action1, ... NS_REQUIRES_NIL_TERMINATION;
/** helper constructor to create an array of spawned actions */
+(id) actions: (CCFiniteTimeAction*) action1 vaList:(va_list)args;
-/** helper contructor to create an array of spawned actions given an array */
+/** helper constructor to create an array of spawned actions given an array */
+(id) actionWithArray: (NSArray*) arrayOfActions;
/** creates the Spawn action */
+(id) actionOne: (CCFiniteTimeAction*) one two:(CCFiniteTimeAction*) two;
@@ -147,12 +147,12 @@ then running it again in Reverse mode.
/** initializes the action */
-(id) initWithDuration:(ccTime)duration angle:(float)angle;
-/** creates the action with seperate rotation angles */
+/** creates the action with separate rotation angles */
+(id) actionWithDuration: (ccTime) t angleX:(float) aX angleY:(float) aY;
-(id) initWithDuration: (ccTime) t angleX:(float) aX angleY:(float) aY;
@end
-/** Rotates a CCNode object clockwise a number of degrees by modiying its rotation attribute.
+/** Rotates a CCNode object clockwise a number of degrees by modifying its rotation attribute.
*/
@interface CCRotateBy : CCActionInterval <NSCopying>
{
@@ -166,7 +166,7 @@ then running it again in Reverse mode.
/** initializes the action */
-(id) initWithDuration:(ccTime)duration angle:(float)deltaAngle;
-/** creates the action with seperate rotation angles */
+/** creates the action with separate rotation angles */
+(id) actionWithDuration: (ccTime) t angleX:(float) aX angleY:(float) aY;
-(id) initWithDuration: (ccTime) t angleX:(float) aX angleY:(float) aY;
@end
@@ -329,7 +329,7 @@ typedef struct _ccBezierConfig {
}
/** creates the action */
+(id) actionWithDuration: (ccTime)duration blinks:(NSUInteger)blinks;
-/** initilizes the action */
+/** initializes the action */
-(id) initWithDuration: (ccTime)duration blinks:(NSUInteger)blinks;
@end
@@ -361,7 +361,7 @@ typedef struct _ccBezierConfig {
GLubyte toOpacity_;
GLubyte fromOpacity_;
}
-/** creates an action with duration and opactiy */
+/** creates an action with duration and opacity */
+(id) actionWithDuration:(ccTime)duration opacity:(GLubyte)opactiy;
/** initializes the action with duration and opacity */
-(id) initWithDuration:(ccTime)duration opacity:(GLubyte)opacity;
@@ -408,7 +408,7 @@ typedef struct _ccBezierConfig {
/** Executes an action in reverse order, from time=duration to time=0
@warning Use this action carefully. This action is not
- sequenceable. Use it as the default "reversed" method
+ sequence-able. Use it as the default "reversed" method
of your own actions, but using it outside the "reversed"
scope is not recommended.
*/
@@ -434,12 +434,12 @@ typedef struct _ccBezierConfig {
id origFrame_;
NSUInteger executedLoops_;
}
-/** animation used for the animage */
+/** animation used for the image */
@property (readwrite,nonatomic,retain) CCAnimation * animation;
/** creates the action with an Animation and will restore the original frame when the animation is over */
+(id) actionWithAnimation:(CCAnimation*)animation;
-/** initializes the action with an Animation and will restore the original frame when the animtion is over */
+/** initializes the action with an Animation and will restore the original frame when the animation is over */
-(id) initWithAnimation:(CCAnimation*)animation;
@end
@@ -47,7 +47,7 @@ typedef struct _hashElement
/** CCActionManager the object that manages all the actions.
Normally you won't need to use this API directly. 99% of the cases you will use the CCNode interface, which uses this object.
- But there are some cases where you might need to use this API dirctly:
+ But there are some cases where you might need to use this API directly:
Examples:
- When you want to run an action where the target is different from a CCNode.
- When you want to pause / resume the actions
@@ -70,7 +70,7 @@ typedef struct _hashElement
When the target is paused, the queued actions won't be 'ticked'.
*/
-(void) addAction: (CCAction*) action target:(id)target paused:(BOOL)paused;
-/** Removes all actions from all the targers.
+/** Removes all actions from all the targets.
*/
-(void) removeAllActions;
@@ -38,7 +38,7 @@
NSMutableDictionary *animations_;
}
-/** Retruns ths shared instance of the Animation cache */
+/** Returns the shared instance of the Animation cache */
+ (CCAnimationCache *) sharedAnimationCache;
/** Purges the cache. It releases all the CCAnimation objects and the shared instance.
View
@@ -33,7 +33,7 @@
CCTextureProtocol protocol
It knows how to render a TextureAtlas object.
- If you are going to render a TextureAtlas consider subclassing CCAtlasNode (or a subclass of CCAtlasNode)
+ If you are going to render a TextureAtlas consider sub-classing CCAtlasNode (or a subclass of CCAtlasNode)
All features from CCNode are valid, plus the following features:
- opacity and RGB colors
@@ -90,7 +90,7 @@
-(id) initWithTileFile:(NSString*)tile tileWidth:(NSUInteger)w tileHeight:(NSUInteger)h itemsToRender: (NSUInteger) c;
/** updates the Atlas (indexed vertex array).
- * Shall be overriden in subclasses
+ * Shall be overridden in subclasses
*/
-(void) updateAtlasValues;
@end
View
@@ -47,7 +47,7 @@
- It doesn't work on batched nodes like CCSprite objects when they are parented to a CCSpriteBatchNode object.
- - It is recommended to use it ONLY if you are going to create 3D effects. For 2D effecs, use the action CCFollow or position/scale/rotate.
+ - It is recommended to use it ONLY if you are going to create 3D effects. For 2D effects, use the action CCFollow or position/scale/rotate.
*/
View
@@ -66,7 +66,7 @@ typedef enum {
/**Class that creates and handle the main Window and manages how
and when to execute the Scenes.
- The CCDirector is also resposible for:
+ The CCDirector is also responsible for:
- initializing the OpenGL ES context
- setting the OpenGL pixel format (default on is RGB565)
- setting the OpenGL buffer depth (default one is 0-bit)
@@ -193,7 +193,7 @@ and when to execute the Scenes.
*/
@property (nonatomic, readwrite, retain) id notificationNode;
-/** CCDirector delegate. It shall implemente the CCDirectorDelegate protocol
+/** CCDirector delegate. It shall implement the CCDirectorDelegate protocol
@since v0.99.5
*/
@property (nonatomic, readwrite, retain) id<CCDirectorDelegate> delegate;
@@ -227,7 +227,7 @@ and when to execute the Scenes.
-(void) reshapeProjection:(CGSize)newWindowSize;
/** converts a UIKit coordinate to an OpenGL coordinate
- Useful to convert (multi) touchs coordinates to the current layout (portrait or landscape)
+ Useful to convert (multi) touch coordinates to the current layout (portrait or landscape)
*/
-(CGPoint) convertToGL: (CGPoint) p;
/** converts an OpenGL coordinate to a UIKit coordinate
@@ -281,7 +281,7 @@ and when to execute the Scenes.
/** Pauses the running scene.
The running scene will be _drawed_ but all scheduled timers will be paused
- While paused, the draw rate will be 4 FPS to reduce CPU consuption
+ While paused, the draw rate will be 4 FPS to reduce CPU consumption
*/
-(void) pause;
@@ -292,13 +292,13 @@ and when to execute the Scenes.
-(void) resume;
/** Stops the animation. Nothing will be drawn. The main loop won't be triggered anymore.
- If you wan't to pause your animation call [pause] instead.
+ If you want to pause your animation call [pause] instead.
*/
-(void) stopAnimation;
/** The main loop is triggered again.
Call this function only if [stopAnimation] was called earlier
- @warning Dont' call this function to start the main loop. To run the main loop call runWithScene
+ @warning Don't call this function to start the main loop. To run the main loop call runWithScene
*/
-(void) startAnimation;
@@ -91,12 +91,12 @@ void ccDrawRect( CGPoint origin, CGPoint destination );
*/
void ccDrawSolidRect( CGPoint origin, CGPoint destination, ccColor4F color );
-/** draws a poligon given a pointer to CGPoint coordiantes and the number of vertices measured in points.
+/** draws a polygon given a pointer to CGPoint coordinates and the number of vertices measured in points.
The polygon can be closed or open
*/
void ccDrawPoly( const CGPoint *vertices, NSUInteger numOfVertices, BOOL closePolygon );
-/** draws a solid polygon given a pointer to CGPoint coordiantes, the number of vertices measured in points, and a color.
+/** draws a solid polygon given a pointer to CGPoint coordinates, the number of vertices measured in points, and a color.
*/
void ccDrawSolidPoly( const CGPoint *poli, NSUInteger numberOfPoints, ccColor4F color );
View
@@ -53,7 +53,7 @@
ccDirectorProjection directorProjection_;
}
-/** wheter or not the grid is active */
+/** whether or not the grid is active */
@property (nonatomic,readwrite) BOOL active;
/** number of times that the grid will be reused */
@property (nonatomic,readwrite) int reuseGrid;
View
@@ -99,7 +99,7 @@ typedef struct _KerningHashElement
// atlas name
NSString *atlasName_;
- // XXX: Creating a public interface so that the bitmapFontArray[] is accesible
+ // XXX: Creating a public interface so that the bitmapFontArray[] is accessible
@public
// BMFont definitions
@@ -205,7 +205,7 @@ typedef struct _KerningHashElement
+(id) labelWithString:(NSString*)string fntFile:(NSString*)fntFile;
/** creates a BMFont label with an initial string, the FNT file, width, and alignment option */
+(id) labelWithString:(NSString*)string fntFile:(NSString*)fntFile width:(float)width alignment:(CCTextAlignment)alignment;
-/** creates a BMFont label with an initial string, the FNT file, width, alignment option and the offset of where the glpyhs start on the .PNG image */
+/** creates a BMFont label with an initial string, the FNT file, width, alignment option and the offset of where the glyphs start on the .PNG image */
+(id) labelWithString:(NSString*)string fntFile:(NSString*)fntFile width:(float)width alignment:(CCTextAlignment)alignment imageOffset:(CGPoint)offset;
/** init a BMFont label with an initial string and the FNT file */
Oops, something went wrong.

0 comments on commit 428cea3

Please sign in to comment.