scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-07 13:22:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean up various documentations a bit.

Browse source
This commit is contained in:
Jürg Lehni 2013-06-27 18:03:03 -07:00
parent e54995878b
commit e63edba0b5
3 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/basic/Rectangle.js
View file

@ -175,7 +175,6 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
* @type Number * @type Number
*/ */
// DOCS: Why does jsdocs document this function, when there are no comments?
/** /**
* @ignore * @ignore
*/ */

10
src/basic/Size.js
View file

@ -13,21 +13,23 @@
/** /**
* @name Size * @name Size
* *
* @class The Size object is used to describe the size of something, through * @class The Size object is used to describe the size or dimensions of
* its {@link #width} and {@link #height} properties. * somethign, through its {@link #width} and {@link #height} properties.
* *
* @classexample * @classexample
* // Create a size that is 10pt wide and 5pt high * // Create a size that is 10pt wide and 5pt high,
* // and use it to define a rectangle:
* var size = new Size(10, 5); * var size = new Size(10, 5);
* console.log(size.width); // 10 * console.log(size.width); // 10
* console.log(size.height); // 5 * console.log(size.height); // 5
* var rect = new Rectangle(new Point(20, 15), size);
* console.log(rect); // { x: 20, y: 15, width: 10, height: 5 }
*/ */
var Size = Base.extend(/** @lends Size# */{ var Size = Base.extend(/** @lends Size# */{
_class: 'Size', _class: 'Size',
// Tell Base.read that the Point constructor supports reading with index // Tell Base.read that the Point constructor supports reading with index
_readIndex: true, _readIndex: true,
// DOCS: improve Size class description
/** /**
* Creates a Size object with the given width and height values. * Creates a Size object with the given width and height values.
* *

22
src/path/Path.Constructors.js
View file

@ -88,7 +88,7 @@ Path.inject({ statics: new function() {
/** /**
* {@grouptitle Shaped Paths} * {@grouptitle Shaped Paths}
* *
* Creates a Path Item with two anchor points forming a line. * Creates a Path item with two anchor points forming a line.
* *
* @name Path.Line * @name Path.Line
* @param {Point} from the first anchor point of the path * @param {Point} from the first anchor point of the path
@ -116,7 +116,7 @@ Path.inject({ statics: new function() {
}, },
/** /**
* Creates a circle shaped Path Item. * Creates a circle shaped Path item.
* *
* @param {Point} center the center point of the circle * @param {Point} center the center point of the circle
* @param {Number} radius the radius of the circle * @param {Number} radius the radius of the circle
@ -142,7 +142,7 @@ Path.inject({ statics: new function() {
}, },
/** /**
* Creates a rectangle shaped Path Item from the passed point and size. * Creates a rectangle shaped Path item from the passed point and size.
* *
* @name Path.Rectangle * @name Path.Rectangle
* @param {Point} point * @param {Point} point
@ -163,8 +163,8 @@ Path.inject({ statics: new function() {
* }); * });
*/ */
/** /**
* Creates a rectangle shaped Path Item from the passed points. These do not * Creates a rectangle shaped Path item from the passed points. These do
* necessarily need to be the top left and bottom right corners, the * not necessarily need to be the top left and bottom right corners, the
* constructor figures out how to fit a rectangle between them. * constructor figures out how to fit a rectangle between them.
* *
* @name Path.Rectangle * @name Path.Rectangle
@ -186,7 +186,7 @@ Path.inject({ statics: new function() {
* }); * });
*/ */
/** /**
* Creates a rectangle shaped Path Item from the passed abstract * Creates a rectangle shaped Path item from the passed abstract
* {@link Rectangle}. * {@link Rectangle}.
* *
* @name Path.Rectangle * @name Path.Rectangle
@ -213,7 +213,7 @@ Path.inject({ statics: new function() {
* }); * });
*/ */
/** /**
* Creates a rectangular Path Item with rounded corners. * Creates a rectangular Path item with rounded corners.
* *
* @name Path.Rectangle * @name Path.Rectangle
* @param {Rectangle} rectangle * @param {Rectangle} rectangle
@ -247,7 +247,7 @@ Path.inject({ statics: new function() {
RoundRectangle: createRectangle, RoundRectangle: createRectangle,
/** /**
* Creates an ellipse shaped Path Item. * Creates an ellipse shaped Path item.
* *
* @param {Rectangle} rectangle * @param {Rectangle} rectangle
* @param {Boolean} [circumscribed=false] when set to {@code true} the * @param {Boolean} [circumscribed=false] when set to {@code true} the
@ -279,7 +279,7 @@ Path.inject({ statics: new function() {
Oval: createEllipse, Oval: createEllipse,
/** /**
* Creates a circular arc shaped Path Item. * Creates a circular arc shaped Path item.
* *
* @param {Point} from the starting point of the circular arc * @param {Point} from the starting point of the circular arc
* @param {Point} through the point the arc passes through * @param {Point} through the point the arc passes through
@ -312,7 +312,7 @@ Path.inject({ statics: new function() {
}, },
/** /**
* Creates a regular polygon shaped Path Item. * Creates a regular polygon shaped Path item.
* *
* @param {Point} center the center point of the polygon * @param {Point} center the center point of the polygon
* @param {Number} sides the number of sides of the polygon * @param {Number} sides the number of sides of the polygon
@ -354,7 +354,7 @@ Path.inject({ statics: new function() {
}, },
/** /**
* Creates a star shaped Path Item. * Creates a star shaped Path item.
* *
* The largest of {@code radius1} and {@code radius2} will be the outer * The largest of {@code radius1} and {@code radius2} will be the outer
* radius of the star. The smallest of radius1 and radius2 will be the * radius of the star. The smallest of radius1 and radius2 will be the