Merge pull request #3255 from pandamicro/develop

Fix documentation issues

Author: pandamicro

CCBoot.js

@@ -567,8 +567,19 @@ cc.path = /** @lends cc.path# */{
 
 //+++++++++++++++++++++++++something about loader start+++++++++++++++++++++++++++
 /**
- * Loader for resource loading process. It's a singleton object.
+ * Resource loading management. Created by in CCBoot.js as a singleton
+ * cc.loader.
+ * @name cc.Loader
  * @class
+ * @memberof cc
+ * @see cc.loader
+ */
+
+/**
+ * Singleton instance of cc.Loader.
+ * @name cc.loader
+ * @member {cc.Loader}
+ * @memberof cc
  */
 cc.loader = (function () {
     var _jsCache = {}, //cache for js
@@ -607,10 +618,24 @@ cc.loader = (function () {
             "$", "i"
         );
 
-    return /** @lends cc.loader# */{
-        resPath: "",//root path of resource
-        audioPath: "",//root path of audio
-        cache: {},//cache for data loaded
+    return /** @lends cc.Loader# */{
+        /**
+         * Root path of resources.
+         * @type {String}
+         */
+        resPath: "",
+
+        /**
+         * Root path of audio resources
+         * @type {String}
+         */
+        audioPath: "",
+
+        /**
+         * Cache for data loaded.
+         * @type {Object}
+         */
+        cache: {},
 
         /**
          * Get XMLHttpRequest.
@@ -2053,32 +2078,97 @@ cc.initEngine = function (config, cb) {
  * An object to boot the game.
  * @class
  * @name cc.game
+ *
  */
 cc.game = /** @lends cc.game# */{
+    /** 
+     * Debug mode: No debugging. {@static}
+     * @const {Number}
+     * @static
+     */
     DEBUG_MODE_NONE: 0,
+    /**
+     * Debug mode: Info, warning, error to console.
+     * @const {Number}
+     * @static
+     */
     DEBUG_MODE_INFO: 1,
+    /**
+     * Debug mode: Warning, error to console.
+     * @const {Number}
+     * @static
+     */
     DEBUG_MODE_WARN: 2,
+    /**
+     * Debug mode: Error to console.
+     * @const {Number}
+     * @static
+     */
     DEBUG_MODE_ERROR: 3,
+    /**
+     * Debug mode: Info, warning, error to web page.
+     * @const {Number}
+     * @static
+     */
     DEBUG_MODE_INFO_FOR_WEB_PAGE: 4,
+    /**
+     * Debug mode: Warning, error to web page.
+     * @const {Number}
+     * @static
+     */
     DEBUG_MODE_WARN_FOR_WEB_PAGE: 5,
+    /**
+     * Debug mode: Error to web page.
+     * @const {Number}
+     * @static
+     */
     DEBUG_MODE_ERROR_FOR_WEB_PAGE: 6,
 
+    /**
+     * Event that is fired when the game is hidden.
+     * @constant {String}
+     */
     EVENT_HIDE: "game_on_hide",
+    /**
+     * Event that is fired when the game is shown.
+     * @constant {String}
+     */
     EVENT_SHOW: "game_on_show",
+    /**
+     * Event that is fired when the game is resized.
+     * @constant {String}
+     */
     EVENT_RESIZE: "game_on_resize",
+    /**
+     * Event that is fired when the renderer is done being initialized.
+     * @constant {String}
+     */
     EVENT_RENDERER_INITED: "renderer_inited",
 
+    /** @constant {Number} */
     RENDER_TYPE_CANVAS: 0,
+    /** @constant {Number} */
     RENDER_TYPE_WEBGL: 1,
+    /** @constant {Number} */
     RENDER_TYPE_OPENGL: 2,
 
     _eventHide: null,
     _eventShow: null,
 
     /**
-     * Key of config
+     * Keys found in project.json.
+     *
      * @constant
      * @type {Object}
+     *
+     * @prop {String} engineDir     - In debug mode, if you use the whole engine to develop your game, you should specify its relative path with "engineDir".
+     * @prop {String} modules       - Defines which modules you will need in your game, it's useful only on web
+     * @prop {String} debugMode     - Debug mode, see DEBUG_MODE_XXX constant definitions.
+     * @prop {String} showFPS       - Left bottom corner fps information will show when "showFPS" equals true, otherwise it will be hide.
+     * @prop {String} frameRate     - Sets the wanted frame rate for your game, but the real fps depends on your game implementation and the running environment.
+     * @prop {String} id            - Sets the id of your canvas element on the web page, it's useful only on web.
+     * @prop {String} renderMode    - Sets the renderer type, only useful on web, 0: Automatic, 1: Canvas, 2: WebGL
+     * @prop {String} jsList        - Sets the list of js files in your game.
      */
     CONFIG_KEY: {
         width: "width",
@@ -2092,17 +2182,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,
 
@@ -2130,13 +2220,13 @@ cc.game = /** @lends cc.game# */{
 
     /**
      * Callback when the scripts of engine have been load.
-     * @type {Function}
+     * @type {Function|null}
      */
     onStart: null,
 
     /**
      * Callback when game exits.
-     * @type {Function}
+     * @type {Function|null}
      */
     onStop: null,
 
@@ -2215,7 +2305,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();
@@ -2236,10 +2326,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();
 
@@ -2252,10 +2342,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();
 
@@ -2308,7 +2398,7 @@ cc.game = /** @lends cc.game# */{
                 cc.game.onStart = onStart;
             }
         }
-        
+
         this.prepare(cc.game.onStart && cc.game.onStart.bind(cc.game));
     },
 
@@ -2385,7 +2475,7 @@ cc.game = /** @lends cc.game# */{
         if (document["ccConfig"]) {
             this._initConfig(document["ccConfig"]);
         }
-        // Load from project.json 
+        // Load from project.json
         else {
             var data = {};
             try {

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

@@ -898,7 +898,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);
@@ -929,7 +929,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);
@@ -957,7 +957,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/cocoa/CCGeometry.js

@@ -29,6 +29,9 @@
  * @class cc.Point
  * @param {Number} x
  * @param {Number} y
+ *
+ * @property x {Number}
+ * @property y {Number}
  * @see cc.p
  */
 cc.Point = function (x, y) {
@@ -79,6 +82,8 @@ cc.pointEqualToPoint = function (point1, point2) {
  * @class cc.Size
  * @param {Number} width
  * @param {Number} height
+ * @property {Number} width
+ * @property {Number} height
  * @see cc.size
  */
 cc.Size = function (width, height) {
@@ -127,8 +132,16 @@ cc.sizeEqualToSize = function (size1, size2) {
 /**
  * cc.Rect is the class for rect object, please do not use its constructor to create rects, use cc.rect() alias function instead.
  * @class cc.Rect
+ * @param {Number} x
+ * @param {Number} y
  * @param {Number} width
  * @param {Number} height
+ *
+ * @property {Number} x
+ * @property {Number} y
+ * @property {Number} width
+ * @property {Number} height
+ *
  * @see cc.rect
  */
 cc.Rect = function (x, y, width, height) {
@@ -323,5 +336,3 @@ cc.rectIntersection = function (rectA, rectB) {
     intersection.height = Math.min(cc.rectGetMaxY(rectA), cc.rectGetMaxY(rectB)) - cc.rectGetMinY(intersection);
     return intersection;
 };
-
-