Merge pull request #14614 from mogemimi/fix-doc-and-comment-typo

Fix typo in documentation and comments

Author: slackmoehrle

cocos/2d/CCFontAtlasCache.h

@@ -54,7 +54,7 @@ class CC_DLL FontAtlasCache
      */
     static void purgeCachedData();
 
-    /** Release current FNT texutre and reload it.
+    /** Release current FNT texture and reload it.
      CAUTION : All component use this font texture should be reset font name, though the file name is same!
                otherwise, it will cause program crash!
     */

cocos/2d/CCLabel.cpp

@@ -586,7 +586,7 @@ bool Label::setBMFontFilePath(const std::string& bmfontFilePath, const Vec2& ima
         return false;
     }
 
-    //asign the default fontSize
+    //assign the default fontSize
     if (fabs(fontSize) < FLT_EPSILON) {
         FontFNT *bmFont = (FontFNT*)newAtlas->getFont();
         if (bmFont) {
@@ -1939,7 +1939,7 @@ float Label::getRenderingFontSize()const
         fontSize = this->getTTFConfig().fontSize;
     }else if(_currentLabelType == LabelType::STRING_TEXTURE){
         fontSize = _systemFontSize;
-    }else{ //FIXME: find a way to caculate char map font size
+    }else{ //FIXME: find a way to calculate char map font size
         fontSize = this->getLineHeight();
     }
     return fontSize;

cocos/2d/CCRenderTexture.cpp

@@ -496,7 +496,7 @@ Image* RenderTexture::newImage(bool fliimage)
         glGetIntegerv(GL_FRAMEBUFFER_BINDING, &_oldFBO);
         glBindFramebuffer(GL_FRAMEBUFFER, _FBO);
 
-        // TODO: move this to configration, so we don't check it every time
+        // TODO: move this to configuration, so we don't check it every time
         /*  Certain Qualcomm Andreno gpu's will retain data in memory after a frame buffer switch which corrupts the render to the texture. The solution is to clear the frame buffer before rendering to the texture. However, calling glClear has the unintended result of clearing the current texture. Create a temporary texture to overcome this. At the end of RenderTexture::begin(), switch the attached texture to the second one, call glClear, and then switch back to the original texture. This solution is unnecessary for other devices as they don't have the same issue with switching frame buffers.
          */
         if (Configuration::getInstance()->checkForGLExtension("GL_QCOM"))
@@ -581,7 +581,7 @@ void RenderTexture::onBegin()
     glGetIntegerv(GL_FRAMEBUFFER_BINDING, &_oldFBO);
     glBindFramebuffer(GL_FRAMEBUFFER, _FBO);
 
-    // TODO: move this to configration, so we don't check it every time
+    // TODO: move this to configuration, so we don't check it every time
     /*  Certain Qualcomm Andreno gpu's will retain data in memory after a frame buffer switch which corrupts the render to the texture. The solution is to clear the frame buffer before rendering to the texture. However, calling glClear has the unintended result of clearing the current texture. Create a temporary texture to overcome this. At the end of RenderTexture::begin(), switch the attached texture to the second one, call glClear, and then switch back to the original texture. This solution is unnecessary for other devices as they don't have the same issue with switching frame buffers.
      */
     if (Configuration::getInstance()->checkForGLExtension("GL_QCOM"))

cocos/3d/CCMesh.h

@@ -96,12 +96,12 @@ class CC_DLL Mesh : public Ref
     int getVertexSizeInBytes() const;
 
     /**
-     * set texture (diffuse), which is responsible for the main apearence. It is also means main textrue, you can also call setTexture(texPath, NTextureData::Usage::Diffuse)
+     * set texture (diffuse), which is responsible for the main appearance. It is also means main texture, you can also call setTexture(texPath, NTextureData::Usage::Diffuse)
      * @param texPath texture path
      */
     void setTexture(const std::string& texPath);
     /**
-     * set texture (diffuse), which is responsible for the main apearence. It is also means main textrue, you can also call setTexture(texPath, NTextureData::Usage::Diffuse)
+     * set texture (diffuse), which is responsible for the main appearance. It is also means main texture, you can also call setTexture(texPath, NTextureData::Usage::Diffuse)
      * @param tex texture to be set
      */
     void setTexture(Texture2D* tex);
@@ -118,14 +118,14 @@ class CC_DLL Mesh : public Ref
      */
     void setTexture(const std::string& texPath, NTextureData::Usage usage);
     /**
-     * Get texture (diffuse), which is responsible for the main apearence. It is also means main textrue, you can also call getTexture(NTextureData::Usage::Diffuse)
+     * Get texture (diffuse), which is responsible for the main appearance. It is also means main texture, you can also call getTexture(NTextureData::Usage::Diffuse)
      * @return Texture used, return the texture of first mesh if multiple meshes exist
      */
     Texture2D* getTexture() const;
     /**
-     * Get textrue
+     * Get texture
      * @param usage Usage of returned texture
-     * @return The texture of this usage, return the textrue of first mesh if multiple meshes exist
+     * @return The texture of this usage, return the texture of first mesh if multiple meshes exist
      */
     Texture2D* getTexture(NTextureData::Usage usage);
 
@@ -230,7 +230,7 @@ class CC_DLL Mesh : public Ref
     void checkTexture();
 
     /**
-     * set enable check texture, check texture each frame if eanble is true. It is false by default
+     * set enable check texture, check texture each frame if enable is true. It is false by default
      */
     void setEnableCheckTexture(bool enableCheckTexture) { _enableCheckTexture = enableCheckTexture; }
     /**

cocos/3d/CCMeshSkin.h

@@ -43,7 +43,7 @@ class Skeleton3D;
 
 /**
  * @brief MeshSkin, A class maintain a collection of bones that affect Mesh vertex.
- * And it is responsible for computing matrix palletes that used by skin mesh rendering.
+ * And it is responsible for computing matrix palettes that used by skin mesh rendering.
  * @js NA
  * @lua NA
  */

cocos/3d/CCObjLoader.cpp

@@ -1,7 +1,7 @@
 //
 // Copyright 2012-2015, Syoyo Fujita.
 //
-// Licensed under 2-clause BSD liecense.
+// Licensed under 2-clause BSD license.
 //
 
 //

cocos/3d/CCObjLoader.h

@@ -1,7 +1,7 @@
 //
 // Copyright 2012-2015, Syoyo Fujita.
 //
-// Licensed under 2-clause BSD liecense.
+// Licensed under 2-clause BSD license.
 //
 //https://github.com/syoyo/tinyobjloader
 #ifndef _TINY_OBJ_LOADER_H

cocos/3d/CCTerrain.h

@@ -265,7 +265,7 @@ class CC_DLL Terrain : public Node
 
    /**
     *QuadTree
-    * @breif use to hierarchically frustum culling and set LOD
+    * @brief use to hierarchically frustum culling and set LOD
     **/
     struct CC_DLL QuadTree
     {

cocos/audio/ios/CDAudioManager.h

@@ -120,7 +120,7 @@ typedef enum {
 -(void) load:(NSString*) filePath;
 /** Plays the audio source */
 -(void) play;
-/** Stops playing the audio soruce */
+/** Stops playing the audio source */
 -(void) stop;
 /** Pauses the audio source */
 -(void) pause;

cocos/audio/ios/CDAudioManager.m

@@ -61,7 +61,7 @@ -(void) dealloc {
 }    
 
 -(void) load:(NSString*) filePath {
-    //We have alread loaded a file previously,  check if we are being asked to load the same file
+    //We have already loaded a file previously, check if we are being asked to load the same file
     if (state == kLAS_Init || ![filePath isEqualToString:audioSourceFilePath]) {
         CDLOGINFO(@"Denshion::CDLongAudioSource - Loading new audio source %@",filePath);
         //New file
@@ -627,7 +627,7 @@ -(void) setResignBehavior:(tAudioManagerResignBehavior) resignBehavior autoHandl
 - (void) applicationWillResignActive {
     _resigned = YES;
 
-    //Set the audio sesssion to one that allows sharing so that other audio won't be clobbered on resume
+    //Set the audio session to one that allows sharing so that other audio won't be clobbered on resume
     [self audioSessionSetCategory:AVAudioSessionCategoryAmbient];
 
     switch (_resignBehavior) {

cocos/audio/mac/CDAudioManager.h

@@ -119,7 +119,7 @@ typedef enum {
 -(void) load:(NSString*) filePath;
 /** Plays the audio source */
 -(void) play;
-/** Stops playing the audio soruce */
+/** Stops playing the audio source */
 -(void) stop;
 /** Pauses the audio source */
 -(void) pause;

cocos/audio/mac/CDAudioManager.m

@@ -60,7 +60,7 @@ -(void) dealloc {
 }    
 
 -(void) load:(NSString*) filePath {
-    //We have alread loaded a file previously,  check if we are being asked to load the same file
+    //We have already loaded a file previously, check if we are being asked to load the same file
     if (state == kLAS_Init || ![filePath isEqualToString:audioSourceFilePath]) {
         CDLOGINFO(@"Denshion::CDLongAudioSource - Loading new audio source %@",filePath);
         //New file
@@ -621,7 +621,7 @@ -(void) setResignBehavior:(tAudioManagerResignBehavior) resignBehavior autoHandl
 - (void) applicationWillResignActive {
     _resigned = YES;
 
-    //Set the audio sesssion to one that allows sharing so that other audio won't be clobbered on resume
+    //Set the audio session to one that allows sharing so that other audio won't be clobbered on resume
     [self audioSessionSetCategory:AVAudioSessionCategoryAmbient];
 
     switch (_resignBehavior) {

cocos/audio/win32/MciPlayer.cpp

@@ -143,7 +143,7 @@ void MciPlayer::Resume()
 {
     if (strExt == ".mid")
     {
-        // midi not supprt MCI_RESUME, should get the position and use MCI_FROM
+        // midi not support MCI_RESUME, should get the position and use MCI_FROM
         MCI_STATUS_PARMS mciStatusParms;
         MCI_PLAY_PARMS   mciPlayParms;  
         mciStatusParms.dwItem = MCI_STATUS_POSITION;   

cocos/audio/winrt/Audio.h

@@ -122,7 +122,7 @@ class Audio
     void Start();
     void Render();
 
-    // This flag can be used to tell when the audio system is experiencing critial errors.
+    // This flag can be used to tell when the audio system is experiencing critical errors.
     // XAudio2 gives a critical error when the user unplugs their headphones, and a new
     // speaker configuration is generated.
     void SetEngineExperiencedCriticalError()

cocos/base/CCDirector.cpp

@@ -445,7 +445,7 @@ void Director::setNextDeltaTimeZero(bool nextDeltaTimeZero)
 //
 // FIXME TODO
 // Matrix code MUST NOT be part of the Director
-// MUST BE moved outide.
+// MUST BE moved outside.
 // Why the Director must have this code ?
 //
 void Director::initMatrixStack()

cocos/base/ZipUtils.h

@@ -225,7 +225,7 @@ typedef struct unz_file_info_s unz_file_info;
     * Zip file - reader helper class.
     *
     * It will cache the file list of a particular zip file with positions inside an archive,
-    * so it would be much faster to read some particular files or to check their existance.
+    * so it would be much faster to read some particular files or to check their existence.
     *
     * @since v2.0.5
     */
@@ -258,7 +258,7 @@ typedef struct unz_file_info_s unz_file_info;
         /**
         * Check does a file exists or not in zip file
         *
-        * @param fileName File to be checked on existance
+        * @param fileName File to be checked on existence
         * @return true whenever file exists, false otherwise
         *
         * @since v2.0.5

cocos/base/ccUTF8.cpp

@@ -89,7 +89,7 @@ bool isCJKUnicode(char16_t ch)
         || (ch >= 0xAC00 && ch <= 0xD7AF)   // Hangul Syllables
         || (ch >= 0xF900 && ch <= 0xFAFF)   // CJK Compatibility Ideographs
         || (ch >= 0xFE30 && ch <= 0xFE4F)   // CJK Compatibility Forms
-        || (ch >= 0x31C0 && ch <= 0x4DFF);  // Other exiensions
+        || (ch >= 0x31C0 && ch <= 0x4DFF);  // Other extensions
 }
 
 void trimUTF16Vector(std::vector<char16_t>& str)

cocos/math/Vec2.cpp

@@ -24,7 +24,7 @@
 
 NS_CC_MATH_BEGIN
 
-// returns true if segment A-B intersects with segment C-D. S->E is the ovderlap part
+// returns true if segment A-B intersects with segment C-D. S->E is the overlap part
 bool isOneDimensionSegmentOverlap(float A, float B, float C, float D, float *S, float * E)
 {
     float ABmin = std::min(A, B);

cocos/renderer/CCGroupCommand.h

@@ -57,7 +57,7 @@ class GroupCommandManager : public Ref
 
 /**
  GroupCommand is used to group several command together, and more, it can be nested.
- So it is used to generate the hierarchy for the rendcommands. Evey group command will be assigned by a group ID.
+ So it is used to generate the hierarchy for the rendcommands. Every group command will be assigned by a group ID.
  */
 class CC_DLL GroupCommand : public RenderCommand
 {

cocos/renderer/CCPass.h

@@ -57,13 +57,13 @@ class CC_DLL Pass : public RenderState
     GLProgramState* getGLProgramState() const;
 
     /** Binds the GLProgramState and the RenderState.
-     This method must be called before call the actuall draw call.
+     This method must be called before call the actual draw call.
      */
     void bind(const Mat4& modelView);
     void bind(const Mat4& modelView, bool bindAttributes);
 
     /** Unbinds the Pass.
-     This method must be called AFTER calling the actuall draw call
+     This method must be called AFTER calling the actual draw call
      */
     void unbind();
 

cocos/renderer/CCRenderState.cpp

@@ -197,7 +197,7 @@ RenderState::StateBlock* RenderState::StateBlock::create()
 }
 
 //
-// The defaults are based on GamePlay3D defaults, with the following chagnes
+// The defaults are based on GamePlay3D defaults, with the following changes
 // _depthWriteEnabled is FALSE
 // _depthTestEnabled is TRUE
 // _blendEnabled is TRUE

cocos/renderer/CCRenderer.cpp

@@ -869,7 +869,7 @@ void Renderer::drawBatchedTriangles()
         glBufferData(GL_ELEMENT_ARRAY_BUFFER, sizeof(_indices[0]) * _filledIndex, _indices, GL_STATIC_DRAW);
     }
 
-    //Start drawing verties in batch
+    //Start drawing vertices in batch
     for(const auto& cmd : _batchedCommands)
     {
         auto newMaterialID = cmd->getMaterialID();

cocos/renderer/CCTextureCache.h

@@ -207,7 +207,7 @@ class CC_DLL TextureCache : public Ref
     void setDirty(bool dirty) { _dirty = dirty; }
     bool isDirty() const { return _dirty; }
 
-    /** Reload texuture from a new file.
+    /** Reload texture from a new file.
     * This function is mainly for editor, won't suggest use it in game for performance reason.
     *
     * @param srcName Original texture file name.

cocos/renderer/CCTrianglesCommand.h

@@ -54,7 +54,7 @@ class CC_DLL TrianglesCommand : public RenderCommand
         /**The number of indices.*/
         ssize_t indexCount;
     };
-    /**Construtor.*/
+    /**Constructor.*/
     TrianglesCommand();
     /**Destructor.*/
     ~TrianglesCommand();