Clean up documentation for event handler functions on View and Tool.

This commit is contained in:
Jürg Lehni 2013-10-30 15:38:08 +01:00
parent 0ded3ae0ba
commit dc732da8d8
3 changed files with 18 additions and 8 deletions

View file

@ -742,7 +742,7 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
* {@code hor} amount and in vertical direction by the specified {@code ver} * {@code hor} amount and in vertical direction by the specified {@code ver}
* amount. * amount.
* *
* @name Rectangle#expand^2 * @name Rectangle#expand
* @function * @function
* @param {Number} hor * @param {Number} hor
* @param {Number} ver * @param {Number} ver
@ -766,7 +766,7 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
* {@code hor} amount and in vertical direction by the specified {@code ver} * {@code hor} amount and in vertical direction by the specified {@code ver}
* amount from its center. * amount from its center.
* *
* @name Rectangle#scale^2 * @name Rectangle#scale
* @function * @function
* @param {Number} hor * @param {Number} hor
* @param {Number} ver * @param {Number} ver

View file

@ -409,7 +409,8 @@ var Tool = PaperScopeItem.extend(/** @lends Tool# */{
* *
* Attach an event handler to the tool. * Attach an event handler to the tool.
* *
* @name Tool#on * @name Tool#attach
* @alias Tool#on
* @function * @function
* @param {String('mousedown', 'mouseup', 'mousedrag', 'mousemove', * @param {String('mousedown', 'mouseup', 'mousedrag', 'mousemove',
* 'keydown', 'keyup')} type the event type * 'keydown', 'keyup')} type the event type
@ -419,7 +420,8 @@ var Tool = PaperScopeItem.extend(/** @lends Tool# */{
/** /**
* Attach one or more event handlers to the tool. * Attach one or more event handlers to the tool.
* *
* @name Tool#on^2 * @name Tool#attach
* @alias Tool#on
* @function * @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, * following properties: {@code mousedown, mouseup, mousedrag, mousemove,
@ -430,6 +432,7 @@ var Tool = PaperScopeItem.extend(/** @lends Tool# */{
* Detach an event handler from the tool. * Detach an event handler from the tool.
* *
* @name Tool#detach * @name Tool#detach
* @alias Tool#off
* @function * @function
* @param {String('mousedown', 'mouseup', 'mousedrag', 'mousemove', * @param {String('mousedown', 'mouseup', 'mousedrag', 'mousemove',
* 'keydown', 'keyup')} type the event type * 'keydown', 'keyup')} type the event type
@ -438,7 +441,8 @@ var Tool = PaperScopeItem.extend(/** @lends Tool# */{
/** /**
* Detach one or more event handlers from the tool. * Detach one or more event handlers from the tool.
* *
* @name Tool#detach^2 * @name Tool#detach
* @alias Tool#off
* @function * @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, * following properties: {@code mousedown, mouseup, mousedrag, mousemove,
@ -449,6 +453,7 @@ var Tool = PaperScopeItem.extend(/** @lends Tool# */{
* Fire an event on the tool. * Fire an event on the tool.
* *
* @name Tool#fire * @name Tool#fire
* @alias Tool#trigger
* @function * @function
* @param {String('mousedown', 'mouseup', 'mousedrag', 'mousemove', * @param {String('mousedown', 'mouseup', 'mousedrag', 'mousemove',
* 'keydown', 'keyup')} type the event type * 'keydown', 'keyup')} type the event type

View file

@ -460,7 +460,8 @@ var View = Base.extend(Callback, /** @lends View# */{
* *
* Attach an event handler to the view. * Attach an event handler to the view.
* *
* @name View#on * @name View#attach
* @alias View#on
* @function * @function
* @param {String('frame', 'resize')} type the event type * @param {String('frame', 'resize')} type the event type
* @param {Function} function The function to be called when the event * @param {Function} function The function to be called when the event
@ -482,7 +483,8 @@ var View = Base.extend(Callback, /** @lends View# */{
/** /**
* Attach one or more event handlers to the view. * Attach one or more event handlers to the view.
* *
* @name View#on^2 * @name View#attach
* @alias View#on
* @function * @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}. * following properties: {@code frame, resize}.
@ -505,6 +507,7 @@ var View = Base.extend(Callback, /** @lends View# */{
* Detach an event handler from the view. * Detach an event handler from the view.
* *
* @name View#detach * @name View#detach
* @alias View#off
* @function * @function
* @param {String('frame', 'resize')} type the event type * @param {String('frame', 'resize')} type the event type
* @param {Function} function The function to be detached * @param {Function} function The function to be detached
@ -533,7 +536,8 @@ var View = Base.extend(Callback, /** @lends View# */{
/** /**
* Detach one or more event handlers from the view. * Detach one or more event handlers from the view.
* *
* @name View#detach^2 * @name View#detach
* @alias View#off
* @function * @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} * following properties: {@code frame, resize}
@ -543,6 +547,7 @@ var View = Base.extend(Callback, /** @lends View# */{
* Fire an event on the view. * Fire an event on the view.
* *
* @name View#fire * @name View#fire
* @alias View#trigger
* @function * @function
* @param {String('frame', 'resize')} type the event type * @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