From 2e97e20436436a25d057dfca40d251a441931ba0 Mon Sep 17 00:00:00 2001 From: Eric Rowell Date: Sun, 5 Jan 2014 20:52:09 -0800 Subject: [PATCH] updated more overloaded docs --- src/Container.js | 105 ++++++++++++++++++++++------------------------- src/Layer.js | 47 ++++++++++----------- src/Stage.js | 7 +++- 3 files changed, 78 insertions(+), 81 deletions(-) diff --git a/src/Container.js b/src/Container.js index 55902f05..2550202e 100644 --- a/src/Container.js +++ b/src/Container.js @@ -307,16 +307,23 @@ // add getters setters Kinetic.Factory.addBoxGetterSetter(Kinetic.Container, 'clip'); - /** - * set clip + * get/set clip * @method - * @name setClip + * @name clip * @memberof Kinetic.Container.prototype - * @param {Object} clip {x:x, y:y, width:width, height:height} + * @param {Object} clip + * @param {Number} clip.x + * @param {Number} clip.y + * @param {Number} clip.width + * @param {Number} clip.height + * @returns {Object} * @example - * // set clip x, y, width and height
- * image.setClip({
+ * // get clip
+ * var clip = container.clip();

+ * + * // set clip
+ * container.setClip({
* x: 20,
* y: 20,
* width: 20,
@@ -325,78 +332,62 @@ */ /** - * get clip - * @name getClip + * get/set clip x + * @name clipX * @method * @memberof Kinetic.Container.prototype - * @returns {Object} - */ - - Kinetic.Factory.addGetterSetter(Kinetic.Container, 'clipX', 0); - /** - * set clip x - * @method - * @name setClipX - * @memberof Kinetic.Container.prototype * @param {Number} x + * @returns {Number} + * @example + * // get clip x
+ * var clipX = container.clipX();

+ * + * // set clip x
+ * container.clipX(10); */ /** - * get clip x - * @name getClipX - * @method - * @memberof Kinetic.Container.prototype - * @returns {Number} - */ - - Kinetic.Factory.addGetterSetter(Kinetic.Container, 'clipY', 0); - /** - * set clip y - * @name setClipY + * get/set clip y + * @name clipY * @method * @memberof Kinetic.Container.prototype * @param {Number} y + * @returns {Number} + * @example + * // get clip y
+ * var clipY = container.clipY();

+ * + * // set clip y
+ * container.clipY(10); */ /** - * get clip y - * @name getClipY - * @method - * @memberof Kinetic.Container.prototype - * @returns {Number} - */ - - Kinetic.Factory.addGetterSetter(Kinetic.Container, 'clipWidth', 0); - /** - * set clip width - * @name setClipWidth + * get/set clip width + * @name clipWidth * @method * @memberof Kinetic.Container.prototype * @param {Number} width + * @returns {Number} + * @example + * // get clip width
+ * var clipWidth = container.clipWidth();

+ * + * // set clip width
+ * container.clipWidth(100); */ /** - * get clip width - * @name getClipWidth - * @method - * @memberof Kinetic.Container.prototype - * @returns {Number} - */ - - Kinetic.Factory.addGetterSetter(Kinetic.Container, 'clipHeight', 0); - /** - * set clip height - * @name setClipHeight + * get/set clip height + * @name clipHeight * @method * @memberof Kinetic.Container.prototype * @param {Number} height - */ - - /** - * get clip height - * @name getClipHeight - * @method - * @memberof Kinetic.Container.prototype * @returns {Number} + * @example + * // get clip height
+ * var clipHeight = container.clipHeight();

+ * + * // set clip height
+ * container.clipHeight(100); */ })(); diff --git a/src/Layer.js b/src/Layer.js index 623a2e8d..dd6be4d4 100644 --- a/src/Layer.js +++ b/src/Layer.js @@ -293,43 +293,44 @@ // add getters and setters Kinetic.Factory.addGetterSetter(Kinetic.Layer, 'clearBeforeDraw', true); - /** - * set flag which determines if the layer is cleared or not + * get/set clearBeforeDraw flag which determines if the layer is cleared or not * before drawing - * @name setClearBeforeDraw + * @name clearBeforeDraw * @method * @memberof Kinetic.Layer.prototype * @param {Boolean} clearBeforeDraw - * @returns {Node} - */ - - /** - * get flag which determines if the layer is cleared or not - * before drawing - * @name getClearBeforeDraw - * @method - * @memberof Kinetic.Layer.prototype * @returns {Boolean} + * @example + * // get clearBeforeDraw flag
+ * var clearBeforeDraw = layer.clearBeforeDraw();

+ * + * // disable clear before draw
+ * layer.clearBeforeDraw(false);

+ * + * // enable clear before draw
+ * layer.clearBeforeDraw(true); */ Kinetic.Factory.addGetterSetter(Kinetic.Layer, 'hitGraphEnabled', true); - /** - * enable/disable hit graph - * @name setHitGraphEnabled + * get/set hitGraphEnabled flag. Disabling the hit graph will greatly increase + * draw performance because the hit graph will not be redrawn each time the layer is + * drawn. This, however, also disables mouse/touch event detection + * @name hitGraphEnabled * @method * @memberof Kinetic.Layer.prototype * @param {Boolean} enabled - * @returns {Node} - */ - - /** - * determine if hit graph is enabled - * @name getHitGraphEnabled - * @method - * @memberof Kinetic.Layer.prototype * @returns {Boolean} + * @example + * // get hitGraphEnabled flag
+ * var hitGraphEnabled = layer.hitGraphEnabled();

+ * + * // disable hit graph
+ * layer.hitGraphEnabled(false);

+ * + * // enable hit graph
+ * layer.hitGraphEnabled(true); */ Kinetic.Layer.prototype.isHitGraphEnabled = Kinetic.Layer.prototype.getHitGraphEnabled; diff --git a/src/Stage.js b/src/Stage.js index 502eebe3..b6fbb582 100644 --- a/src/Stage.js +++ b/src/Stage.js @@ -649,12 +649,17 @@ // add getters and setters Kinetic.Factory.addGetter(Kinetic.Stage, 'container'); + Kinetic.Factory.addOverloadedGetterSetter(Kinetic.Stage, 'container'); /** * get container DOM element - * @name getContainer + * @name container * @method * @memberof Kinetic.Stage.prototype + * @returns {DomElement} container + * @example + * // get container
+ * var container = stage.container(); */ })();