Merge pull request #14569 from mogemimi/fix-docs-typo

Fix typos in documentation

Author: zilongshanren

cocos/2d/CCActionCatmullRom.h

@@ -173,7 +173,7 @@ class CC_DLL CardinalSplineTo : public ActionInterval
      * @code
      * When this function bound to js or lua,the input params are changed.
      * In js: var create(var t,var table)
-     * In lua: lcaol create(local t, local table)
+     * In lua: local create(local t, local table)
      * @endcode
      */
     static CardinalSplineTo* create(float duration, PointArray* points, float tension);
@@ -249,7 +249,7 @@ class CC_DLL CardinalSplineBy : public CardinalSplineTo
      * @code
      * When this function bound to js or lua,the input params are changed.
      * In js: var create(var t,var table).
-     * In lua: lcaol create(local t, local table).
+     * In lua: local create(local t, local table).
      * @param duration In seconds.
      * @param point An PointArray.
      * @param tension Goodness of fit.
@@ -285,7 +285,7 @@ class CC_DLL CatmullRomTo : public CardinalSplineTo
      * @code
      * When this function bound to js or lua,the input params are changed.
      * In js: var create(var dt,var table).
-     * In lua: lcaol create(local dt, local table).
+     * In lua: local create(local dt, local table).
      * @endcode
      */
     static CatmullRomTo* create(float dt, PointArray* points);
@@ -318,7 +318,7 @@ class CC_DLL CatmullRomBy : public CardinalSplineBy
      * @code
      * When this function bound to js or lua,the input params are changed.
      * In js: var create(var dt,var table).
-     * In lua: lcaol create(local dt, local table).
+     * In lua: local create(local dt, local table).
      * @endcode
      */
     static CatmullRomBy* create(float dt, PointArray* points);

cocos/2d/CCActionInterval.h

@@ -394,7 +394,7 @@ class CC_DLL Spawn : public ActionInterval
     /** Creates the Spawn action.
      *
      * @param action1   The first spawned action.
-     * @param action2   THe second spawned action.
+     * @param action2   The second spawned action.
      * @return An autoreleased Spawn object.
      * @js NA
      */
@@ -877,7 +877,7 @@ class CC_DLL BezierBy : public ActionInterval
      * @code
      * When this function bound to js or lua,the input params are changed.
      * in js: var create(var t,var table)
-     * in lua: lcaol create(local t, local table)
+     * in lua: local create(local t, local table)
      * @endcode
      */
     static BezierBy* create(float t, const ccBezierConfig& c);
@@ -926,7 +926,7 @@ class CC_DLL BezierTo : public BezierBy
      * @code
      * when this function bound to js or lua,the input params are changed
      * in js: var create(var t,var table)
-     * in lua: lcaol create(local t, local table)
+     * in lua: local create(local t, local table)
      * @endcode
      */
     static BezierTo* create(float t, const ccBezierConfig& c);

cocos/2d/CCAtlasNode.h

@@ -139,7 +139,7 @@ class CC_DLL AtlasNode : public Node, public TextureProtocol
     ssize_t _quadsToDraw;
     /** Color uniform. */
     GLint    _uniformColor;
-    /** This varible is only used for LabelAtlas FPS display. So plz don't modify its value. */
+    /** This variable is only used for LabelAtlas FPS display. So plz don't modify its value. */
     bool _ignoreContentScaleFactor;
     /** Quad command. */
     QuadCommand _quadCommand;

cocos/2d/CCCameraBackgroundBrush.h

@@ -227,7 +227,7 @@ class CC_DLL CameraBackgroundSkyBoxBrush : public CameraBackgroundBrush
      */
     static CameraBackgroundSkyBoxBrush* create();
     /**
-     * Set skybox texutre 
+     * Set skybox texture 
      * @param texture Skybox texture
      */
     void setTexture(TextureCube*  texture);

cocos/2d/CCFastTMXLayer.h

@@ -276,7 +276,7 @@ class CC_DLL TMXLayer : public Node
     void updateTiles(const Rect& culledRect);
     Vec2 calculateLayerOffset(const Vec2& offset);
 
-    /* The layer recognizes some special properties, like cc_vertez */
+    /* The layer recognizes some special properties, like cc_vertexz */
     void parseInternalProperties();
 
     Mat4 tileToNodeTransform();

