Update the comments for API doc.

This commit is contained in:
zhangbin
2016-02-24 10:49:22 +08:00
parent 16cb7e014b
commit a4d9eebe26
2 changed files with 46 additions and 17 deletions
+29
View File
@@ -1,3 +1,32 @@
/****************************************************************************
Copyright (c) 2016 Chukong Technologies Inc.
http://www.cocos2d-x.org
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
/**
* Render the TMX layer.
* @class TiledLayer
* @extends _ComponentInSG
*/
var TiledLayer = cc.Class({
name: 'cc.TiledLayer',
extends: require('./../core/components/CCComponentInSG'),
+17 -17
View File
@@ -25,7 +25,7 @@
/**
* Renders a TMX Tile Map in the scene.
* @class TiledMap
* @extends _ComponentInSG
* @extends Component
*/
var TiledMap = cc.Class({
name: 'cc.TiledMap',
@@ -44,7 +44,7 @@ var TiledMap = cc.Class({
/**
* The tmx file.
* @property {string} file
* @property {string} tmxFile
* @default ""
*/
_tmxFile: {
@@ -85,10 +85,10 @@ var TiledMap = cc.Class({
/**
* Set the map size.
* @method setMapSize
* @param {cc.Size} Var
* @param {cc.Size} mapSize
*/
setMapSize:function (Var) {
this._tiledMap.setMapSize(Var);
setMapSize:function (mapSize) {
this._tiledMap.setMapSize(mapSize);
},
/**
@@ -103,10 +103,10 @@ var TiledMap = cc.Class({
/**
* Set the tile size
* @method setTileSize
* @param {cc.Size} Var
* @param {cc.Size} tileSize
*/
setTileSize:function (Var) {
this._tiledMap.setTileSize(Var);
setTileSize:function (tileSize) {
this._tiledMap.setTileSize(tileSize);
},
/**
@@ -121,10 +121,10 @@ var TiledMap = cc.Class({
/**
* map orientation
* @method setMapOrientation
* @param {Number} Var
* @param {Number} orientation
*/
setMapOrientation:function (Var) {
this._tiledMap.setMapOrientation(Var);
setMapOrientation:function (orientation) {
this._tiledMap.setMapOrientation(orientation);
},
/**
@@ -139,10 +139,10 @@ var TiledMap = cc.Class({
/**
* object groups
* @method setObjectGroups
* @param {Array} Var
* @param {Array} groups
*/
setObjectGroups:function (Var) {
this._tiledMap.setObjectGroups(Var);
setObjectGroups:function (groups) {
this._tiledMap.setObjectGroups(groups);
},
/**
@@ -157,10 +157,10 @@ var TiledMap = cc.Class({
/**
* Set the map properties
* @method setProperties
* @param {object} Var
* @param {object} properties
*/
setProperties:function (Var) {
this._tiledMap.setProperties(Var);
setProperties:function (properties) {
this._tiledMap.setProperties(properties);
},
/**