updated more docs for Arc, Circle, Ellipse, and Image

src/shapes/Arc.js

@@ -75,10 +75,10 @@
      * @param {Number} outerRadius
      * @returns {Number}
      * @example
-     * // get outer radius
+     * // get outer radius<br>
-     * var outerRadius = arc.outerRadius();
+     * var outerRadius = arc.outerRadius();<br><br>
      *
-     * // set outer radius
+     * // set outer radius<br>
      * arc.outerRadius(20);
      */
 
@@ -92,10 +92,10 @@
      * @param {Number} angle
      * @returns {Number}
      * @example
-     * // get angle
+     * // get angle<br>
-     * var angle = arc.angle();
+     * var angle = arc.angle();<br><br>
      *
-     * // set angle
+     * // set angle<br>
      * arc.angle(20);
      */
 
@@ -109,13 +109,13 @@
      * @param {Number} clockwise
      * @returns {Number}
      * @example
-     * // get clockwise flag
+     * // get clockwise flag<br>
-     * var clockwise = arc.clockwise();
+     * var clockwise = arc.clockwise();<br><br>
      *
-     * // draw arc counter-clockwise
+     * // draw arc counter-clockwise<br>
-     * arc.clockwise(false);
+     * arc.clockwise(false);<br><br>
      *
-     * // draw arc clockwise
+     * // draw arc clockwise<br>
      * arc.clockwise(true);
      */
 })();

src/shapes/Circle.js

@@ -13,22 +13,12 @@
      * @@shapeParams
      * @@nodeParams
      * @example
-     * // create simple circle
+     * // create circle
      * var circle = new Kinetic.Circle({<br>
      *   radius: 40,<br>
      *   fill: 'red',<br>
      *   stroke: 'black'<br>
      *   strokeWidth: 5<br>
-     * });<br><br>
-     *
-     * // create ellipse<br>
-     * var circle = new Kinetic.Circle({<br>
-     *   radius: 5,<br>
-     *   fill: 'red',<br>
-     *   stroke: 'black'<br>
-     *   strokeWidth: 5,<br>
-     *   scaleX: 2,<br>
-     *   strokeScaleEnabled: false<br>
      * });
      */
     Kinetic.Circle = function(config) {
@@ -73,18 +63,17 @@
     Kinetic.Factory.addGetterSetter(Kinetic.Circle, 'radius', 0);
 
     /**
-     * set radius
+     * get/set radius
-     * @name setRadius
+     * @name radius
      * @method
      * @memberof Kinetic.Circle.prototype
      * @param {Number} radius
-     */
-
-    /**
-     * get radius
-     * @name getRadius
-     * @method
-     * @memberof Kinetic.Circle.prototype
      * @returns {Number}
+     * @example
+     * // get radius<br>
+     * var radius = circle.radius();<br><br>
+     *
+     * // set radius<br>
+     * circle.radius(10);<br>
      */
 })();

src/shapes/Ellipse.js

@@ -24,14 +24,16 @@
             this.sceneFunc(this._sceneFunc);
         },
         _sceneFunc: function(context) {
-            var r = this.getRadius();
+            var r = this.getRadius(),
+                rx = r.x,
+                ry = r.y;
 
             context.beginPath();
             context.save();
-            if(r.x !== r.y) {
+            if(rx !== ry) {
-                context.scale(1, r.y / r.x);
+                context.scale(1, ry / rx);
             }
-            context.arc(0, 0, r.x, 0, PIx2, false);
+            context.arc(0, 0, rx, 0, PIx2, false);
             context.restore();
             context.closePath();
             context.fillStrokeShape(this);
@@ -65,52 +67,53 @@
     Kinetic.Factory.addPointGetterSetter(Kinetic.Ellipse, 'radius', 0);
 
     /**
-     * set radius
+     * get/set radius
      * @name setRadius
      * @method
      * @memberof Kinetic.Ellipse.prototype
      * @param {Object} radius
      * @param {Number} radius.x
      * @param {Number} radius.y
-     */
-
-    /**
-     * get radius
-     * @name getRadius
-     * @method
-     * @memberof Kinetic.Ellipse.prototype
      * @returns {Object}
+     * @example
+     * // get radius<br>
+     * var radius = ellipse.radius();<br><br>
+     * 
+     * // set radius<br>
+     * ellipse.radius({<br>
+     *   x: 200,<br>
+     *   y: 100<br>
+     * });
      */
 
     /**
-     * set radius x
+     * get/set radius x
      * @name setRadiusX
      * @method
      * @memberof Kinetic.Ellipse.prototype
      * @param {Number} x
-     */
-
-    /**
-     * get radius x
-     * @name getRadiusX
-     * @method
-     * @memberof Kinetic.Ellipse.prototype
      * @returns {Number}
+     * @example
+     * // get radius x<br>
+     * var radiusX = ellipse.radiusX();<br><br>
+     * 
+     * // set radius x<br>
+     * ellipse.radiusX(200);
      */
 
     /**
-     * set radius y
+     * get/set radius y
      * @name setRadiusY
      * @method
      * @memberof Kinetic.Ellipse.prototype
      * @param {Number} y
+     * @returns {Number}
+     * @example
+     * // get radius y<br>
+     * var radiusY = ellipse.radiusY();<br><br>
+     * 
+     * // set radius y<br>
+     * ellipse.radiusY(200);
      */
 
-    /**
-     * get radius y
-     * @name getRadiusY
-     * @method
-     * @memberof Kinetic.Ellipse.prototype
-     * @returns {Number}
-     */
 })();

