Merge pull request #739 from lavrton/docImprove

Doc improve

src/Container.js

@@ -16,6 +16,7 @@
          * determine if node has children
          * @method
          * @memberof Kinetic.Container.prototype
+         * @returns {Boolean}
          */
         hasChildren: function() {
             return this.getChildren().length > 0;
@@ -56,6 +57,7 @@
          * @method
          * @memberof Kinetic.Container.prototype
          * @param {Node} child
+         * @returns {Container}
          */
         add: function(child) {
             var children = this.children;
@@ -86,6 +88,7 @@
          * @method
          * @memberof Kinetic.Container.prototype
          * @param {String} selector
+         * @returns {Collection}
          * @example
          * // select node with id foo<br>
          * var node = stage.find('#foo');<br><br>

src/Layer.js

@@ -130,7 +130,7 @@
         /**
          * get layer canvas
          * @method
-         * @memberof Kinetic.Node.prototype
+         * @memberof Kinetic.Layer.prototype
          */
         getCanvas: function() {
             return this.canvas;
@@ -138,7 +138,7 @@
         /**
          * get layer hit canvas
          * @method
-         * @memberof Kinetic.Node.prototype
+         * @memberof Kinetic.Layer.prototype
          */
         getHitCanvas: function() {
             return this.hitCanvas;
@@ -146,7 +146,7 @@
         /**
          * get layer canvas context
          * @method
-         * @memberof Kinetic.Node.prototype
+         * @memberof Kinetic.Layer.prototype
          */
         getContext: function() {
             return this.getCanvas().getContext();

src/Node.js

@@ -1032,8 +1032,8 @@
          * @method
          * @memberof Kinetic.Node.prototype
          * @param {String} eventType event type.  can be a regular event, like click, mouseover, or mouseout, or it can be a custom event, like myCustomEvent
-         * @param {EventObject} evt event object
-         * @param {Boolean} bubble setting the value to false, or leaving it undefined, will result in the event
+         * @param {EventObject} [evt] event object
+         * @param {Boolean} [bubble] setting the value to false, or leaving it undefined, will result in the event
          *  not bubbling.  Setting the value to true will result in the event bubbling.
          * @returns {Kinetic.Node}
          * @example
@@ -1183,7 +1183,6 @@
          * @method
          * @memberof Kinetic.Node.prototype
          * @param {Object} config
-         * @param {Function} config.callback function executed when the composite has completed
          * @param {String} [config.mimeType] can be "image/png" or "image/jpeg".
          *  "image/png" is the default
          * @param {Number} [config.x] x position of canvas section
@@ -1238,7 +1237,6 @@
          * @param {Number} [config.quality] jpeg quality.  If using an "image/jpeg" mimeType,
          *  you can specify the quality from 0 to 1, where 0 is very poor quality and 1
          *  is very high quality
-         * @returns {Image}
          * @example
          * var image = node.toImage({<br>
          *   callback: function(img) {<br>

src/Stage.js

@@ -157,6 +157,7 @@
          * get pointer position which can be a touch position or mouse position
          * @method
          * @memberof Kinetic.Stage.prototype
+         * @returns {Object}
          */
         getPointerPosition: function() {
             return this.pointerPos;

src/Tween.js

@@ -174,6 +174,7 @@
          * play
          * @method
          * @memberof Kinetic.Tween.prototype
+         * @returns {Tween}
          */
         play: function() {
             this.tween.play();
@@ -183,6 +184,7 @@
          * reverse
          * @method
          * @memberof Kinetic.Tween.prototype
+         * @returns {Tween}
          */
         reverse: function() {
             this.tween.reverse();
@@ -192,6 +194,7 @@
          * reset
          * @method
          * @memberof Kinetic.Tween.prototype
+         * @returns {Tween}
          */
         reset: function() {
             var node = this.node;
@@ -204,6 +207,7 @@
          * @method
          * @memberof Kinetic.Tween.prototype
          * @param {Integer} t time in seconds between 0 and the duration
+         * @returns {Tween}
          */
         seek: function(t) {
             var node = this.node;
@@ -215,6 +219,7 @@
          * pause
          * @method
          * @memberof Kinetic.Tween.prototype
+         * @returns {Tween}
          */
         pause: function() {
             this.tween.pause();
@@ -224,6 +229,7 @@
          * finish
          * @method
          * @memberof Kinetic.Tween.prototype
+         * @returns {Tween}
          */
         finish: function() {
             var node = this.node;

src/shapes/Ellipse.js

@@ -68,7 +68,7 @@
 
     /**
      * get/set radius
-     * @name setRadius
+     * @name radius
      * @method
      * @memberof Kinetic.Ellipse.prototype
      * @param {Object} radius
@@ -89,7 +89,7 @@
     Kinetic.Factory.addGetterSetter(Kinetic.Ellipse, 'radiusX', 0);
     /**
      * get/set radius x
-     * @name setRadiusX
+     * @name radiusX
      * @method
      * @memberof Kinetic.Ellipse.prototype
      * @param {Number} x
@@ -105,7 +105,7 @@
     Kinetic.Factory.addGetterSetter(Kinetic.Ellipse, 'radiusY', 0);
     /**
      * get/set radius y
-     * @name setRadiusY
+     * @name radiusY
      * @method
      * @memberof Kinetic.Ellipse.prototype
      * @param {Number} y

src/shapes/Ring.js

@@ -7,7 +7,6 @@
      * @constructor
      * @augments Kinetic.Shape
      * @param {Object} config
-     * @param {Number} config.angle in degrees
      * @param {Number} config.innerRadius
      * @param {Number} config.outerRadius
      * @param {Boolean} [config.clockwise]