cocos/2d/CCNode.h

@@ -1809,7 +1809,7 @@ class CC_DLL Node : public Ref
     std::string _name;               ///<a string label, an user defined string to identify this node
     size_t _hashOfName;            ///<hash value of _name, used for speed in getChildByName
 
-    void *_userData;                ///< A user assingned void pointer, Can be point to any cpp object
+    void *_userData;                ///< A user assigned void pointer, Can be point to any cpp object
     Ref *_userObject;               ///< A user assigned Object
 
     GLProgramState *_glProgramState; ///< OpenGL Program State

cocos/2d/CCSpriteBatchNode.h

@@ -213,7 +213,7 @@ class CC_DLL SpriteBatchNode : public Node, public TextureProtocol
     virtual std::string getDescription() const override;
 
     /** Inserts a quad at a certain index into the texture atlas. The Sprite won't be added into the children array.
-     * This method should be called only when you are dealing with very big AtlasSrite and when most of the Sprite won't be updated.
+     * This method should be called only when you are dealing with very big AtlasSprite and when most of the Sprite won't be updated.
      * For example: a tile map (TMXMap) or a label with lots of characters (LabelBMFont).
      */
     void insertQuadFromSprite(Sprite *sprite, ssize_t index);
@@ -248,7 +248,7 @@ class CC_DLL SpriteBatchNode : public Node, public TextureProtocol
 
 protected:
     /** Updates a quad at a certain index into the texture atlas. The Sprite won't be added into the children array.
-     This method should be called only when you are dealing with very big AtlasSrite and when most of the Sprite won't be updated.
+     This method should be called only when you are dealing with very big AtlasSprite and when most of the Sprite won't be updated.
      For example: a tile map (TMXMap) or a label with lots of characters (LabelBMFont)
      */
     void updateQuadFromSprite(Sprite *sprite, ssize_t index);   

cocos/2d/CCTMXLayer.h

@@ -282,7 +282,7 @@ class CC_DLL TMXLayer : public SpriteBatchNode
     // Override
     //
     /** TMXLayer doesn't support adding a Sprite manually.
-     @warning addchild(z, tag); is not supported on TMXLayer. Instead of setTileGID.
+     @warning addChild(z, tag); is not supported on TMXLayer. Instead of setTileGID.
      */
     using SpriteBatchNode::addChild;
     virtual void addChild(Node * child, int zOrder, int tag) override;
@@ -305,7 +305,7 @@ class CC_DLL TMXLayer : public SpriteBatchNode
     Sprite* insertTileForGID(uint32_t gid, const Vec2& pos);
     Sprite* updateTileForGID(uint32_t gid, const Vec2& pos);
 
-    /* The layer recognizes some special properties, like cc_vertez */
+    /* The layer recognizes some special properties, like cc_vertexz */
     void parseInternalProperties();
     void setupTileSprite(Sprite* sprite, Vec2 pos, int gid);
     Sprite* reusedTileWithRect(Rect rect);

cocos/base/CCAutoreleasePool.h

@@ -37,7 +37,7 @@ NS_CC_BEGIN
 
 
 /**
- * A pool for managing autorlease objects.
+ * A pool for managing autorelease objects.
  * @js NA
  */
 class CC_DLL AutoreleasePool

cocos/base/CCEventController.h

@@ -62,7 +62,7 @@ class EventController : public Event
      * @return An autoreleased EventController object.
      */
 	EventController(ControllerEventType type, Controller* controller, int keyCode);
-    /** Create a EventController with controller event type, contrlloer and whether or not is connected.
+    /** Create a EventController with controller event type, controller and whether or not is connected.
      *
      * @param type A given controller event type.
      * @param controller A given controller pointer.

cocos/base/CCProperties.h

@@ -521,7 +521,7 @@ class CC_DLL Properties
     static bool parseAxisAngle(const char* str, Quaternion* out);
 
     /**
-     * Atempts to parse the specified string as an RGB color value.
+     * Attempts to parse the specified string as an RGB color value.
      *
      * @param str The string to parse.
      * @param out The value to populate if successful.
@@ -531,7 +531,7 @@ class CC_DLL Properties
     static bool parseColor(const char* str, Vec3* out);
 
     /**
-     * Atempts to parse the specified string as an RGBA color value.
+     * Attempts to parse the specified string as an RGBA color value.
      *
      * @param str The string to parse.
      * @param out The value to populate if successful.

cocos/base/CCScheduler.h

@@ -367,7 +367,7 @@ class CC_DLL Scheduler : public Ref
      */
     bool isScheduled(const std::string& key, void *target);
 
