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

Documentation: capitalize 'string' and 'number' types.

Browse source
This commit is contained in:
Jonathan Puckey 2011-05-27 20:15:15 +02:00
parent 82bc6fc796
commit 8e84c79aa6
18 changed files with 53 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/basic/Point.js
View file

@ -73,14 +73,14 @@ var Point = this.Point = Base.extend({
* The x coordinate of the point * The x coordinate of the point
* *
* @name Point#x * @name Point#x
* @type number * @type Number
*/ */
/** /**
* The y coordinate of the point * The y coordinate of the point
* *
* @name Point#y * @name Point#y
* @type number * @type Number
*/ */
set: function(x, y) { set: function(x, y) {
@ -327,7 +327,7 @@ var Point = this.Point = Base.extend({
* ({@code x = 0}, {@code y = 0}) to the point's location. * ({@code x = 0}, {@code y = 0}) to the point's location.
* Setting the length changes the location but keeps the vector's angle. * Setting the length changes the location but keeps the vector's angle.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getLength: function() { getLength: function() {
@ -389,7 +389,7 @@ var Point = this.Point = Base.extend({
* The angle is unsigned, no information about rotational direction is * The angle is unsigned, no information about rotational direction is
* given. * given.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getAngle: function(/* point */) { getAngle: function(/* point */) {
@ -426,7 +426,7 @@ var Point = this.Point = Base.extend({
* The angle is unsigned, no information about rotational direction is * The angle is unsigned, no information about rotational direction is
* given. * given.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getAngleInRadians: function(/* point */) { getAngleInRadians: function(/* point */) {

20
src/basic/Rectangle.js
View file

@ -79,28 +79,28 @@ var Rectangle = this.Rectangle = Base.extend({
* The x position of the rectangle. * The x position of the rectangle.
* *
* @name Rectangle#x * @name Rectangle#x
* @type number * @type Number
*/ */
/** /**
* The y position of the rectangle. * The y position of the rectangle.
* *
* @name Rectangle#y * @name Rectangle#y
* @type number * @type Number
*/ */
/** /**
* The width of the rectangle. * The width of the rectangle.
* *
* @name Rectangle#width * @name Rectangle#width
* @type number * @type Number
*/ */
/** /**
* The height of the rectangle. * The height of the rectangle.
* *
* @name Rectangle#height * @name Rectangle#height
* @type number * @type Number
*/ */
// DOCS: why does jsdocs document this function, when there are no comments? // DOCS: why does jsdocs document this function, when there are no comments?
@ -155,7 +155,7 @@ var Rectangle = this.Rectangle = Base.extend({
* The position of the left hand side of the rectangle. Note that this * The position of the left hand side of the rectangle. Note that this
* doesn't move the whole rectangle; the right hand side stays where it was. * doesn't move the whole rectangle; the right hand side stays where it was.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getLeft: function() { getLeft: function() {
@ -172,7 +172,7 @@ var Rectangle = this.Rectangle = Base.extend({
* The top coordinate of the rectangle. Note that this doesn't move the * The top coordinate of the rectangle. Note that this doesn't move the
* whole rectangle: the bottom won't move. * whole rectangle: the bottom won't move.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getTop: function() { getTop: function() {
@ -189,7 +189,7 @@ var Rectangle = this.Rectangle = Base.extend({
* The position of the right hand side of the rectangle. Note that this * The position of the right hand side of the rectangle. Note that this
* doesn't move the whole rectangle; the left hand side stays where it was. * doesn't move the whole rectangle; the left hand side stays where it was.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getRight: function() { getRight: function() {
@ -205,7 +205,7 @@ var Rectangle = this.Rectangle = Base.extend({
* The bottom coordinate of the rectangle. Note that this doesn't move the * The bottom coordinate of the rectangle. Note that this doesn't move the
* whole rectangle: the top won't move. * whole rectangle: the top won't move.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getBottom: function() { getBottom: function() {
@ -220,7 +220,7 @@ var Rectangle = this.Rectangle = Base.extend({
/** /**
* The center-x coordinate of the rectangle. * The center-x coordinate of the rectangle.
* *
* @type number * @type Number
* @bean * @bean
* @ignore * @ignore
*/ */
@ -236,7 +236,7 @@ var Rectangle = this.Rectangle = Base.extend({
/** /**
* The center-y coordinate of the rectangle. * The center-y coordinate of the rectangle.
* *
* @type number * @type Number
* @bean * @bean
* @ignore * @ignore
*/ */

4
src/basic/Size.js
View file

@ -75,14 +75,14 @@ var Size = this.Size = Base.extend({
* The width of the size * The width of the size
* *
* @name Size#width * @name Size#width
* @type number * @type Number
*/ */
/** /**
* The height of the size * The height of the size
* *
* @name Size#height * @name Size#height
* @type number * @type Number
*/ */
set: function(width, height) { set: function(width, height) {

2
src/color/GradientStop.js
View file

@ -56,7 +56,7 @@ var GradientStop = this.GradientStop = Base.extend({
/** /**
* The ramp-point of the gradient stop as a value between 0 and 1. * The ramp-point of the gradient stop as a value between 0 and 1.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getRampPoint: function() { getRampPoint: function() {

18
src/item/Item.js
View file

@ -51,7 +51,7 @@ var Item = this.Item = Base.extend({
/** /**
* The unique id of the item. * The unique id of the item.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getId: function() { getId: function() {
@ -69,7 +69,7 @@ var Item = this.Item = Base.extend({
* path.name = 'example'; * path.name = 'example';
* project.activeLayer.children['example'].remove(); * project.activeLayer.children['example'].remove();
* *
* @type string * @type String
* @bean * @bean
*/ */
getName: function() { getName: function() {
@ -283,7 +283,7 @@ var Item = this.Item = Base.extend({
* // Change the opacity of the circle to 50%: * // Change the opacity of the circle to 50%:
* circle.opacity = 0.5; * circle.opacity = 0.5;
* *
* @type number * @type Number
* @default 1 * @default 1
*/ */
opacity: 1, opacity: 1,
@ -412,7 +412,7 @@ var Item = this.Item = Base.extend({
/** /**
* The index of this item within the list of its parent's children. * The index of this item within the list of its parent's children.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getIndex: function() { getIndex: function() {
@ -803,7 +803,7 @@ var Item = this.Item = Base.extend({
* *
* @property * @property
* @name Item#strokeWidth * @name Item#strokeWidth
* @type number * @type Number
*/ */
// DOCS: Item#strokeCap: describe the different options // DOCS: Item#strokeCap: describe the different options
@ -819,7 +819,7 @@ var Item = this.Item = Base.extend({
* *
* @property * @property
* @name Item#strokeCap * @name Item#strokeCap
* @type string * @type String
*/ */
// DOCS: Item#strokeJoin: describe the different options // DOCS: Item#strokeJoin: describe the different options
@ -828,7 +828,7 @@ var Item = this.Item = Base.extend({
* *
* @property * @property
* @name Item#strokeJoin * @name Item#strokeJoin
* @type string * @type String
*/ */
/** /**
@ -836,7 +836,7 @@ var Item = this.Item = Base.extend({
* *
* @property * @property
* @name Item#dashOffset * @name Item#dashOffset
* @type number * @type Number
*/ */
/** /**
@ -861,7 +861,7 @@ var Item = this.Item = Base.extend({
* *
* @property * @property
* @name Item#miterLimit * @name Item#miterLimit
* @type number * @type Number
*/ */
/** /**

10
src/item/PathStyle.js
View file

@ -180,7 +180,7 @@ var PathStyle = this.PathStyle = Base.extend(new function() {
* *
* @property * @property
* @name PathStyle#strokeWidth * @name PathStyle#strokeWidth
* @type number * @type Number
*/ */
// DOCS: PathStyle#strokeCap: describe the different options // DOCS: PathStyle#strokeCap: describe the different options
@ -196,7 +196,7 @@ var PathStyle = this.PathStyle = Base.extend(new function() {
* *
* @property * @property
* @name PathStyle#strokeCap * @name PathStyle#strokeCap
* @type string * @type String
*/ */
// DOCS: PathStyle#strokeJoin: describe the different options // DOCS: PathStyle#strokeJoin: describe the different options
@ -205,7 +205,7 @@ var PathStyle = this.PathStyle = Base.extend(new function() {
* *
* @property * @property
* @name PathStyle#strokeJoin * @name PathStyle#strokeJoin
* @type string * @type String
*/ */
/** /**
@ -213,7 +213,7 @@ var PathStyle = this.PathStyle = Base.extend(new function() {
* *
* @property * @property
* @name PathStyle#dashOffset * @name PathStyle#dashOffset
* @type number * @type Number
*/ */
/** /**
@ -238,7 +238,7 @@ var PathStyle = this.PathStyle = Base.extend(new function() {
* *
* @property * @property
* @name PathStyle#miterLimit * @name PathStyle#miterLimit
* @type number * @type Number
*/ */
/** /**

4
src/item/Raster.js
View file

@ -83,7 +83,7 @@ var Raster = this.Raster = Item.extend({
/** /**
* The width of the raster in pixels. * The width of the raster in pixels.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getWidth: function() { getWidth: function() {
@ -93,7 +93,7 @@ var Raster = this.Raster = Item.extend({
/** /**
* The height of the raster in pixels. * The height of the raster in pixels.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getHeight: function() { getHeight: function() {

4
src/path/Curve.js
View file

@ -146,7 +146,7 @@ var Curve = this.Curve = Base.extend({
/** /**
* The index of the curve in the {@link Path#curves} array. * The index of the curve in the {@link Path#curves} array.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getIndex: function() { getIndex: function() {
@ -211,7 +211,7 @@ var Curve = this.Curve = Base.extend({
/** /**
* The approximated length of the curve in points. * The approximated length of the curve in points.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getLength: function(/* from, to */) { getLength: function(/* from, to */) {

6
src/path/CurveLocation.js
View file

@ -107,7 +107,7 @@ CurveLocation = Base.extend({
* The length of the path from its beginning up to the location described * The length of the path from its beginning up to the location described
* by this object. * by this object.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getOffset: function() { getOffset: function() {
@ -119,7 +119,7 @@ CurveLocation = Base.extend({
* The length of the curve from its beginning up to the location described * The length of the curve from its beginning up to the location described
* by this object. * by this object.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getCurveOffset: function() { getCurveOffset: function() {
@ -132,7 +132,7 @@ CurveLocation = Base.extend({
* value between {@code 0} (beginning of the curve) and {@code 1} (end of * value between {@code 0} (beginning of the curve) and {@code 1} (end of
* the curve). * the curve).
* *
* @type number * @type Number
* @bean * @bean
*/ */
getParameter: function() { getParameter: function() {

2
src/path/Path.js
View file

@ -542,7 +542,7 @@ var Path = this.Path = PathItem.extend({
/** /**
* The length of the perimeter of the path. * The length of the perimeter of the path.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getLength: function() { getLength: function() {

2
src/path/Segment.js
View file

@ -176,7 +176,7 @@ var Segment = this.Segment = Base.extend({
* The index of the segment in the {@link Path#segments} array that the * The index of the segment in the {@link Path#segments} array that the
* segment belongs to. * segment belongs to.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getIndex: function() { getIndex: function() {

2
src/project/Project.js
View file

@ -88,7 +88,7 @@ var Project = this.Project = Base.extend({
/** /**
* The index of the project in the global projects array. * The index of the project in the global projects array.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getIndex: function() { getIndex: function() {

4
src/text/CharacterStyle.js
View file

@ -53,7 +53,7 @@ var CharacterStyle = this.CharacterStyle = PathStyle.extend({
* *
* @name CharacterStyle#font * @name CharacterStyle#font
* @default 'sans-serif' * @default 'sans-serif'
* @type string * @type String
*/ */
/** /**
@ -61,7 +61,7 @@ var CharacterStyle = this.CharacterStyle = PathStyle.extend({
* *
* @name CharacterStyle#fontSize * @name CharacterStyle#fontSize
* @default 10 * @default 10
* @type number * @type Number
*/ */
statics: { statics: {

2
src/text/TextItem.js
View file

@ -43,7 +43,7 @@ var TextItem = this.TextItem = Item.extend({
* The text contents of the text item. * The text contents of the text item.
* *
* @name TextItem#content * @name TextItem#content
* @type string * @type String
*/ */
_clone: function(copy) { _clone: function(copy) {

8
src/tool/Tool.js
View file

@ -70,7 +70,7 @@ var Tool = this.Tool = Base.extend({
* {@link #onMouseDrag} event is called repeatedly after the initial * {@link #onMouseDrag} event is called repeatedly after the initial
* {@link #onMouseDown} until the user releases the mouse. * {@link #onMouseDown} until the user releases the mouse.
* *
* @type number * @type Number
*/ */
eventInterval: null, eventInterval: null,
@ -78,7 +78,7 @@ var Tool = this.Tool = Base.extend({
* The minimum distance the mouse has to drag before firing the onMouseDrag * The minimum distance the mouse has to drag before firing the onMouseDrag
* event, since the last onMouseDrag event. * event, since the last onMouseDrag event.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getMinDistance: function() { getMinDistance: function() {
@ -97,7 +97,7 @@ var Tool = this.Tool = Base.extend({
* The maximum distance the mouse has to drag before firing the onMouseDrag * The maximum distance the mouse has to drag before firing the onMouseDrag
* event, since the last onMouseDrag event. * event, since the last onMouseDrag event.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getMaxDistance: function() { getMaxDistance: function() {
@ -114,7 +114,7 @@ var Tool = this.Tool = Base.extend({
// DOCS: document Tool#fixedDistance // DOCS: document Tool#fixedDistance
/** /**
* @type number * @type Number
* @bean * @bean
*/ */
getFixedDistance: function() { getFixedDistance: function() {

2
src/tool/ToolEvent.js
View file

@ -147,7 +147,7 @@ var ToolEvent = this.ToolEvent = Base.extend({
/** /**
* The number of times the mouse event was fired. * The number of times the mouse event was fired.
* *
* @type number * @type Number
* @bean * @bean
*/ */
getCount: function() { getCount: function() {

4
src/ui/KeyEvent.js
View file

@ -47,14 +47,14 @@ var KeyEvent = this.KeyEvent = Event.extend(new function() {
* The string character of the key that caused this key event. * The string character of the key that caused this key event.
* *
* @name KeyEvent#character * @name KeyEvent#character
* @type string * @type String
*/ */
/** /**
* The key that caused this key event. * The key that caused this key event.
* *
* @name KeyEvent#key * @name KeyEvent#key
* @type string * @type String
*/ */
/** /**

2
src/ui/View.js
View file

@ -172,7 +172,7 @@ var View = this.View = Base.extend({
}, },
/** /**
* @type number * @type Number
* @bean * @bean
*/ */
getZoom: function() { getZoom: function() {