src/shapes/Image.js

@@ -110,18 +110,22 @@
 
     Kinetic.Factory.addBoxGetterSetter(Kinetic.Image, 'crop', 0);
     /**
-     * set crop
+     * get/set crop
      * @method
-     * @name setCrop
+     * @name crop
      * @memberof Kinetic.Image.prototype
      * @param {Object} crop 
      * @param {Number} crop.x
      * @param {Number} crop.y
      * @param {Number} crop.width
      * @param {Number} crop.height
+     * @returns {Object}
      * @example
-     * // set crop x, y, width and height<br>
+     * // get crop<br>
-     * image.setCrop({<br>
+     * var crop = image.crop();<br><br>
+     *
+     * // set crop<br>
+     * image.crop({<br>
      *   x: 20,<br>
      *   y: 20,<br>
      *   width: 20,<br>
@@ -129,75 +133,63 @@
      * });
      */
 
-    /**
-     * get crop
-     * @name getCrop
-     * @method
-     * @memberof Kinetic.Image.prototype
-     * @returns {Object}
-     */
-
      /**
-     * set crop x
+     * get/set crop x
      * @method
-     * @name setCropX
+     * @name cropX
      * @memberof Kinetic.Image.prototype
      * @param {Number} x
-     */
-
-    /**
-     * get crop x
-     * @name getCropX
-     * @method
-     * @memberof Kinetic.Image.prototype
      * @returns {Number}
+     * @example
+     * // get crop x<br>
+     * var cropX = image.cropX();<br><br>
+     *
+     * // set crop x<br>
+     * image.cropX(20);
      */
 
      /**
-     * set crop y
+     * get/set crop y
-     * @name setCropY
+     * @name cropY
      * @method
      * @memberof Kinetic.Image.prototype
      * @param {Number} y
-     */
-
-    /**
-     * get crop y
-     * @name getCropY
-     * @method
-     * @memberof Kinetic.Image.prototype
      * @returns {Number}
+     * @example
+     * // get crop y<br>
+     * var cropY = image.cropY();<br><br>
+     *
+     * // set crop y<br>
+     * image.cropY(20);
      */
 
      /**
-     * set cropWidth
+     * get/set crop width
-     * @name setCropWidth
+     * @name cropWidth
      * @method
      * @memberof Kinetic.Image.prototype
      * @param {Number} width
-     */
-
-    /**
-     * get crop width
-     * @name getCropWidth
-     * @method
-     * @memberof Kinetic.Image.prototype
      * @returns {Number}
+     * @example
+     * // get crop width<br>
+     * var cropWidth = image.cropWidth();<br><br>
+     *
+     * // set crop width<br>
+     * image.cropWidth(20);
      */
 
      /**
-     * set cropHeight
+     * get/set crop height
-     * @name setCropHeight
+     * @name cropHeight
      * @method
      * @memberof Kinetic.Image.prototype
      * @param {Number} height
-     */
-
-    /**
-     * get crop height
-     * @name getCropHeight
-     * @method
-     * @memberof Kinetic.Image.prototype
      * @returns {Number}
+     * @example
+     * // get crop height<br>
+     * var cropHeight = image.cropHeight();<br><br>
+     *
+     * // set crop height<br>
+     * image.cropHeight(20);
      */
 })();