-    /** Checks whether a selector for a given taget is scheduled.
+    /** Checks whether a selector for a given target is scheduled.
      @param selector The selector to be checked.
      @param target The target of the callback.
      @return True if the specified selector is invoked, false if not.
@@ -475,7 +475,7 @@ class CC_DLL Scheduler : public Ref
      */
     CC_DEPRECATED_ATTRIBUTE void unscheduleSelector(SEL_SCHEDULE selector, Ref *target) { unschedule(selector, target); };
 
-    /** Checks whether a selector for a given taget is scheduled.
+    /** Checks whether a selector for a given target is scheduled.
      @deprecated Please use 'Scheduler::isScheduled' instead.
      @since v0.99.3
      @js NA

cocos/base/CCValue.h

@@ -96,7 +96,7 @@ class CC_DLL Value
     /** Create a Value by a ValueMapIntKey object. It will use std::move internally. */
     explicit Value(ValueMapIntKey&& v);
 
-    /** Create a Value by anthoer Value object. */
+    /** Create a Value by another Value object. */
     Value(const Value& other);
     /** Create a Value by a Value object. It will use std::move internally. */
     Value(Value&& other);

cocos/base/ZipUtils.h

@@ -169,7 +169,7 @@ typedef struct unz_file_info_s unz_file_info;
          *
          * Splitting the key into 4 parts and calling the function from 4 different source
          * files increases the difficulty to reverse engineer the encryption key.
-         * Be aware that encrpytion is *never* 100% secure and the key code
+         * Be aware that encryption is *never* 100% secure and the key code
          * can be cracked by knowledgable persons. 
          *
          * IMPORTANT: Be sure to call setPvrEncryptionKey or

cocos/base/ccTypes.h

@@ -556,7 +556,7 @@ struct CC_DLL FontDefinition
     TextHAlignment        _alignment;
     /// vertical alignment
     TextVAlignment _vertAlignment;
-    /// renering box
+    /// rendering box
     Size                  _dimensions;
     /// font color
     Color3B               _fontFillColor;

cocos/deprecated/CCDeprecated.h

@@ -261,7 +261,7 @@ CC_DEPRECATED_ATTRIBUTE static inline Vec2 ccpFromSize(const Size& s)
 }
 
 /** Run a math operation function on each point component
- * absf, fllorf, ceilf, roundf
+ * absf, floorf, ceilf, roundf
  * any function that has the signature: float func(float);
  * For example: let's try to take the floor of x,y
  * ccpCompOp(p,floorf);

cocos/deprecated/CCDictionary.h

@@ -1,6 +1,6 @@
 /****************************************************************************
 Copyright (c) 2012      cocos2d-x.org
- opyright (c) 2013-2015 Chukong Technologies Inc.
+Copyright (c) 2013-2015 Chukong Technologies Inc.
 
 http://www.cocos2d-x.org
 

cocos/math/Vec2.h

@@ -568,7 +568,7 @@ class CC_DLL Vec2
     }
 
     /** Run a math operation function on each point component
-     * absf, fllorf, ceilf, roundf
+     * absf, floorf, ceilf, roundf
      * any function that has the signature: float func(float);
      * For example: let's try to take the floor of x,y
      * p.compOp(floorf);
@@ -662,7 +662,7 @@ class CC_DLL Vec2
      @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.
+     @return    whether these two lines intersects.
 
      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

cocos/math/Vec3.h

@@ -275,7 +275,7 @@ class CC_DLL Vec3
     /**
      * Normalizes this vector.
      *
-     * This method normalizes this Vect3 so that it is of
+     * This method normalizes this Vec3 so that it is of
      * unit length (in other words, the length of the vector
      * after calling this method will be 1.0f). If the vector
      * already has unit length or if the length of the vector