Documentation fixes

A whole pile of (mostly?) non-controversial documentation fixes.

I am running jsdoc 3.0 on the doc tree to produce a FlowType declaration file (for static type analysis of JavaScript code). The docs are actually quite awesome in how much information they provide; considering how much of the documentation Just Worked, this really isn't that many bugs.

Some of the changes were because FlowType noticed that an inherited class member function signature didn't match the signature of the same function in an ancestor class. Many of the changes were just random typos.

I may have other similar pull requests in the future as I use Cocos2d/html more, and I find more of the documentation that needs to be fixed. In general I think this will just help the docs.

Let me know if you want me to actually submit *text* documentation changes. I could probably be encouraged to document bits of the code as I use them. I wrote an entire 500+ page book on an older (now dead) game SDK, just documenting things as I went, so it's become a bit of a habit.

(cherry picked from commit ec06396)
(cherry picked from commit a9909bb)
(cherry picked from commit 4a1839f)
(cherry picked from commit 5526087)
(cherry picked from commit 543b891)
(cherry picked from commit 94ee8d9)

Author: TimMensch

CCBoot.js

@@ -1894,8 +1894,8 @@ var _initSys = function () {
 };
 _initSys();
 
-delete _tmpCanvas1;
-delete _tmpCanvas2;
+delete window._tmpCanvas1;
+delete window._tmpCanvas2;
 
 //to make sure the cc.log, cc.warn, cc.error and cc.assert would not throw error before init by debugger mode.
 cc.log = cc.warn = cc.error = cc.assert = function () {
@@ -1923,9 +1923,9 @@ function _determineRenderType(config) {
     cc._renderType = cc.game.RENDER_TYPE_CANVAS;
     cc._supportRender = true;
 
-    if ( userRenderMode === 2 || 
-        (   userRenderMode === 0 && 
-            shieldOs.indexOf(cc.sys.os) === -1 && 
+    if ( userRenderMode === 2 ||
+        (   userRenderMode === 0 &&
+            shieldOs.indexOf(cc.sys.os) === -1 &&
             shieldBrowser.indexOf(cc.sys.browserType) === -1 )) {
         if (cc.sys.capabilities["opengl"]) {
             cc._renderType = cc.game.RENDER_TYPE_WEBGL;
@@ -2084,17 +2084,17 @@ cc.game = /** @lends cc.game# */{
         renderMode: "renderMode",
         jsList: "jsList"
     },
-    
+
     // states
     _paused: true,//whether the game is paused
     _prepareCalled: false,//whether the prepare function has been called
     _prepared: false,//whether the engine has prepared
     _rendererInitialized: false,
 
     _renderContext: null,
-    
+
     _intervalId: null,//interval target of main
-    
+
     _lastTime: null,
     _frameTime: null,
 
@@ -2207,7 +2207,7 @@ cc.game = /** @lends cc.game# */{
      */
     prepare: function (cb) {
         var self = this,
-            config = self.config, 
+            config = self.config,
             CONFIG_KEY = self.CONFIG_KEY;
 
         this._loadConfig();
@@ -2228,10 +2228,10 @@ cc.game = /** @lends cc.game# */{
             this._initRenderer(config[CONFIG_KEY.width], config[CONFIG_KEY.height]);
 
             /**
+             * cc.view is the shared view object.
              * @type {cc.EGLView}
              * @name cc.view
              * @memberof cc
-             * cc.view is the shared view object.
              */
             cc.view = cc.EGLView._getInstance();
 
@@ -2244,10 +2244,10 @@ cc.game = /** @lends cc.game# */{
             if (cc.director.setOpenGLView)
                 cc.director.setOpenGLView(cc.view);
             /**
+             * cc.winSize is the alias object for the size of the current game window.
              * @type {cc.Size}
              * @name cc.winSize
              * @memberof cc
-             * cc.winSize is the alias object for the size of the current game window.
              */
             cc.winSize = cc.director.getWinSize();
 
@@ -2300,7 +2300,7 @@ cc.game = /** @lends cc.game# */{
                 cc.game.onStart = onStart;
             }
         }
-        
+
         this.prepare(cc.game.onStart && cc.game.onStart.bind(cc.game));
     },
 
@@ -2377,7 +2377,7 @@ cc.game = /** @lends cc.game# */{
         if (document["ccConfig"]) {
             this._initConfig(document["ccConfig"]);
         }
-        // Load from project.json 
+        // Load from project.json
         else {
             try {
                 var cocos_script = document.getElementsByTagName('script');

cocos2d/actions/CCAction.js

@@ -274,7 +274,7 @@ cc.FiniteTimeAction = cc.Action.extend(/** @lends cc.FiniteTimeAction# */{
      * - The reversed action will be x of 100 move to 0.
      * - Will be rewritten
      *
-     * @return {Null}
+     * @return {?cc.Action}
      */
     reverse:function () {
         cc.log("cocos2d: FiniteTimeAction#reverse: Implement me");

cocos2d/actions/CCActionCamera.js

@@ -100,7 +100,7 @@ cc.ActionCamera = cc.ActionInterval.extend(/** @lends cc.ActionCamera# */{
      * - The action will be x coordinates of 0 move to 100. <br />
      * - The reversed action will be x of 100 move to 0.
      * - Will be rewritten
-     *
+     * @return {?cc.Action}
      */
     reverse:function () {
         return new cc.ReverseTime(this);

cocos2d/actions/CCActionEase.js

@@ -1140,7 +1140,7 @@ cc.EaseElastic = cc.ActionEase.extend(/** @lends cc.EaseElastic# */{
     /**
      * Create a action. Opposite with the original motion trajectory. <br />
      * Will be overwrite.
-     * @return {null}
+     * @return {?cc.Action}
      */
     reverse:function () {
         cc.log("cc.EaseElastic.reverse(): it should be overridden in subclass.");
@@ -3678,4 +3678,3 @@ cc._easeCubicActionInOut = {
 cc.easeCubicActionInOut = function(){
     return cc._easeCubicActionInOut;
 };
-

cocos2d/actions/CCActionInterval.js

@@ -208,7 +208,7 @@ cc.ActionInterval = cc.FiniteTimeAction.extend(/** @lends cc.ActionInterval# */{
      * returns a reversed action. <br />
      * Will be overwrite.
      *
-     * @return {null}
+     * @return {?cc.Action}
      */
     reverse:function () {
         cc.log("cc.IntervalAction: reverse not implemented.");
@@ -1121,6 +1121,7 @@ cc.RotateTo = cc.ActionInterval.extend(/** @lends cc.RotateTo# */{
     /**
      * RotateTo reverse not implemented.
      * Will be overridden.
+     * @returns {cc.Action}
      */
     reverse:function () {
         cc.log("cc.RotateTo.reverse(): it should be overridden in subclass.");

cocos2d/actions3d/CCActionGrid.js

@@ -56,7 +56,7 @@ cc.GridAction = cc.ActionInterval.extend(/** @lends cc.GridAction# */{
      * to copy object with deep copy.
      * returns a clone of action.
      *
-     * @return {cc.Action}
+     * @return {cc.ActionInterval}
      */
     clone:function(){
         var action = new cc.GridAction();

cocos2d/audio/CCAudio.js

@@ -866,7 +866,7 @@ cc.Audio = cc.Class.extend({
 
         /**
          * Pause playing sound effect.
-         * @param {Number} cc.Audio The return value of function playEffect.
+         * @param {Number} audio The return value of function playEffect.
          * @example
          * //example
          * cc.audioEngine.pauseEffect(audioID);
@@ -897,7 +897,7 @@ cc.Audio = cc.Class.extend({
 
         /**
          * Resume playing sound effect.
-         * @param {Number} cc.Audio The return value of function playEffect.
+         * @param {Number} audio The return value of function playEffect.
          * @audioID
          * //example
          * cc.audioEngine.resumeEffect(audioID);
@@ -925,7 +925,7 @@ cc.Audio = cc.Class.extend({
 
         /**
          * Stop playing sound effect.
-         * @param {Number} cc.Audio The return value of function playEffect.
+         * @param {Number} audio The return value of function playEffect.
          * @example
          * //example
          * cc.audioEngine.stopEffect(audioID);

cocos2d/core/CCCamera.js

@@ -43,7 +43,7 @@
  *     - 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. *
  * </p>
  */
-cc.Camera = cc.Class.extend({
+cc.Camera = cc.Class.extend(/** @lends cc.Camera# */{
     _eyeX:null,
     _eyeY:null,
     _eyeZ:null,

cocos2d/core/CCDirector.js

@@ -23,7 +23,7 @@
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.
  ****************************************************************************/
- 
+
 cc.g_NumberOfDraws = 0;
 
 cc.GLToClipTransform = function (transformOut) {
@@ -495,7 +495,7 @@ cc.Director = cc.Class.extend(/** @lends cc.Director# */{
      * set color for clear screen.<br/>
      * Implementation can be found in CCDirectorCanvas.js/CCDirectorWebGL.js
      * @function
-     * @param {cc.color} clearColor
+     * @param {cc.Color} clearColor
      */
     setClearColor: null,
     /**
@@ -933,4 +933,4 @@ cc.Director.PROJECTION_CUSTOM = 3;
  * @constant
  * @type {Number}
  */
-cc.Director.PROJECTION_DEFAULT = cc.Director.PROJECTION_3D;
+cc.Director.PROJECTION_DEFAULT = cc.Director.PROJECTION_3D;

cocos2d/core/platform/CCSAXParser.js

@@ -162,8 +162,9 @@ cc.PlistParser = cc.SAXParser.extend(/** @lends cc.plistParser# */{
 
 cc.saxParser = new cc.SAXParser();
 /**
- * @type {cc.PlistParser}
- * @name cc.plistParser
  * A Plist Parser
+ * @type {cc.PlistParser}
+ * @name plistParser
+ * @memberof cc
  */
 cc.plistParser = new cc.PlistParser();

cocos2d/core/platform/CCTypesWebGL.js

@@ -365,7 +365,7 @@ cc.game.addEventListener(cc.game.EVENT_RENDERER_INITED, function () {
     /**
      * @class cc.V3F_C4B_T2F
      * @param {cc.Vertex3F} vertices
-     * @param { cc.color} colors
+     * @param {cc.Color} colors
      * @param {cc.Tex2F} texCoords
      * @param {Array} arrayBuffer
      * @param {Number} offset
@@ -568,7 +568,7 @@ cc.game.addEventListener(cc.game.EVENT_RENDERER_INITED, function () {
     /**
      * @class cc.V2F_C4B_T2F
      * @param {cc.Vertex2F} vertices
-     * @param {cc.color} colors
+     * @param {cc.Color} colors
      * @param {cc.Tex2F} texCoords
      * @param {Array} arrayBuffer
      * @param {Number} offset

cocos2d/core/sprites/CCSprite.js

@@ -797,7 +797,7 @@ cc.Sprite = cc.Node.extend(/** @lends cc.Sprite# */{
      * @function
      * @param {cc.Sprite} child
      * @param {Number} localZOrder  child's zOrder
-     * @param {String} [tag] child's tag
+     * @param {number|String} [tag] child's tag
      * @override
      */
     addChild: function (child, localZOrder, tag) {
@@ -1027,4 +1027,4 @@ cc.EventHelper.prototype.apply(cc.Sprite.prototype);
 
 cc.assert(cc.isFunction(cc._tmp.PrototypeSprite), cc._LogInfos.MissingFile, "SpritesPropertyDefine.js");
 cc._tmp.PrototypeSprite();
-delete cc._tmp.PrototypeSprite;
+delete cc._tmp.PrototypeSprite;

cocos2d/core/sprites/CCSpriteBatchNode.js

@@ -576,7 +576,7 @@ cc.SpriteBatchNode = cc.Node.extend(/** @lends cc.SpriteBatchNode# */{
      * Removes all children from the container and do a cleanup all running actions depending on the cleanup parameter. <br/>
      * (override removeAllChildren of cc.Node)
      * @function
-     * @param {Boolean} cleanup
+     * @param {Boolean} [cleanup=true]
      */
     removeAllChildren: function (cleanup) {
         // Invalidate atlas index. issue #569
@@ -673,4 +673,4 @@ cc.SpriteBatchNode.create = function (fileImage, capacity) {
  * @see cc.SpriteBatchNode
  * @function
  */
-cc.SpriteBatchNode.createWithTexture = cc.SpriteBatchNode.create;
+cc.SpriteBatchNode.createWithTexture = cc.SpriteBatchNode.create;

cocos2d/core/support/CCPointExtension.js

@@ -86,7 +86,7 @@ cc.pMult = function (point, floatVar) {
  * Calculates midpoint between two points.
  * @param {cc.Point} v1
  * @param {cc.Point} v2
- * @return {cc.pMult}
+ * @return {cc.Point}
  */
 cc.pMidpoint = function (v1, v2) {
     return cc.pMult(cc.pAdd(v1, v2), 0.5);
@@ -134,7 +134,7 @@ cc.pRPerp = function (point) {
  * Calculates the projection of v1 over v2.
  * @param {cc.Point} v1
  * @param {cc.Point} v2
- * @return {cc.pMult}
+ * @return {cc.Point}
  */
 cc.pProject = function (v1, v2) {
     return cc.pMult(v2, cc.pDot(v1, v2) / cc.pDot(v2, v2));
@@ -284,7 +284,7 @@ cc.pCompOp = function (p, opFunc) {
  * @param {cc.Point} a
  * @param {cc.Point} b
  * @param {Number} alpha
- * @return {cc.pAdd}
+ * @return {cc.Point}
  */
 cc.pLerp = function (a, b, alpha) {
     return cc.pAdd(cc.pMult(a, 1 - alpha), cc.pMult(b, alpha));
@@ -498,7 +498,7 @@ cc.pSubIn = function(v1, v2) {
 /**
  * adds one point to another (inplace)
  * @param {cc.Point} v1
- * @param {cc.point} v2
+ * @param {cc.Point} v2
  */
 cc.pAddIn = function(v1, v2) {
     v1.x += v2.x;
@@ -512,4 +512,3 @@ cc.pAddIn = function(v1, v2) {
 cc.pNormalizeIn = function(v) {
     cc.pMultIn(v, 1.0 / Math.sqrt(v.x * v.x + v.y * v.y));
 };
-