mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-05 20:32:00 -05:00
Docs: Various smaller clean ups.
This commit is contained in:
parent
3af179e2cf
commit
c945bf7908
7 changed files with 26 additions and 20 deletions
|
@ -72,8 +72,8 @@ var Group = Item.extend(/** @lends Group# */{
|
|||
* Creates a new Group item and places it at the top of the active layer.
|
||||
*
|
||||
* @name Group#initialize
|
||||
* @param {Object} object An object literal containing properties to be
|
||||
* set on the Group.
|
||||
* @param {Object} object an object literal containing the properties to be
|
||||
* set on the group.
|
||||
*
|
||||
* @example {@paperscript}
|
||||
* var path = new Path([100, 100], [100, 200]);
|
||||
|
|
|
@ -80,7 +80,7 @@ var HitResult = Base.extend(/** @lends HitResult# */{
|
|||
|
||||
/**
|
||||
* If the HitResult has a type of 'stroke', 'segment', 'handle-in' or
|
||||
* 'handle-out', this property refers to the Segment that was hit or that
|
||||
* 'handle-out', this property refers to the segment that was hit or that
|
||||
* is closest to the hitResult.location on the curve.
|
||||
*
|
||||
* @name HitResult#segment
|
||||
|
|
|
@ -2822,9 +2822,10 @@ var Item = Base.extend(Callback, /** @lends Item# */{
|
|||
/**
|
||||
* {@grouptitle Event Handling}
|
||||
*
|
||||
* Attach an event handler to the item.
|
||||
* Attaches an event handler to the item.
|
||||
*
|
||||
* @name Item#on
|
||||
* @name Item#attach
|
||||
* @alias Item#on
|
||||
* @function
|
||||
* @param {String('mousedown', 'mouseup', 'mousedrag', 'click',
|
||||
* 'doubleclick', 'mousemove', 'mouseenter', 'mouseleave')} type the event
|
||||
|
@ -2854,11 +2855,12 @@ var Item = Base.extend(Callback, /** @lends Item# */{
|
|||
* });
|
||||
*/
|
||||
/**
|
||||
* Attach one or more event handlers to the item.
|
||||
* Attaches one or more event handlers to the item.
|
||||
*
|
||||
* @name Item#on^2
|
||||
* @name Item#attach
|
||||
* @alias Item#on
|
||||
* @function
|
||||
* @param {Object} param An object literal containing one or more of the
|
||||
* @param {Object} object an object literal containing one or more of the
|
||||
* following properties: {@code mousedown, mouseup, mousedrag, click,
|
||||
* doubleclick, mousemove, mouseenter, mouseleave}.
|
||||
*
|
||||
|
@ -2914,6 +2916,7 @@ var Item = Base.extend(Callback, /** @lends Item# */{
|
|||
* Detach an event handler from the item.
|
||||
*
|
||||
* @name Item#detach
|
||||
* @alias Item#off
|
||||
* @function
|
||||
* @param {String('mousedown', 'mouseup', 'mousedrag', 'click',
|
||||
* 'doubleclick', 'mousemove', 'mouseenter', 'mouseleave')} type the event
|
||||
|
@ -2923,9 +2926,10 @@ var Item = Base.extend(Callback, /** @lends Item# */{
|
|||
/**
|
||||
* Detach one or more event handlers to the item.
|
||||
*
|
||||
* @name Item#detach^2
|
||||
* @name Item#detach
|
||||
* @alias Item#off
|
||||
* @function
|
||||
* @param {Object} param An object literal containing one or more of the
|
||||
* @param {Object} object an object literal containing one or more of the
|
||||
* following properties: {@code mousedown, mouseup, mousedrag, click,
|
||||
* doubleclick, mousemove, mouseenter, mouseleave}
|
||||
*/
|
||||
|
@ -2934,11 +2938,12 @@ var Item = Base.extend(Callback, /** @lends Item# */{
|
|||
* Fire an event on the item.
|
||||
*
|
||||
* @name Item#fire
|
||||
* @alias Item#trigger
|
||||
* @function
|
||||
* @param {String('mousedown', 'mouseup', 'mousedrag', 'click',
|
||||
* 'doubleclick', 'mousemove', 'mouseenter', 'mouseleave')} type the event
|
||||
* type
|
||||
* @param {Object} event An object literal containing properties describing
|
||||
* @param {Object} event an object literal containing properties describing
|
||||
* the event.
|
||||
*/
|
||||
|
||||
|
|
|
@ -43,8 +43,9 @@ var Layer = Group.extend(/** @lends Layer# */{
|
|||
* {@link Project#layers} array. The newly created layer will be activated,
|
||||
* so all newly created items will be placed within it.
|
||||
*
|
||||
* @param {Object} object An object literal containing properties to
|
||||
* be set on the layer.
|
||||
* @name Layer#initialize
|
||||
* @param {Object} object an object literal containing the properties to be
|
||||
* set on the layer.
|
||||
*
|
||||
* @example {@paperscript}
|
||||
* var path = new Path([100, 100], [100, 200]);
|
||||
|
|
|
@ -54,7 +54,7 @@ var Segment = Base.extend(/** @lends Segment# */{
|
|||
* Creates a new Segment object.
|
||||
*
|
||||
* @name Segment#initialize
|
||||
* @param {Object} object An object literal containing properties to
|
||||
* @param {Object} object an object literal containing properties to
|
||||
* be set on the segment.
|
||||
*
|
||||
* @example {@paperscript}
|
||||
|
|
|
@ -421,7 +421,7 @@ var Tool = PaperScopeItem.extend(/** @lends Tool# */{
|
|||
*
|
||||
* @name Tool#on^2
|
||||
* @function
|
||||
* @param {Object} param An object literal containing one or more of the
|
||||
* @param {Object} param an object literal containing one or more of the
|
||||
* following properties: {@code mousedown, mouseup, mousedrag, mousemove,
|
||||
* keydown, keyup}.
|
||||
*/
|
||||
|
@ -440,7 +440,7 @@ var Tool = PaperScopeItem.extend(/** @lends Tool# */{
|
|||
*
|
||||
* @name Tool#detach^2
|
||||
* @function
|
||||
* @param {Object} param An object literal containing one or more of the
|
||||
* @param {Object} param an object literal containing one or more of the
|
||||
* following properties: {@code mousedown, mouseup, mousedrag, mousemove,
|
||||
* keydown, keyup}
|
||||
*/
|
||||
|
@ -452,7 +452,7 @@ var Tool = PaperScopeItem.extend(/** @lends Tool# */{
|
|||
* @function
|
||||
* @param {String('mousedown', 'mouseup', 'mousedrag', 'mousemove',
|
||||
* 'keydown', 'keyup')} type the event type
|
||||
* @param {Object} event An object literal containing properties describing
|
||||
* @param {Object} event an object literal containing properties describing
|
||||
* the event.
|
||||
*/
|
||||
|
||||
|
|
|
@ -484,7 +484,7 @@ var View = Base.extend(Callback, /** @lends View# */{
|
|||
*
|
||||
* @name View#on^2
|
||||
* @function
|
||||
* @param {Object} param An object literal containing one or more of the
|
||||
* @param {Object} param an object literal containing one or more of the
|
||||
* following properties: {@code frame, resize}.
|
||||
* // Create a rectangle shaped path with its top left point at:
|
||||
* // {x: 50, y: 25} and a size of {width: 50, height: 50}
|
||||
|
@ -535,7 +535,7 @@ var View = Base.extend(Callback, /** @lends View# */{
|
|||
*
|
||||
* @name View#detach^2
|
||||
* @function
|
||||
* @param {Object} param An object literal containing one or more of the
|
||||
* @param {Object} param an object literal containing one or more of the
|
||||
* following properties: {@code frame, resize}
|
||||
*/
|
||||
|
||||
|
@ -545,7 +545,7 @@ var View = Base.extend(Callback, /** @lends View# */{
|
|||
* @name View#fire
|
||||
* @function
|
||||
* @param {String('frame', 'resize')} type the event type
|
||||
* @param {Object} event An object literal containing properties describing
|
||||
* @param {Object} event an object literal containing properties describing
|
||||
* the event.
|
||||
*/
|
||||
|
||||
|
|
Loading…
Reference in a new issue