mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-20 22:39:50 -05:00
Docs: Use classexample tags in Point, Size and Rectangle.
This commit is contained in:
parent
12179ac35c
commit
10de921a83
3 changed files with 4 additions and 10 deletions
|
@ -37,13 +37,11 @@ var Point = this.Point = Base.extend({
|
|||
* of the Paper.js project. It is also used to represent two dimensional
|
||||
* vector objects.
|
||||
*
|
||||
* Example:
|
||||
* <pre>
|
||||
* @classexample
|
||||
* // Create a point at x: 10, y: 5
|
||||
* var point = new Point(10, 5);
|
||||
* console.log(point.x); // 10
|
||||
* console.log(point.y); // 5
|
||||
* </pre>
|
||||
*/
|
||||
/**
|
||||
* Creates a Point object using the numbers in the given array as
|
||||
|
|
|
@ -35,13 +35,11 @@ var Size = this.Size = Base.extend({
|
|||
* @class The Size object is used to describe the size of something, through
|
||||
* its {@link #width} and {@link #height} properties.
|
||||
*
|
||||
* Example:
|
||||
* <pre>
|
||||
* @classexample
|
||||
* // Create a size that is 10pt wide and 5pt high
|
||||
* var size = new Size(10, 5);
|
||||
* console.log(size.width); // 10
|
||||
* console.log(size.height); // 5
|
||||
* </pre>
|
||||
*/
|
||||
/**
|
||||
* Creates a Size object using the numbers in the given array as
|
||||
|
|
|
@ -55,17 +55,15 @@ var PathStyle = this.PathStyle = Base.extend(new function() {
|
|||
* {@link Item#style}. This is a convenient way to define a style once and
|
||||
* apply it to a series of items:
|
||||
*
|
||||
* Example:
|
||||
* <pre>
|
||||
* @classexample {@paperscript}
|
||||
* var circleStyle = {
|
||||
* fillColor: new RGBColor(1, 0, 0),
|
||||
* strokeColor: 'black',
|
||||
* strokeWidth: 5
|
||||
* };
|
||||
*
|
||||
* var path = new Path.Circle(new Point(50, 50), 30);
|
||||
* var path = new Path.Circle(new Point(80, 50), 30);
|
||||
* path.style = circleStyle;
|
||||
* </pre>
|
||||
*/
|
||||
initialize: function(style) {
|
||||
// If the passed style object is a PathStyle, clone its clonable
|
||||
|
|
Loading…
Reference in a new issue