updated class config param doc include replacements with grunt

This commit is contained in:
Eric Rowell
2013-06-01 10:27:44 -07:00
parent 489b7825c3
commit 5d1a78589a
21 changed files with 128 additions and 43 deletions

View File

@@ -45,7 +45,7 @@ var Kinetic = {};
* @memberof Kinetic
* @abstract
* @param {Object} config
* {{NodeParams}}
* @@nodeParams
*/
Kinetic.Node = function(config) {
this._nodeInit(config);
@@ -58,8 +58,8 @@ var Kinetic = {};
* @memberof Kinetic
* @augments Kinetic.Node
* @param {Object} config
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var customShape = new Kinetic.Shape({<br>
* x: 5,<br>
@@ -88,8 +88,8 @@ var Kinetic = {};
* @augments Kinetic.Node
* @abstract
* @param {Object} config
* {{NodeParams}}
* {{ContainerParams}}
* @@nodeParams
* @@containerParams
*/
Kinetic.Container = function(config) {
this._containerInit(config);
@@ -102,8 +102,8 @@ var Kinetic = {};
* @augments Kinetic.Container
* @param {Object} config
* @param {String|DomElement} config.container Container id or DOM element
* {{NodeParams}}
* {{ContainerParams}}
* @@nodeParams
* @@containerParams
* @example
* var stage = new Kinetic.Stage({<br>
* width: 500,<br>
@@ -124,8 +124,8 @@ var Kinetic = {};
* @param {Object} config
* @param {Boolean} [config.clearBeforeDraw] set this property to false if you don't want
* to clear the canvas before each layer draw. The default value is true.
* {{NodeParams}}
* {{ContainerParams}}
* @@nodeParams
* @@containerParams
* @example
* var layer = new Kinetic.Layer();
*/
@@ -139,8 +139,8 @@ var Kinetic = {};
* @memberof Kinetic
* @augments Kinetic.Container
* @param {Object} config
* {{NodeParams}}
* {{ContainerParams}}
* @@nodeParams
* @@containerParams
* @example
* var group = new Kinetic.Group();
*/

View File

@@ -31,7 +31,7 @@
* @param {Number} [config.tag.pointerWidth]
* @param {Number} [config.tag.pointerHeight]
* @param {Number} [config.tag.cornerRadius]
* {{NodeParams}}
* @@nodeParams
* @example
* // create label
* var label = new Kinetic.Label({<br>

View File

@@ -7,8 +7,8 @@
* @augments Kinetic.Shape
* @param {Object} config
* @param {String} config.data SVG data string
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var path = new Kinetic.Path({<br>
* x: 240,<br>

View File

@@ -7,8 +7,8 @@
* @param {Object} config
* @param {Number} config.sides
* @param {Number} config.radius
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var hexagon = new Kinetic.RegularPolygon({<br>
* x: 100,<br>

View File

@@ -8,8 +8,8 @@
* @param {Integer} config.numPoints
* @param {Number} config.innerRadius
* @param {Number} config.outerRadius
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var star = new Kinetic.Star({<br>
* x: 100,<br>

View File

@@ -15,8 +15,8 @@
* @param {String} [config.fontStyle] can be normal, bold, or italic. Default is normal
* @param {String} config.text
* @param {String} config.data SVG data string
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var textpath = new Kinetic.TextPath({<br>
* x: 100,<br>

View File

@@ -9,8 +9,8 @@
* @param {Array} config.points can be a flattened array of points, an array of point arrays, or an array of point objects.
* e.g. [0,1,2,3], [[0,1],[2,3]] and [{x:0,y:1},{x:2,y:3}] are equivalent
* @param {Number} [config.tension] default value is 1. Higher values will result in a more curvy line. A value of 0 will result in no interpolation.
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var blob = new Kinetic.Blob({<br>
* points: [73, 140, 340, 23, 500, 109, 300, 170],<br>

View File

@@ -6,8 +6,8 @@
* @augments Kinetic.Shape
* @param {Object} config
* @param {Number} config.radius
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* // create simple circle
* var circle = new Kinetic.Circle({<br>

View File

@@ -12,8 +12,8 @@
* @param {Object} config
* @param {ImageObject} config.image
* @param {Object} [config.crop]
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var imageObj = new Image();<br>
* imageObj.onload = function() {<br>

View File

@@ -7,8 +7,8 @@
* @param {Object} config
* @param {Array} config.points can be a flattened array of points, an array of point arrays, or an array of point objects.
* e.g. [0,1,2,3], [[0,1],[2,3]] and [{x:0,y:1},{x:2,y:3}] are equivalent
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* // simple line
* var line = new Kinetic.Line({<br>

View File

@@ -7,8 +7,8 @@
* @param {Object} config
* @param {Array} config.points can be a flattened array of points, an array of point arrays, or an array of point objects.
* e.g. [0,1,2,3], [[0,1],[2,3]] and [{x:0,y:1},{x:2,y:3}] are equivalent
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var polygon = new Kinetic.Polygon({<br>
* points: [73, 192, 73, 160, 340, 23, 500, 109, 499, 139, 342, 93],<br>

View File

@@ -6,8 +6,8 @@
* @augments Kinetic.Shape
* @param {Object} config
* @param {Number} [config.cornerRadius]
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var rect = new Kinetic.Rect({<br>
* width: 100,<br>

View File

@@ -9,8 +9,8 @@
* @param {Array} config.points can be a flattened array of points, an array of point arrays, or an array of point objects.
* e.g. [0,1,2,3], [[0,1],[2,3]] and [{x:0,y:1},{x:2,y:3}] are equivalent
* @param {Number} [config.tension] default value is 1. Higher values will result in a more curvy line. A value of 0 will result in no interpolation.
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var spline = new Kinetic.Spline({<br>
* x: 100,<br>

View File

@@ -9,8 +9,8 @@
* @param {Object} config.animations animation map
* @param {Integer} [config.index] animation index
* @param {Image} config.image image object
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var animations = {<br>
* idle: [{<br>

View File

@@ -43,8 +43,8 @@
* @param {Number} [config.height] default is auto
* @param {Number} [config.lineHeight] default is 1
* @param {String} [config.wrap] can be word, char, or none. Default is word
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* var text = new Kinetic.Text({<br>
* x: stage.getWidth() / 2,<br>

View File

@@ -8,8 +8,8 @@
* @param {Number} config.angleDeg angle in degrees
* @param {Number} config.radius
* @param {Boolean} [config.clockwise]
* {{ShapeParams}}
* {{NodeParams}}
* @@shapeParams
* @@nodeParams
* @example
* // draw a wedge that's pointing downwards<br>
* var wedge = new Kinetic.Wedge({<br>